Skip to content

Commit

Permalink
Documentation fixes
Browse files Browse the repository at this point in the history
Signed-off-by: Itay Grudev <[email protected]>
  • Loading branch information
itay-grudev committed Mar 21, 2024
1 parent 1d67bb7 commit d1ec567
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 9 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
11 changes: 4 additions & 7 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
3 changes: 1 addition & 2 deletions charts/cluster/README.md.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -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" . }}

0 comments on commit d1ec567

Please sign in to comment.