From d1ec567e95ccb228856ec7b0c1fe3f77e8086177 Mon Sep 17 00:00:00 2001 From: Itay Grudev Date: Thu, 21 Mar 2024 13:45:17 +0200 Subject: [PATCH] Documentation fixes Signed-off-by: Itay Grudev --- README.md | 5 +++++ RELEASE.md | 11 ++++------- charts/cluster/README.md.gotmpl | 3 +-- 3 files changed, 10 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 67eccbd93..517cb6639 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,11 @@ helm upgrade --install database \ Refer to the [Cluster Chart documentation](charts/cluster/README.md) for advanced configuration options. +## Provenance + +The charts support Helm Provenance and Integrity. +Here is a link to the [PGP key](provenance.gpg) used by GitHub Actions to sign the charts. + ## Contributing Please read the [code of conduct](CODE-OF-CONDUCT.md) and the diff --git a/RELEASE.md b/RELEASE.md index 984d1d550..7cdeeed53 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -86,10 +86,8 @@ In order to create a new release of the `cloudnative-pg` chart, follow these ste 10. Wait for all the checks to pass 11. Two approvals are required in order to merge the PR, if you are a maintainer approve the PR yourself and ask for another approval, otherwise ask for two approvals directly. -12. Merge the PR squashing all commits and **taking care to keep the commit message to be - `Release cloudnative-pg-vX.Y.Z`** -13. A release `cloudnative-pg-vX.Y.Z` should be automatically created by an action, which will then trigger the release - action. Verify they both are successful. +12. Merge the PR squashing all commits and **taking care to keep the commit message to be `Release cloudnative-pg-vX.Y.Z`** +13. A release `cloudnative-pg-vX.Y.Z` should be automatically created. 14. Once done you should be able to run: ```bash helm repo add cnpg https://cloudnative-pg.github.io/charts @@ -137,9 +135,8 @@ In order to create a new release of the `cluster` chart, follow these steps: 10. Two approvals are required in order to merge the PR, if you are a maintainer approve the PR yourself and ask for another approval, otherwise ask for two approvals directly. -11. Merge the PR squashing all commits and **taking care to keep the commit - message to be `Release cluster-vX.Y.Z`** -12. A release `cluster-vX.Y.Z` should be automatically created by an action, which will ten trigger the release action. +11. Merge the PR squashing all commits and **taking care to keep the commit message to be `Release cluster-vX.Y.Z`** +12. A release `cluster-vX.Y.Z` should be automatically created. Verify they both are successful. 13. Once done you should be able to run: ```bash diff --git a/charts/cluster/README.md.gotmpl b/charts/cluster/README.md.gotmpl index 956e1431e..fb07f77ef 100644 --- a/charts/cluster/README.md.gotmpl +++ b/charts/cluster/README.md.gotmpl @@ -141,7 +141,6 @@ Alternatively a ticket and a PR if you have found that something needs a change TODO ---- * IAM Role for S3 Service Account -* Automatic provisioning of a Alert Manager configuration - +* Replica Cluster {{ template "helm-docs.versionFooter" . }}