forked from argoproj/argo-helm
feat(all): Add Documentation Guidelines (#1099)
* feat(all): Add Documentation Guidelines Signed-off-by: Oliver Bähler <oliverbaehler@hotmail.com> * Satisfy Linter Signed-off-by: Oliver Bähler <oliverbaehler@hotmail.com> * Apply changes from code review Signed-off-by: Marco Kilchhofer <mkilchhofer@users.noreply.github.com> * fix: Also add *.gotmpl to argo-rollouts/.helmignore Signed-off-by: Marco Kilchhofer <mkilchhofer@users.noreply.github.com> Co-authored-by: Marco Kilchhofer <mkilchhofer@users.noreply.github.com>main argo-cd-3.31.1
Oliver Bähler
GitHub
parent
2b830deaa4
commit
752e1c0580
|
|
@ -5,6 +5,7 @@ If the DCO action in the integration test fails, one or more of your commits are
|
|||
Checklist:
|
||||
|
||||
* [ ] I have bumped the chart version according to [versioning](https://github.com/argoproj/argo-helm/blob/master/CONTRIBUTING.md#versioning)
|
||||
* [ ] I have updated the documentation according to [documentation](https://github.com/argoproj/argo-helm/blob/master/CONTRIBUTING.md#documentation)
|
||||
* [ ] 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 signed off all my commits as required by [DCO](https://github.com/argoproj/argoproj/tree/master/community#contributing-to-argo).
|
||||
|
|
|
|||
|
|
@ -48,6 +48,20 @@ annotations:
|
|||
- "[Security]": Some Security Patch was included"
|
||||
```
|
||||
|
||||
## Documentation
|
||||
|
||||
The documentation for each chart is done with [helm-docs](https://github.com/norwoodj/helm-docs). This way we can ensure that values are consistent with the chart documentation.
|
||||
|
||||
We have a script on the repository which will execute the helm-docs docker container, so that you don't have to worry about downloading the binary etc. Simply execute the script (Bash compatible, might require sudo privileges):
|
||||
|
||||
```
|
||||
bash scripts/helm-docs.sh
|
||||
```
|
||||
|
||||
**NOTE**: When creating your own `README.md.gotmpl`, don't forget to add it to your `.helmignore` file.
|
||||
|
||||
|
||||
|
||||
# Testing
|
||||
|
||||
## Testing Argo Workflows Changes
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
/*.tgz
|
||||
output
|
||||
ci/
|
||||
README.md.gotmpl
|
||||
*.gotmpl
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@ apiVersion: v2
|
|||
appVersion: v2.2.2
|
||||
description: A Helm chart for ArgoCD, a declarative, GitOps continuous delivery tool for Kubernetes.
|
||||
name: argo-cd
|
||||
version: 3.31.0
|
||||
version: 3.31.1
|
||||
home: https://github.com/argoproj/argo-helm
|
||||
icon: https://argo-cd.readthedocs.io/en/stable/assets/logo.png
|
||||
keywords:
|
||||
|
|
@ -21,4 +21,4 @@ dependencies:
|
|||
condition: redis-ha.enabled
|
||||
annotations:
|
||||
artifacthub.io/changes: |
|
||||
- "[Added]: Add support for extra K8s manifests"
|
||||
- "[Changed]: Consistent .helmignore"
|
||||
|
|
|
|||
|
|
@ -20,4 +20,4 @@
|
|||
.idea/
|
||||
*.tmproj
|
||||
ci/
|
||||
README.md.gotmpl
|
||||
*.gotmpl
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
apiVersion: v2
|
||||
description: A Helm chart to install Argo-Events in k8s Cluster
|
||||
name: argo-events
|
||||
version: 1.10.1
|
||||
version: 1.10.2
|
||||
keywords:
|
||||
- argo-events
|
||||
- sensor-controller
|
||||
|
|
@ -17,4 +17,4 @@ icon: https://argoproj.github.io/argo-events/assets/logo.png
|
|||
home: https://github.com/argoproj/argo-helm
|
||||
annotations:
|
||||
artifacthub.io/changes: |
|
||||
- "[Changed]: Update to Argo Events v1.5.6"
|
||||
- "[Changed]: Consistent .helmignore"
|
||||
|
|
|
|||
|
|
@ -20,3 +20,4 @@
|
|||
.idea/
|
||||
*.tmproj
|
||||
ci/
|
||||
*.gotmpl
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@ apiVersion: v2
|
|||
appVersion: "v1.1.1"
|
||||
description: A Helm chart for Argo Rollouts
|
||||
name: argo-rollouts
|
||||
version: 2.9.1
|
||||
version: 2.9.2
|
||||
icon: https://argoproj.github.io/argo-rollouts/assets/logo.png
|
||||
home: https://github.com/argoproj/argo-helm
|
||||
maintainers:
|
||||
|
|
@ -11,4 +11,4 @@ maintainers:
|
|||
- name: jessesuen
|
||||
annotations:
|
||||
artifacthub.io/changes: |
|
||||
- "[Fixed]: Dashboard ingress service name"
|
||||
- "[Changed]: Consistent .helmignore"
|
||||
|
|
|
|||
|
|
@ -20,3 +20,4 @@
|
|||
.idea/
|
||||
*.tmproj
|
||||
ci/
|
||||
*.gotmpl
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@ apiVersion: v2
|
|||
name: argo-workflows
|
||||
description: A Helm chart for Argo Workflows
|
||||
type: application
|
||||
version: 0.9.4
|
||||
version: 0.9.5
|
||||
appVersion: v3.2.6
|
||||
icon: https://raw.githubusercontent.com/argoproj/argo-workflows/master/docs/assets/argo.png
|
||||
home: https://github.com/argoproj/argo-helm
|
||||
|
|
@ -15,4 +15,4 @@ maintainers:
|
|||
- name: benjaminws
|
||||
annotations:
|
||||
artifacthub.io/changes: |
|
||||
- "[Changed]: Update to app version v3.2.6"
|
||||
- "[Changed]: Consistent .helmignore"
|
||||
|
|
|
|||
|
|
@ -22,3 +22,4 @@
|
|||
*.tmproj
|
||||
.vscode/
|
||||
ci/
|
||||
*.gotmpl
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@ apiVersion: v2
|
|||
name: argocd-applicationset
|
||||
description: A Helm chart for installing ArgoCD ApplicationSet
|
||||
type: application
|
||||
version: 1.9.0
|
||||
version: 1.9.1
|
||||
appVersion: "v0.3.0"
|
||||
home: https://github.com/argoproj/argo-helm
|
||||
icon: https://argocd-applicationset.readthedocs.io/en/stable/assets/logo.png
|
||||
|
|
@ -14,4 +14,4 @@ maintainers:
|
|||
- name: maruina
|
||||
annotations:
|
||||
artifacthub.io/changes: |
|
||||
- "[Added]: Add ingress for webhook, not enabled by default."
|
||||
- "[Changed]: Consistent .helmignore"
|
||||
|
|
|
|||
|
|
@ -21,3 +21,5 @@
|
|||
.idea/
|
||||
*.tmproj
|
||||
.vscode/
|
||||
ci/
|
||||
*.gotmpl
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@ apiVersion: v2
|
|||
name: argocd-image-updater
|
||||
description: A Helm chart for Argo CD Image Updater, a tool to automatically update the container images of Kubernetes workloads which are managed by Argo CD
|
||||
type: application
|
||||
version: 0.6.1
|
||||
version: 0.6.2
|
||||
appVersion: v0.11.2
|
||||
home: https://github.com/argoproj-labs/argocd-image-updater
|
||||
icon: https://argocd-image-updater.readthedocs.io/en/stable/assets/logo.png
|
||||
|
|
@ -15,4 +15,4 @@ maintainers:
|
|||
url: https://argoproj.github.io/
|
||||
annotations:
|
||||
artifacthub.io/changes: |
|
||||
- "[Changed]: Update to app version v0.11.2"
|
||||
- "[Changed]: Consistent .helmignore"
|
||||
|
|
|
|||
|
|
@ -105,7 +105,7 @@ The `config.registries` value can be used exactly as it looks in the documentati
|
|||
| tolerations | list | `[]` | Kubernetes toleration settings for the deployment |
|
||||
|
||||
----------------------------------------------
|
||||
Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)
|
||||
Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs)
|
||||
|
||||
[MetricRelabelConfigs]: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs
|
||||
[RelabelConfigs]: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
|
||||
|
|
|
|||
|
|
@ -57,7 +57,8 @@ The `config.registries` value can be used exactly as it looks in the documentati
|
|||
|
||||
{{ template "chart.valuesSection" . }}
|
||||
|
||||
{{ template "helm-docs.versionFooter" . }}
|
||||
----------------------------------------------
|
||||
Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs)
|
||||
|
||||
[MetricRelabelConfigs]: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs
|
||||
[RelabelConfigs]: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
|
||||
|
|
|
|||
|
|
@ -20,3 +20,5 @@
|
|||
.idea/
|
||||
*.tmproj
|
||||
.vscode/
|
||||
ci/
|
||||
*.gotmpl
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ appVersion: v1.2.1
|
|||
description: A Helm chart for ArgoCD notifications, an add-on to ArgoCD.
|
||||
name: argocd-notifications
|
||||
type: application
|
||||
version: 1.7.0
|
||||
version: 1.7.1
|
||||
home: https://github.com/argoproj/argo-helm
|
||||
icon: https://argocd-notifications.readthedocs.io/en/stable/assets/logo.png
|
||||
keywords:
|
||||
|
|
@ -15,4 +15,4 @@ maintainers:
|
|||
- name: andyfeller
|
||||
annotations:
|
||||
artifacthub.io/changes: |
|
||||
- "[Added]: Support for dynamic Secret and ConfigMap names"
|
||||
- "[Changed]: Consistent .helmignore"
|
||||
|
|
|
|||
|
|
@ -0,0 +1,11 @@
|
|||
#!/bin/bash
|
||||
## Reference: https://github.com/norwoodj/helm-docs
|
||||
set -eux
|
||||
CHART_DIR="$(cd "$(dirname "$0")/.." && pwd)"
|
||||
echo "$CHART_DIR"
|
||||
|
||||
echo "Running Helm-Docs"
|
||||
docker run \
|
||||
-v "$CHART_DIR:/helm-docs" \
|
||||
-u $(id -u) \
|
||||
jnorwood/helm-docs:latest
|
||||
Loading…
Reference in New Issue