Skip to content

Add section about creating a release to CONTRIBUTING.md #142

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 10, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down