Add banner & update readme (#4342)

Co-authored-by: Nuru <[email protected]>

.github/workflows/auto-update-packages.yml

@@ -61,7 +61,6 @@ jobs:
         - gonsul
         - goofys
         - gosu
-        - gotop
         - grpcurl
         - hcledit
         - helm

Makefile

@@ -50,9 +50,9 @@ run:
 ## Update `docs/badges.md` from `make help`
 docs/badges.md: docs/deps
 	@( \
-		echo "## Package Build Status"; \
-		echo "| Build Status | Version | Description |"; \
-		echo "| ------------ | ------- | ----------- |"; \
+		echo '## Package Build Status'; \
+		echo '| Build Status (* means `amd64` only) | Version | Description |'; \
+		echo '| ----------------------------------- | ------- | ----------- |'; \
 		$(SELF) --no-print-directory --quiet --silent help/md | sed $$'s,\x1b\\[[0-9;]*[a-zA-Z],,g'; \
 	) > $@
 
@@ -128,6 +128,7 @@ docker/build/%/shell run/%:
 
 
 help/vendor:
+	printf '\n\nPackages marked with * are not available on some architectures (usually missing `arm64`)\n\n'
 	@$(MAKE) --no-print-directory -s -C vendor help
 
 help/md:

README.yaml

@@ -30,11 +30,8 @@ github_repo: cloudposse/packages
 # Badges to display
 badges:
   - name: "Auto Update Status"
-    image: "https://github.com/cloudposse/packages/workflows/auto-update/badge.svg"
-    url: "https://github.com/cloudposse/packages/actions?query=workflow%3Aauto-update"
-  - name: "Latest Release"
-    image: "https://img.shields.io/github/release/cloudposse/packages.svg"
-    url: "https://github.com/cloudposse/packages/releases/latest"
+    image: "https://github.com/cloudposse/packages/actions/workflows/auto-update-packages.yml/badge.svg"
+    url: "https://github.com/cloudposse/packages/actions/workflows/auto-update-packages.yml"
   - name: "Slack Community"
     image: "https://slack.cloudposse.com/badge.svg"
     url: "https://slack.cloudposse.com"
@@ -321,6 +318,8 @@ examples: |-
 contributors:
   - name: "Erik Osterman"
     github: "osterman"
+  - name: "Nuru"
+    github: "Nuru"
   - name: "Igor Rodionov"
     github: "goruha"
   - name: "Andriy Knysh"

docs/targets.md

@@ -1,6 +1,10 @@
 <!-- markdownlint-disable -->
 ## Makefile Targets
 ```text
+
+
+Packages marked with * are not available on some architectures (usually missing `arm64`)
+
 amazon-ecr-credential-helper 0.7.1      Automatically gets credentials for Amazon ECR on docker push/docker pull
 amtool                    0.26.0     Tool for interacting with the Alertmanager API
 argocd                    2.9.5      Declarative GitOpts for Kubernetes

tasks/Makefile.package

@@ -274,7 +274,7 @@ info:
 # info/short is used to make docs/targets.md
 info/short:
 	@if [[ $${PACKAGE_ENABLED:-true} != "false" ]]; then \
-		if [[ "$(PACKAGE_ARCHS_DISABLED)" != "" ]]; then \
+		if [[ "$(PACKAGE_ARCHS_DISABLED)" != "" ]] && ! [[ "$(PACKAGE_ARCHS_DISABLED)" =~ "no-linux" ]]; then \
     		package_arch_incomplete='*'; \
     	fi; \
 		printf "%-25s %-10s %s\n" "$${PACKAGE_NAME}$${package_arch_incomplete}" "$${PACKAGE_VERSION}" "$${PACKAGE_DESCRIPTION}"; \
@@ -283,9 +283,23 @@ info/short:
 	fi
 
 # info/md is used to make docs/badges.md
+# We truncate long versions to 9 characters to avoid making the version column too wide.
+# We use GitHub-flavored Markdown special format [text](## "hover text") to make the truncated version accessible via hover.
 info/md:
 	@if [[ $${PACKAGE_ENABLED:-true} != "false" ]]; then \
-		printf "[![%s](https://github.com/cloudposse/packages/workflows/%s/badge.svg?branch=master)](https://github.com/cloudposse/packages/actions?query=workflow%%3A%s) | %-10s | %s\n" "$${PACKAGE_NAME}" "$${PACKAGE_NAME}" "$${PACKAGE_NAME}" "$${PACKAGE_VERSION}" "$${PACKAGE_DESCRIPTION}"; \
+		if [[ "$(PACKAGE_ARCHS_DISABLED)" != "" ]] && ! [[ "$(PACKAGE_ARCHS_DISABLED)" =~ "no-linux" ]]; then \
+    		package_arch_incomplete='*'; \
+    	fi; \
+    	if (( $${#PACKAGE_VERSION} > 9 )); then \
+			truncated_version='[%-9.9s…](## "$(subst %,,$(subst ',,$(subst ",,$(PACKAGE_VERSION))))")'; \
+		else \
+			truncated_version='%-10s'; \
+		fi; \
+		if [[ "$${AUTO_UPDATE_ENABLED:-true}" == "true" ]] || [[ "$${AUTO_UPDATE_ENABLED:-true}" == "softfail" ]]; then \
+			printf "[![%s](https://github.com/cloudposse/packages/actions/workflows/%s.yml/badge.svg?branch=master)](https://github.com/cloudposse/packages/actions?query=workflow%%3A%s)$${package_arch_incomplete} | $${truncated_version} | %s\n" "$${PACKAGE_NAME}" "$${PACKAGE_NAME}" "$${PACKAGE_NAME}" "$${PACKAGE_VERSION}" "$${PACKAGE_DESCRIPTION}"; \
+		else \
+			printf "%s$${package_arch_incomplete} \[frozen\] | $${truncated_version} | %s\n" "$${PACKAGE_NAME}" "$${PACKAGE_VERSION}" "$${PACKAGE_DESCRIPTION}"; \
+		fi; \
 	fi
 
 # info/github is used to configure GitHub Actions, particularly build and auto-update

vendor/gonsul/Makefile

@@ -18,7 +18,8 @@ include ../../tasks/Makefile.vendor_includes
 ifeq ($(OS),darwin)
  export OS = osx
  export DL_ARCH = -$(ARCH)
- export PACKAGE_ARCHS_DISABLED :=
+ # Set PACKAGE_ARCHS_DISABLED to "other" to indicate that this package is not available for some architectures on other OSes
+ export PACKAGE_ARCHS_DISABLED := "other"
 else
  export DL_ARCH =
 endif

vendor/gotop/Makefile

@@ -4,11 +4,15 @@ export VENDOR ?= cjbassi
 export DOWNLOAD_URL ?= $(PACKAGE_REPO_URL)/releases/download/$(PACKAGE_VERSION)/$(PACKAGE_NAME)_$(PACKAGE_VERSION)_$(OS)_$(DL_ARCH).tgz
 export APKBUILD_DEPENDS += libc6-compat
 
+# project is archived
+export AUTO_UPDATE_ENABLED = false
+
+
 include ../../tasks/Makefile.vendor_includes
 
 ifeq ($(OS),darwin)
-  # arm64 not supported
-  export PACKAGE_ARCHS_DISABLED = arm64
+  # arm64 not supported on macOS, but add "no-linux" to say no linux architectures are disabled
+  export PACKAGE_ARCHS_DISABLED = arm64 no-linux
 endif
 ifeq ($(ARCH),arm64)
   export DL_ARCH = arm8

vendor/rancher/Makefile

@@ -13,8 +13,8 @@ export APK_BUILD_TEMPLATE ?= APKBUILD.github-binary
 include ../../tasks/Makefile.vendor_includes
 
 ifeq ($(OS),darwin)
-  # arm64 not supported
-  export PACKAGE_ARCHS_DISABLED = arm64
+  # arm64 not supported on macOS, but add "no-linux" to say no linux architectures are disabled
+  export PACKAGE_ARCHS_DISABLED = arm64 no-linux
 endif
 ifeq ($(ARCH),arm64)
   export DL_ARCH = arm

vendor/terraform-0.14/Makefile

@@ -7,6 +7,10 @@ export MAJOR_VERSION = 0.14
 export PACKAGE_PRERELEASE_ENABLED = false
 export PACKAGE_NAME = $(MASTER_PACKAGE_NAME)-$(MAJOR_VERSION)
 
+# This version is technically past end-of-life, so we allow updates to fail,
+# but we keep checking anyway in case there is a security patch.
+export AUTO_UPDATE_ENABLED = softfail
+
 include ../../tasks/Makefile.vendor_includes
 
 # NOTE: This build uses a custom build template ./APKBUILD

vendor/terraform-0.15/Makefile

@@ -7,6 +7,10 @@ export MAJOR_VERSION = 0.15
 export PACKAGE_PRERELEASE_ENABLED = true
 export PACKAGE_NAME = $(MASTER_PACKAGE_NAME)-$(MAJOR_VERSION)
 
+# This version is technically past end-of-life, so we allow updates to fail,
+# but we keep checking anyway in case there is a security patch.
+export AUTO_UPDATE_ENABLED = softfail
+
 include ../../tasks/Makefile.vendor_includes
 
 # NOTE: This build uses a custom build template ./APKBUILD

vendor/yajsv/Makefile

@@ -8,13 +8,16 @@ export DOWNLOAD_URL = $(PACKAGE_REPO_URL)/releases/download/v$(PACKAGE_VERSION)/
 export APK_BUILD_TEMPLATE = APKBUILD.github-binary
 export APKBUILD_DEPENDS += libc6-compat
 
-include ../../tasks/Makefile.vendor_includes
-
 # https://github.com/neilpa/yajsv/issues/24
-ifneq ($(OS),darwin)
+ifeq ($(OS),darwin)
+  # Set PACKAGE_ARCHS_DISABLED to "other" to indicate that this package is not available for some architectures on other OSes
+  export PACKAGE_ARCHS_DISABLED := "other"
+else
   export PACKAGE_ARCHS_DISABLED = arm64
 endif
 
+include ../../tasks/Makefile.vendor_includes
+
 install:
 	$(call download_binary)