docs: add pre-release section and link ArtifactHub annotations

Document how the action handles pre-release tags (-rc pattern),
including the prerelease annotation and skipped changelog generation.
Link "ArtifactHub annotations" to the official documentation.

Co-authored-by: Copilot <copilot@github.com>
This commit is contained in:
2026-08-16 22:29:48 +02:00
co-authored by Copilot
parent 2d35007630
commit 6e260a363d
+14 -1
View File
@@ -1,6 +1,8 @@
# ah-annotation # ah-annotation
GitHub Action to generate ArtifactHub changelog annotations from Git commit history and add them to `Chart.yaml`. GitHub Action to generate [ArtifactHub
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
@@ -54,6 +56,17 @@ 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 |