Generate asdf-pkl-aws-secret-resource-reader plugin from template.

tomduckering · tomduckering · commit fc29d0aa0405 · 2025-05-28T18:50:37.000+01:00
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -1,12 +1,6 @@
 version: 2
 updates:
-  # dependabot for GitHub Actions for this repo
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:
-      interval: "weekly"
-  # dependabot for GitHub Actions for the template
-  - package-ecosystem: "github-actions"
-    directory: "template/.github/"
-    schedule:
-      interval: "weekly"
+      interval: "weekly"
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -7,41 +7,16 @@ on:
   pull_request:
 
 jobs:
-  test:
-    name: template setup test
+  plugin_test:
+    name: asdf plugin test
     strategy:
       matrix:
         os:
           - ubuntu-latest
           - macos-latest
     runs-on: ${{ matrix.os }}
     steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-      - name: Run Template Setup
-        run: |
-          git config user.name "Foo Bearer"
-          ./setup.bash \
-            "asdf-foo" \
-            "foo --help" \
-            "asdf-community" \
-            "ASDF Community" \
-            "https://github.com/asdf-vm/asdf" \
-            "https://asdf-vm.com" \
-            "Apache-2.0" \
-            "yes"
-
-      - name: Check setup result
-        run: |
-          set -xe
-          ls -la .
-          git log
-          test ! -d template/
-          grep "Apache" LICENSE
-          test "main" = "$(git rev-parse --abbrev-ref HEAD)"
-          ! git grep -F -e "<YOUR TOOL>" \
-                   --or -e "<TOOL HOMEPAGE>" \
-                   --or -e "<TOOL REPO>" \
-                   --or -e "<TOOL CHECK>" \
-                   --or -e "<YOUR NAME>" \
-                   --or -e"<YOUR GITHUB USERNAME>"
+      - name: asdf_plugin_test
+        uses: asdf-vm/actions/plugin-test@v2
+        with:
+          command: pkl-aws-secret-resource-reader --help
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -10,14 +10,14 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - uses: asdf-vm/actions/install@v3
+      - uses: actions/checkout@v3
+      - uses: asdf-vm/actions/install@v2
       - run: scripts/lint.bash
 
   actionlint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v3
       - name: Check workflow files
         uses: docker://rhysd/actionlint:1.6.23
         with:
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -0,0 +1,18 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: GoogleCloudPlatform/release-please-action@v3
+        with:
+          release-type: simple
diff --git a/.github/workflows/semantic-pr.yml b/.github/workflows/semantic-pr.yml
@@ -11,7 +11,7 @@ jobs:
   semantic-pr:
     runs-on: ubuntu-latest
     steps:
-      - uses: amannn/action-semantic-pull-request@v5.4.0
+      - uses: amannn/action-semantic-pull-request@v5.2.0
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
diff --git a/README.md b/README.md
@@ -1,36 +1,60 @@
-# asdf-plugin-template [![Build](https://github.com/asdf-vm/asdf-plugin-template/actions/workflows/build.yml/badge.svg)](https://github.com/asdf-vm/asdf-plugin-template/actions/workflows/build.yml) [![Lint](https://github.com/asdf-vm/asdf-plugin-template/actions/workflows/lint.yml/badge.svg)](https://github.com/asdf-vm/asdf-plugin-template/actions/workflows/lint.yml)
+<div align="center">
 
