Skip to content

Commit

Permalink
docs: add publish caveat (#84)
Browse files Browse the repository at this point in the history
  • Loading branch information
bendrucker authored Dec 6, 2023
1 parent 1e6658e commit 0f5a106
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ You must set the `tag` input when calling this workflow and select the appropria

If the `publish` input is not set, release artifacts will be created for the job and planned S3 uploads will be logged but not copied. When `publish` is enabled, a GitHub Release will be created and the release artifacts will be uploaded to the Observe Terraform Registry via S3.

**Releases are created as drafts. After reviewing the generated changelog, click _Publish_ to make the release available.**

### Prerelease

**⚠️ Caution:** Triggering the release job on a reference other than a tag applied to a commit on the default branch will release a version of the provider using code that has not yet been tested and merged. Take caution to include a [prerelease suffix](https://semver.org/#spec-item-9) to ensure that users do not download these versions by default.
Expand Down

0 comments on commit 0f5a106

Please sign in to comment.