Add more info about releases and handling issues with releases. (#541)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 947d72b..815ace5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md
@@ -90,6 +90,15 @@ - Tag will be pushed 1. [Create new release](https://github.com/hashicorp/terraform-exec/releases/new) via GitHub UI to point to the new tag and copy the appropriate part of the CHANGELOG.md there. +### Problems with the release process + +If you experience an error with the `release` workflow you may be able to resolve it by re-running the workflow. + +Known errors that can be addressed by re-running the workflow: +* `gpg failed to sign the data` + +In other cases, you may need to check on the SSH and GPG keys associated with the `proj-terraform-exec-bot` bot. You can ask for help with Signore in #team-selfmanaged-releng in Slack. + ## Security vulnerabilities Please disclose security vulnerabilities by following the procedure
diff --git a/scripts/release/README.md b/scripts/release/README.md new file mode 100644 index 0000000..ea7a380 --- /dev/null +++ b/scripts/release/README.md
@@ -0,0 +1 @@ +For information about the release process, see [CONTRIBUTING.md](https://github.com/hashicorp/terraform-exec/blob/main/CONTRIBUTING.md#releases)