From 4b597e31ac381a0c57e166356351a8a449d13f5d Mon Sep 17 00:00:00 2001 From: Gabriele Bartolini Date: Thu, 29 May 2025 17:52:44 +0200 Subject: [PATCH] docs: release procedure (#373) Closes #371 Signed-off-by: Gabriele Bartolini Signed-off-by: Marco Nenciarini Co-authored-by: Marco Nenciarini --- .wordlist.txt | 3 +++ README.md | 39 +++++++++++++++++++++++++++++++++++++++ RELEASE-PROCEDURE.md | 10 ++++++++++ 3 files changed, 52 insertions(+) create mode 100644 RELEASE-PROCEDURE.md diff --git a/.wordlist.txt b/.wordlist.txt index f520ed0..6fb521f 100644 --- a/.wordlist.txt +++ b/.wordlist.txt @@ -3,11 +3,13 @@ Azurite BarmanObjectStore BarmanObjectStoreConfiguration BarmanObjectStores +CNCF CRD CloudNativePG DataBackupConfiguration DigitalOcean Docusaurus +EDB EKS EnvVar GCP @@ -40,6 +42,7 @@ SFO SPDX SPDX ServerRecoveryWindow +Slonik TLS TODO Uncomment diff --git a/README.md b/README.md index b07a79c..97b7f58 100644 --- a/README.md +++ b/README.md @@ -4,3 +4,42 @@ The documentation for the Barman Cloud Plugin for CloudNativePG is available at [https://cloudnative-pg.io/plugin-barman-cloud](https://cloudnative-pg.github.io/plugin-barman-cloud). + +--- + +The Barman Cloud CNPG-I plugin is a component of the +[CloudNativePG project](https://github.com/cloudnative-pg) and adheres to the +same community-driven [governance](GOVERNANCE.md) model under the +[CNCF](https://cncf.io). + +

+ + + + CNCF logo + +

+ +--- + +

+CloudNativePG was originally built and sponsored by EDB. +

+ +

+ + + + EDB logo + +

+ +--- + +

+Postgres, PostgreSQL, and the Slonik Logo +are trademarks or registered trademarks of the PostgreSQL Community Association +of Canada, and used with their permission. +

+ +--- diff --git a/RELEASE-PROCEDURE.md b/RELEASE-PROCEDURE.md new file mode 100644 index 0000000..3cad69f --- /dev/null +++ b/RELEASE-PROCEDURE.md @@ -0,0 +1,10 @@ +# Release Procedure + +The Barman Cloud Plugin follows [Semantic Versioning](https://semver.org/) and +uses [Conventional Commits](https://www.conventionalcommits.org/) to structure +commit messages. +It leverages the [Release Please](https://github.com/googleapis/release-please) +tool to automate the release process. + +The only requirement is that each release must include versioned documentation. +For more details, please refer to [web/README.md](web/README.md).