DevFW-CICD/argocd-helm
16
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Reword artifacthub changes section in CONTRIBUTING

Browse source 
Signed-off-by: jmeridth <jmeridth@gmail.com>
Co-authored-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
This commit is contained in:
jmeridth 2023-01-20 01:28:28 -06:00
parent 5aea0143b9
commit fe3f219bda
No known key found for this signature in database
GPG key ID: 246606CF636B3F68
1 changed files with 6 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
CONTRIBUTING.md
View file

@ -46,7 +46,11 @@ Since we release our charts on Artifact Hub we encourage making use of the provi
We want to deliver transparent chart releases for our chart consumers. Therefore we require a changelog per new chart release. We want to deliver transparent chart releases for our chart consumers. Therefore we require a changelog per new chart release.
Changes on a chart must be documented in a chart specific changelog in the `Chart.yaml` [Annotation Section](https://helm.sh/docs/topics/charts/#the-chartyaml-file). For every new release the entire `artifacthub.io/changes` needs to be rewritten. Each change requires a new bullet point following the pattern `- "[{type}]: {description}"`. You can use the following template: Changes on a chart must be documented in a chart specific changelog in the `Chart.yaml` [Annotation Section](https://helm.sh/docs/topics/charts/#the-chartyaml-file).
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:
```yaml ```yaml
name: argo-cd name: argo-cd
@ -60,7 +64,7 @@ artifacthub.io/changes: |
- "[Deprecated]: Something deprecated" - "[Deprecated]: Something deprecated"
- "[Removed]: Something was removed" - "[Removed]: Something was removed"
- "[Fixed]: Something was fixed" - "[Fixed]: Something was fixed"
- "[Security]": Some Security Patch was included" - "[Security]: Some Security Patch was included"
``` ```
## Documentation ## Documentation