Skip to content

Commit d8af945

Browse files
Add section about creating a release to CONTRIBUTING.md
Signed-off-by: Pascal Hofmann <mail@pascalhofmann.de>
1 parent 0c2e582 commit d8af945

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,11 @@ Run [shellcheck] against any shell files eg `shellcheck src/docker-entrypoint.sh
6464
note the default output is `README.md updated.` so you will need to use git diff or
6565
similar to check for changes
6666

67+
## Creating a release
68+
Run the `release` GitHub Action. It will take care of everything.
69+
70+
After this is done head to the Release page and edit the latest Draft on top, select the
71+
tag you just released and make sure `Set as a pre-release` is unchecked.
6772

6873
[Slack]: https://slack.terraform-docs.io/
6974
[Developer Certificate of Origin]: https://github.com/apps/dco

0 commit comments

Comments
 (0)