-This is an [asdf-vm plugin](https://asdf-vm.com/#/plugins-create) template with CI to run [Shellcheck](https://github.com/koalaman/shellcheck) and testing with the [asdf test GitHub Action](https://github.com/asdf-vm/actions).
+# asdf-pkl-aws-secret-resource-reader [![Build](https://github.com/infrablocks/asdf-pkl-aws-secret-resource-reader/actions/workflows/build.yml/badge.svg)](https://github.com/infrablocks/asdf-pkl-aws-secret-resource-reader/actions/workflows/build.yml) [![Lint](https://github.com/infrablocks/asdf-pkl-aws-secret-resource-reader/actions/workflows/lint.yml/badge.svg)](https://github.com/infrablocks/asdf-pkl-aws-secret-resource-reader/actions/workflows/lint.yml)
 
-## Usage
+[pkl-aws-secret-resource-reader](https://github.com/infrablocks/pkl-aws-secret-resource-reader) plugin for the [asdf version manager](https://asdf-vm.com).
 
-1. [Generate](https://github.com/asdf-vm/asdf-plugin-template/generate) a new repository based on this template.
-1. Clone it and run `bash setup.bash`.
-1. Force push to your repo: `git push --force-with-lease`.
-1. Adapt your code at the TODO markers. To find the markers: `git grep TODO`.
-1. To develop your plugin further, please read [the plugins create section of the docs](https://asdf-vm.com/plugins/create.html).
+</div>
 
->A feature of this plugin-template when hosted on GitHub is the use of [release-please](https://github.com/googleapis/release-please), an automated release tool. It leverages [Conventional Commit messages](https://www.conventionalcommits.org/) to determine semver release type, see the [documentation](https://github.com/googleapis/release-please).
+# Contents
 
-## Contributing
+- [Dependencies](#dependencies)
+- [Install](#install)
+- [Contributing](#contributing)
+- [License](#license)
 
-Contributions welcome!
+# Dependencies
 
-1. Install `asdf` tools
+**TODO: adapt this section**
 
-    ```shell
-    asdf plugin add shellcheck https://github.com/luizm/asdf-shellcheck.git
-    asdf plugin add shfmt https://github.com/luizm/asdf-shfmt.git
-    asdf install
-    ```
+- `bash`, `curl`, `tar`, and [POSIX utilities](https://pubs.opengroup.org/onlinepubs/9699919799/idx/utilities.html).
+- `SOME_ENV_VAR`: set this environment variable in your shell config to load the correct version of tool x.
 
-1. Develop!
+# Install
 
-1. Lint & Format
+Plugin:
 
-    ```shell
-    ./scripts/format.bash
-    ./scripts/lint.bash
-    ```
+```shell
+asdf plugin add pkl-aws-secret-resource-reader
+# or
+asdf plugin add pkl-aws-secret-resource-reader https://github.com/infrablocks/asdf-pkl-aws-secret-resource-reader.git
+```
 
-1. PR changes
+pkl-aws-secret-resource-reader:
+
+```shell
+# Show all installable versions
+asdf list-all pkl-aws-secret-resource-reader
+
+# Install specific version
+asdf install pkl-aws-secret-resource-reader latest
+
+# Set a version globally (on your ~/.tool-versions file)
+asdf global pkl-aws-secret-resource-reader latest
+
+# Now pkl-aws-secret-resource-reader commands are available
+pkl-aws-secret-resource-reader --help
+```
+
+Check [asdf](https://github.com/asdf-vm/asdf) readme for more instructions on how to
+install & manage versions.
+
+# Contributing
+
+Contributions of any kind welcome! See the [contributing guide](contributing.md).
+
+[Thanks goes to these contributors](https://github.com/infrablocks/asdf-pkl-aws-secret-resource-reader/graphs/contributors)!
+
+# License
+
+See [LICENSE](LICENSE) © [Tom Duckering](https://github.com/infrablocks/)
diff --git a/bin/download b/bin/download
@@ -0,0 +1,23 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+current_script_path=${BASH_SOURCE[0]}
+plugin_dir=$(dirname "$(dirname "$current_script_path")")
+
+# shellcheck source=./lib/utils.bash
+source "${plugin_dir}/lib/utils.bash"
+
+mkdir -p "$ASDF_DOWNLOAD_PATH"
+
+# TODO: Adapt this to proper extension and adapt extracting strategy.
+release_file="$ASDF_DOWNLOAD_PATH/$TOOL_NAME-$ASDF_INSTALL_VERSION.tar.gz"
+
+# Download tar.gz file to the download directory
+download_release "$ASDF_INSTALL_VERSION" "$release_file"
+
+#  Extract contents of tar.gz file into the download directory
+tar -xzf "$release_file" -C "$ASDF_DOWNLOAD_PATH" --strip-components=1 || fail "Could not extract $release_file"
+
+# Remove the tar.gz file since we don't need to keep it
+rm "$release_file"
diff --git a/bin/install b/bin/install
@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+current_script_path=${BASH_SOURCE[0]}
+plugin_dir=$(dirname "$(dirname "$current_script_path")")
+
+# shellcheck source=./lib/utils.bash
+source "${plugin_dir}/lib/utils.bash"
+
+install_version "$ASDF_INSTALL_TYPE" "$ASDF_INSTALL_VERSION" "$ASDF_INSTALL_PATH"
diff --git a/bin/latest-stable b/bin/latest-stable
@@ -0,0 +1,29 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+current_script_path=${BASH_SOURCE[0]}
+plugin_dir=$(dirname "$(dirname "$current_script_path")")
+
+# shellcheck source=./lib/utils.bash
+. "${plugin_dir}/lib/utils.bash"
+
+curl_opts=(-sI)
+
+if [ -n "${GITHUB_API_TOKEN:-}" ]; then
+	curl_opts=("${curl_opts[@]}" -H "Authorization: token $GITHUB_API_TOKEN")
+fi
+
+# curl of REPO/releases/latest is expected to be a 302 to another URL
+# when no releases redirect_url="REPO/releases"
+# when there are releases redirect_url="REPO/releases/tag/v<VERSION>"
+redirect_url=$(curl "${curl_opts[@]}" "$GH_REPO/releases/latest" | sed -n -e "s|^location: *||p" | sed -n -e "s|\r||p")
+version=
+printf "redirect url: %s\n" "$redirect_url" >&2
+if [[ "$redirect_url" == "$GH_REPO/releases" ]]; then
+	version="$(list_all_versions | sort_versions | tail -n1 | xargs echo)"
+else
+	version="$(printf "%s\n" "$redirect_url" | sed 's|.*/tag/v\{0,1\}||')"
+fi
+
+printf "%s\n" "$version"
diff --git a/bin/list-all b/bin/list-all
@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+current_script_path=${BASH_SOURCE[0]}
+plugin_dir=$(dirname "$(dirname "$current_script_path")")
+
+# shellcheck source=./lib/utils.bash
+source "${plugin_dir}/lib/utils.bash"
+
+list_all_versions | sort_versions | xargs echo
diff --git a/contributing.md b/contributing.md
@@ -0,0 +1,12 @@
+# Contributing
+
+Testing Locally:
+
+```shell
+asdf plugin test <plugin-name> <plugin-url> [--asdf-tool-version <version>] [--asdf-plugin-gitref <git-ref>] [test-command*]
+
+# TODO: adapt this
+asdf plugin test pkl-aws-secret-resource-reader https://github.com/infrablocks/asdf-pkl-aws-secret-resource-reader.git "pkl-aws-secret-resource-reader --help"
+```
+
+Tests are automatically run in GitHub Actions on push and PR.
diff --git a/lib/utils.bash b/lib/utils.bash
@@ -0,0 +1,74 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+# TODO: Ensure this is the correct GitHub homepage where releases can be downloaded for pkl-aws-secret-resource-reader.
+GH_REPO="https://github.com/infrablocks/pkl-aws-secret-resource-reader"
+TOOL_NAME="pkl-aws-secret-resource-reader"
+TOOL_TEST="pkl-aws-secret-resource-reader --help"
+
+fail() {
+	echo -e "asdf-$TOOL_NAME: $*"
+	exit 1
+}
+
+curl_opts=(-fsSL)
+
+# NOTE: You might want to remove this if pkl-aws-secret-resource-reader is not hosted on GitHub releases.
+if [ -n "${GITHUB_API_TOKEN:-}" ]; then
+	curl_opts=("${curl_opts[@]}" -H "Authorization: token $GITHUB_API_TOKEN")
+fi
+
+sort_versions() {
+	sed 'h; s/[+-]/./g; s/.p\([[:digit:]]\)/.z\1/; s/$/.z/; G; s/\n/ /' |
+		LC_ALL=C sort -t. -k 1,1 -k 2,2n -k 3,3n -k 4,4n -k 5,5n | awk '{print $2}'
+}
+
+list_github_tags() {
+	git ls-remote --tags --refs "$GH_REPO" |
+		grep -o 'refs/tags/.*' | cut -d/ -f3- |
+		sed 's/^v//' # NOTE: You might want to adapt this sed to remove non-version strings from tags
+}
+
+list_all_versions() {
+	# TODO: Adapt this. By default we simply list the tag names from GitHub releases.
+	# Change this function if pkl-aws-secret-resource-reader has other means of determining installable versions.
+	list_github_tags
+}
+
+download_release() {
+	local version filename url
+	version="$1"
+	filename="$2"
+
+	# TODO: Adapt the release URL convention for pkl-aws-secret-resource-reader
+	url="$GH_REPO/archive/v${version}.tar.gz"
+
+	echo "* Downloading $TOOL_NAME release $version..."
+	curl "${curl_opts[@]}" -o "$filename" -C - "$url" || fail "Could not download $url"
+}
+
+install_version() {
+	local install_type="$1"
+	local version="$2"
+	local install_path="${3%/bin}/bin"
+
+	if [ "$install_type" != "version" ]; then
+		fail "asdf-$TOOL_NAME supports release installs only"
+	fi
+
+	(
+		mkdir -p "$install_path"
+		cp -r "$ASDF_DOWNLOAD_PATH"/* "$install_path"
+
+		# TODO: Assert pkl-aws-secret-resource-reader executable exists.
+		local tool_cmd
+		tool_cmd="$(echo "$TOOL_TEST" | cut -d' ' -f1)"
+		test -x "$install_path/$tool_cmd" || fail "Expected $install_path/$tool_cmd to be executable."
+
+		echo "$TOOL_NAME $version installation was successful!"
+	) || (
+		rm -rf "$install_path"
+		fail "An error occurred while installing $TOOL_NAME $version."
+	)
+}
diff --git a/scripts/format.bash b/scripts/format.bash
@@ -1,10 +1,4 @@
 #!/usr/bin/env bash
 
-# format this repo
 shfmt --language-dialect bash --write \
-	setup.bash \
-	scripts/*.bash
-
-# format the template/
-shfmt --language-dialect bash --write \
-	template/**/*
+	./**/*
diff --git a/scripts/lint.bash b/scripts/lint.bash
@@ -1,19 +1,9 @@
 #!/usr/bin/env bash
 
-# lint this repo
 shellcheck --shell=bash --external-sources \
-	setup.bash \
+	bin/* --source-path=template/lib/ \
+	lib/* \
 	scripts/*
 
 shfmt --language-dialect bash --diff \
-	setup.bash \
-	scripts/*
-
-# lint the template/
-shellcheck --shell=bash --external-sources \
-	template/bin/* --source-path=template/lib/ \
-	template/lib/* \
-	template/scripts/*
-
-shfmt --language-dialect bash --diff \
-	template/**/*
+	./**/*
diff --git a/version.txt b/version.txt
