ace07ef9a4e238376929e882329b52550475e3b4
Install yq / install-yq (ubuntu-latest-amd64, amd64, linux) (push) Successful in 8s
Markdown linter / markdown-lint (push) Successful in 36s
Markdown linter / markdown-lint (pull_request) Successful in 29s
Install yq / install-yq (ubuntu-latest-arm64, arm64, linux) (push) Successful in 10s
Markdown linter / markdown-link-checker (push) Successful in 23s
Install yq / install-yq (ubuntu-latest-amd64, amd64, linux) (pull_request) Successful in 7s
Install yq / install-yq (ubuntu-latest-arm64, arm64, linux) (pull_request) Successful in 11s
Markdown linter / markdown-link-checker (pull_request) Successful in 23s
ah-annotation
GitHub Action to generate ArtifactHub changelog 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.
Pre-release tags (matching -rc) are detected automatically and result in an artifacthub.io/prerelease annotation
instead.
Usage
Auto-detect tags
Without explicit inputs the action determines the two most recent non-RC tags from the Git history:
steps:
- uses: actions/checkout@v7.0.1
with:
fetch-depth: 0
- uses: volker.raschek/ah-annotations@v0.0.1
Explicit tags
Pass old-tag and new-tag to control the commit range:
steps:
- uses: actions/checkout@v7.0.1
with:
fetch-depth: 0
- uses: volker.raschek/ah-annotations@v0.0.1
with:
old-tag: v1.0.0
new-tag: v2.0.0
Inputs
| Name | Required | Default | Description |
|---|---|---|---|
chart-path |
no | ${{ github.workspace }}/Chart.yaml |
Path to the Helm chart file. |
old-tag |
no | auto-detected | Start tag for changelog generation. |
new-tag |
no | auto-detected | End tag for changelog generation. |
yq-version |
no | v4.53.3 |
Version of yq to install. |
yq-arch |
no | auto-detected | Architecture 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-download-url |
no | auto-built | Full URL to download yq from. |
Requirements
- The repository must be checked out with full history (
fetch-depth: 0). - A
Chart.yamlfile must exist at the path specified bychart-path. - Commit messages must follow the Conventional Commits format.
Commit type mapping
| Commit type | ArtifactHub kind |
|---|---|
feat |
added |
fix |
fixed |
chore, style, test, ci, docs, refac |
changed |
revert |
removed |
sec |
security |
Languages
Shell
74.3%
Makefile
25.7%