fix(github): Align changelog structure to show changelogs on Artifact Hub (#1811)

fix(doc): Align changelog structure to show changelogs on Artifact Hub
Signed-off-by: yu-croco <yu.croco@gmail.com>
This commit is contained in:
Aikawa 2023-01-30 01:01:21 +09:00 committed by GitHub
parent c7b972c3af
commit b6922aed2f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -80,21 +80,35 @@ Changes on a chart must be documented in a chart specific changelog in the `Char
A new `artifacthub.io/changes` needs to be written covering only the changes since the previous release. A new `artifacthub.io/changes` needs to be written covering only the changes since the previous release.
Each change requires a new bullet point following the pattern `- "[{type}]: {description}"`. You can use the following template: Each change requires a new bullet point following the pattern. See more information [Artifact Hub annotations in Helm Chart.yaml file](https://artifacthub.io/docs/topics/annotations/helm/).
```yaml
- kind: {type}
description: {description}
```
You can use the following template:
```yaml ```yaml
name: argo-cd name: argo-cd
version: 3.4.1 version: 5.19.12
... ...
annotations: annotations:
artifacthub.io/changes: | artifacthub.io/changes: |
- "[Added]: Something New was added" - kind: added
- "[Changed]: Changed Something within this chart" description: Something New was added
- "[Changed]: Changed Something else within this chart" - kind: changed
- "[Deprecated]: Something deprecated" description: Changed Something within this chart
- "[Removed]: Something was removed" - kind: changed
- "[Fixed]: Something was fixed" description: Changed Something else within this chart
- "[Security]: Some Security Patch was included" - kind: deprecated
description: Something deprecated
- kind: removed
description: Something was removed
- kind: fixed
description: Something was fixed
- kind: security
description: Some Security Patch was included
``` ```
## Testing ## Testing