1 Commits
Author SHA1 Message Date
CSRBot 1a4c95db23 chore(deps): update dependency mikefarah/yq to v4.53.3
Install yq / install-yq (ubuntu-latest-amd64, amd64, linux) (push) Failing after 7s
Install yq / install-yq (ubuntu-latest-arm64, arm64, linux) (push) Failing after 10s
Markdown linter / markdown-link-checker (push) Successful in 25s
Install yq / install-yq (ubuntu-latest-amd64, amd64, linux) (pull_request) Failing after 8s
Markdown linter / markdown-lint (push) Successful in 35s
Markdown linter / markdown-lint (pull_request) Successful in 28s
Install yq / install-yq (ubuntu-latest-arm64, arm64, linux) (pull_request) Failing after 13s
Markdown linter / markdown-link-checker (pull_request) Successful in 22s
2026-08-16 20:17:49 +00:00
2 changed files with 6 additions and 19 deletions
+4 -17
View File
@@ -1,8 +1,6 @@
# ah-annotation # ah-annotation
GitHub Action to generate [ArtifactHub GitHub Action to generate ArtifactHub changelog annotations from Git commit history and add them to `Chart.yaml`.
annotations](https://artifacthub.io/docs/topics/annotations/helm/#supported-annotations) from Git commit history and add
them to `Chart.yaml`.
The action parses conventional commit messages between two Git tags and produces an `artifacthub.io/changes` annotation. The action parses conventional commit messages between two Git tags and produces an `artifacthub.io/changes` annotation.
Pre-release tags (matching `-rc`) are detected automatically and result in an `artifacthub.io/prerelease` annotation Pre-release tags (matching `-rc`) are detected automatically and result in an `artifacthub.io/prerelease` annotation
@@ -19,7 +17,7 @@ steps:
- uses: actions/checkout@v7.0.1 - uses: actions/checkout@v7.0.1
with: with:
fetch-depth: 0 fetch-depth: 0
- uses: volker.raschek/ah-annotations@v0.1.1 - uses: volker.raschek/ah-annotations@v0.0.1
``` ```
### Explicit tags ### Explicit tags
@@ -31,7 +29,7 @@ steps:
- uses: actions/checkout@v7.0.1 - uses: actions/checkout@v7.0.1
with: with:
fetch-depth: 0 fetch-depth: 0
- uses: volker.raschek/ah-annotations@v0.1.1 - uses: volker.raschek/ah-annotations@v0.0.1
with: with:
old-tag: v1.0.0 old-tag: v1.0.0
new-tag: v2.0.0 new-tag: v2.0.0
@@ -44,7 +42,7 @@ steps:
| `chart-path` | no | `${{ github.workspace }}/Chart.yaml` | Path to the Helm chart file. | | `chart-path` | no | `${{ github.workspace }}/Chart.yaml` | Path to the Helm chart file. |
| `old-tag` | no | auto-detected | Start tag for changelog generation. | | `old-tag` | no | auto-detected | Start tag for changelog generation. |
| `new-tag` | no | auto-detected | End tag for changelog generation. | | `new-tag` | no | auto-detected | End tag for changelog generation. |
| `yq-version` | no | `v4.44.6` | Version of yq to install. | | `yq-version` | no | `v4.53.3` | Version of yq to install. |
| `yq-arch` | no | auto-detected | Architecture of yq binary to download. | | `yq-arch` | no | auto-detected | Architecture of yq binary to download. |
| `yq-os` | no | auto-detected | Operating system of yq binary to download. | | `yq-os` | no | auto-detected | Operating system of yq binary to download. |
| `yq-binary-name` | no | `yq` | Name of the yq binary to download. | | `yq-binary-name` | no | `yq` | Name of the yq binary to download. |
@@ -56,17 +54,6 @@ steps:
- A `Chart.yaml` file must exist at the path specified by `chart-path`. - A `Chart.yaml` file must exist at the path specified by `chart-path`.
- Commit messages must follow the [Conventional Commits](https://www.conventionalcommits.org/) format. - Commit messages must follow the [Conventional Commits](https://www.conventionalcommits.org/) format.
## Pre-releases
Tags matching the pattern `-rc` (e.g. `v1.0.0-rc.1`, `v2.0.0-rc`) are treated as pre-releases.
When `new-tag` is a pre-release tag, the action:
1. Sets `artifacthub.io/prerelease: "true"` in `Chart.yaml`.
2. Skips changelog generation entirely.
When auto-detecting tags (no explicit `old-tag`/`new-tag`), the action ignores pre-release tags and selects the two
most recent stable tags instead.
## Commit type mapping ## Commit type mapping
| Commit type | ArtifactHub kind | | Commit type | ArtifactHub kind |
+2 -2
View File
@@ -2,7 +2,7 @@
set -euo pipefail set -euo pipefail
internal_yq_version=v4.44.6 # renovate: datasource=github-releases depName=mikefarah/yq versioning=semver internal_yq_version=v4.53.3 # renovate: datasource=github-releases depName=mikefarah/yq versioning=semver
# Use :- for unset and handle empty strings from composite action inputs # Use :- for unset and handle empty strings from composite action inputs
YQ_BINARY_NAME="${YQ_BINARY_NAME:="yq"}" YQ_BINARY_NAME="${YQ_BINARY_NAME:="yq"}"
@@ -78,5 +78,5 @@ echo "INFO: Installed ${yq_installed_version} in ${bin_path}"
# Ensure yq is in PATH for subsequent steps # Ensure yq is in PATH for subsequent steps
if [[ -n "${GITHUB_PATH:-}" ]]; then if [[ -n "${GITHUB_PATH:-}" ]]; then
dirname "${bin_path}" >> "${GITHUB_PATH}" "$(dirname "${bin_path}")" >> "${GITHUB_PATH}"
fi fi