From 0f5a10671114380b289d3fae68b17fc1313bbdd2 Mon Sep 17 00:00:00 2001 From: Ben Drucker Date: Wed, 6 Dec 2023 12:29:00 -0800 Subject: [PATCH] docs: add publish caveat (#84) --- .github/CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index f7c50d53..e9446c91 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -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.