Skip to content

Commit

Permalink
Merge pull request #142 from terraform-docs/add-release-info
Browse files Browse the repository at this point in the history
Add section about creating a release to CONTRIBUTING.md
  • Loading branch information
khos2ow authored Sep 10, 2024
2 parents f9a3358 + d8af945 commit fdf26f4
Showing 1 changed file with 5 additions and 0 deletions.
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

0 comments on commit fdf26f4

Please sign in to comment.