feat!: Improve Pull Request Template & Contributing Guidelines (argop…

…roj#750)

* feat: improve documentation and require changelog

Signed-off-by: Oliver Bähler <[email protected]>

* Bump Versions

Signed-off-by: Oliver Bähler <[email protected]>

* Bump argo-rollouts

Signed-off-by: Marco Kilchhofer <[email protected]>

* Apply suggestions from code review

Signed-off-by: Marco Kilchhofer <[email protected]>

* Reword Artifacthub -> Artifact Hub

Signed-off-by: Marco Kilchhofer <[email protected]>

Co-authored-by: Marco Kilchhofer <[email protected]>

.github/pull_request_template.md

@@ -4,9 +4,9 @@ If the DCO action in the integration test fails, one or more of your commits are
 
 Checklist:
 
-* [ ] I have updated the chart version in `Chart.yaml` following Semantic Versioning.
+* [ ] I have bumped the chart version according to [versioning](https://github.com/argoproj/argo-helm/blob/master/CONTRIBUTING.md#versioning)
+* [ ] I have updated the chart changelog with all the changes that come with this pull request according to [changelog](https://github.com/argoproj/argo-helm/blob/master/CONTRIBUTING.md#changelog).
 * [ ] Any new values are backwards compatible and/or have sensible default.
-* [ ] I have followed the testing instructions in the [contributing guide](https://github.com/argoproj/argo-helm/blob/master/CONTRIBUTING.md).
 * [ ] I have signed off all my commits as required by [DCO](https://github.com/argoproj/argoproj/tree/master/community#contributing-to-argo).
 * [ ] My build is green ([troubleshooting builds](https://argoproj.github.io/argo-cd/developer-guide/ci/)).
 

CONTRIBUTING.md

@@ -2,6 +2,54 @@
 
 Argo Helm is a collection of **community maintained** charts. Therefore we rely on you to test your changes sufficiently.
 
+
+# Pull Requests
+
+All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult [GitHub Help](https://help.github.com/articles/about-pull-requests/) for more information on using pull requests. See the above stated requirements for PR on this project.
+
+## Versioning
+
+Each chart's version follows the [semver standard](https://semver.org/). New charts should start at version `1.0.0`, if it's considered stable. If it's not considered stable, it must be released as [prerelease](#prerelease).
+
+Any breaking changes to a chart (backwards incompatible) require:
+
+  * Bump of the current Major version of the chart
+  * State possible manual changes for this chart version in the `Upgrading` section of the chart's `README.md.gotmpl` ([See Upgrade](#upgrades))
+
+### Immutability
+
+Each release for each chart must be immutable. Any change to a chart (even just documentation) requires a version bump. Trying to release the same version twice will result in an error.
+
+
+### Artifact Hub Annotations
+
+Since we release our charts on Artifact Hub we encourage making use of the provided chart annotations for Artifact Hub.
+
+  * [https://artifacthub.io/docs/topics/annotations/helm/](https://artifacthub.io/docs/topics/annotations/helm/)
+
+#### Changelog
+
+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:
+
+```
+name: argo-cd
+version: 3.4.1
+...
+annotations:
+  artifacthub.io/changes: |
+    - "[Added]: Something New was added"
+    - "[Changed]: Changed Something within this chart"
+    - "[Changed]: Changed Something else within this chart"
+    - "[Deprecated]: Something deprecated"
+    - "[Removed]: Something was removed"
+    - "[Fixed]: Something was fixed"
+    - "[Security]": Some Security Patch was included"
+```
+
+# Testing
+
 ## Testing Argo Workflows Changes
 
 Minimally:
@@ -96,4 +144,4 @@ The linting can be invoked manually with the following command:
 
 ## Publishing Changes
 
-Changes are automatically publish whenever a commit is merged to master. The CI job (see `./.github/workflows/publish.yml`).
+Changes are automatically publish whenever a commit is merged to master. The CI job (see `./.github/workflows/publish.yml`).

README.md

@@ -1,9 +1,14 @@
 # Argo Helm Charts
 
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 [![Chart Publish](https://github.com/argoproj/argo-helm/actions/workflows/publish.yml/badge.svg?branch=master)](https://github.com/argoproj/argo-helm/actions/workflows/publish.yml)
 
 Argo Helm is a collection of **community maintained** charts for http://argoproj.io/ projects. The charts can be added using following command:
 
 ```
 helm repo add argo https://argoproj.github.io/argo-helm
 ```
+
+## Contributing
+
+We'd love to have you contribute! Please refer to our [contribution guidelines](CONTRIBUTING.md) for details.

charts/argo-cd/Chart.yaml

@@ -2,7 +2,7 @@ apiVersion: v2
 appVersion: 2.0.4
 description: A Helm chart for ArgoCD, a declarative, GitOps continuous delivery tool for Kubernetes.
 name: argo-cd
-version: 3.7.1
+version: 3.7.2
 home: https://github.com/argoproj/argo-helm
 icon: https://raw.githubusercontent.com/argoproj/argo/master/docs/assets/argo.png
 keywords:

charts/argo-events/Chart.yaml

@@ -1,7 +1,7 @@
 apiVersion: v2
 description: A Helm chart to install Argo-Events in k8s Cluster
 name: argo-events
-version: 1.6.2
+version: 1.6.4
 keywords:
   - argo-events
   - sensor-controller
@@ -15,3 +15,6 @@ maintainers:
 appVersion: 1.3.1
 icon: https://raw.githubusercontent.com/argoproj/argo/master/docs/assets/argo.png
 home: https://github.com/argoproj/argo-helm
+annotations:
+  artifacthub.io/changes: |
+    - "[Added]: Initialize Changelog"

charts/argo-rollouts/Chart.yaml

@@ -2,10 +2,13 @@ apiVersion: v2
 appVersion: "v1.0.2"
 description: A Helm chart for Argo Rollouts
 name: argo-rollouts
-version: 1.0.2
+version: 1.0.3
 icon: https://raw.githubusercontent.com/argoproj/argo/master/argo.png
 home: https://github.com/argoproj/argo-helm
 maintainers:
   - name: alexmt
   - name: dthomson25
   - name: jessesuen
+annotations:
+  artifacthub.io/changes: |
+    - "[Added]: Initialize Changelog"

charts/argo-workflows/Chart.yaml

@@ -2,7 +2,7 @@ apiVersion: v2
 name: argo-workflows
 description: A Helm chart for Argo Workflows
 type: application
-version: 0.2.6
+version: 0.2.7
 appVersion: "v3.0.7"
 icon: https://raw.githubusercontent.com/argoproj/argo-workflows/master/docs/assets/argo.png
 home: https://github.com/argoproj/argo-helm
@@ -13,3 +13,6 @@ maintainers:
   - name: alexmt
   - name: jessesuen
   - name: benjaminws
+annotations:
+  artifacthub.io/changes: |
+    - "[Added]: Initialize Changelog"

charts/argocd-applicationset/Chart.yaml

@@ -2,7 +2,7 @@ apiVersion: v2
 name: argocd-applicationset
 description: A Helm chart for installing ArgoCD ApplicationSet
 type: application
-version: 0.1.6
+version: 0.1.7
 appVersion: "v0.1.0"
 home: https://github.com/argoproj/argo-helm
 icon: https://raw.githubusercontent.com/argoproj/argo/master/docs/assets/argo.png
@@ -12,3 +12,6 @@ keywords:
   - gitops
 maintainers:
   - name: maruina
+annotations:
+  artifacthub.io/changes: |
+    - "[Added]: Initialize Changelog"

charts/argocd-notifications/Chart.yaml

@@ -3,7 +3,7 @@ appVersion: 1.1.1
 description: A Helm chart for ArgoCD notifications, an add-on to ArgoCD.
 name: argocd-notifications
 type: application
-version: 1.4.0
+version: 1.4.1
 home: https://github.com/argoproj/argo-helm
 icon: https://raw.githubusercontent.com/argoproj/argo/master/docs/assets/argo.png
 keywords:
@@ -13,3 +13,6 @@ keywords:
 maintainers:
   - name: alexmt
   - name: andyfeller
+annotations:
+  artifacthub.io/changes: |
+    - "[Added]: Initialize Changelog"