From d8af945d68f1dcdfd28a3bb6c3409ec2240ee15b Mon Sep 17 00:00:00 2001 From: Pascal Hofmann Date: Mon, 9 Sep 2024 21:00:31 +0200 Subject: [PATCH] Add section about creating a release to CONTRIBUTING.md Signed-off-by: Pascal Hofmann --- CONTRIBUTING.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dcddb9e..0ac251c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -64,6 +64,11 @@ Run [shellcheck] against any shell files eg `shellcheck src/docker-entrypoint.sh note the default output is `README.md updated.` so you will need to use git diff or similar to check for changes +## Creating a release +Run the `release` GitHub Action. It will take care of everything. + +After this is done head to the Release page and edit the latest Draft on top, select the +tag you just released and make sure `Set as a pre-release` is unchecked. [Slack]: https://slack.terraform-docs.io/ [Developer Certificate of Origin]: https://github.com/apps/dco