Repository navigation
Conversation
👋 Welcome! Looks like this is your first pull request.Hey, thanks for your contribution! Please give us a bit of time to review it. 😄 Please check out our contributing guidelines. |
This was referenced Oct 10, 2026
posquit0
force-pushed
the
docs/release-github-app-guide
branch
from
October 11, 2026 17:13
a24e27d to
e0004a1
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
👋 Background
We are piloting
release-pleaseonterraform-aws-accountbefore rolling it out through this repository's reusable workflows. Release pull requests and tags created withGITHUB_TOKENdo not trigger other workflows, so CI would not run on release pull requests. We use an organization-owned GitHub App instead of a personal access token.What changed
docs/release-github-app.md, which covers:GITHUB_TOKENor a personal access tokenRELEASE_GITHUB_APP_CLIENT_IDandRELEASE_GITHUB_APP_PRIVATE_KEY, and how to set them withgh secret setgithub.release-pleaseaction (feat(github.release-please): add the composite action for release-please with a GitHub App token #40), which mints a short-lived token withactions/create-github-app-token@v3(client-id) narrowed to the three write permissionsscripts/set-release-github-app-secrets.shfor the GitHub Free plan, where private repositories cannot use organization secrets. It setsRELEASE_GITHUB_APP_CLIENT_IDandRELEASE_GITHUB_APP_PRIVATE_KEYas repository secrets in every non-archivedterraform-*repository with thetype-moduletopic (or the repositories given as arguments), and deletes the legacyRELEASE_GITHUB_APP_IDsecret where it exists. The values come from environment variables and are passed togh secret setthrough standard input, never as arguments. It supports--dry-runand reports the repositories where it failed.Notes
release-please-action(contents,issues,pull-requests: write).Iv) asRELEASE_GITHUB_APP_CLIENT_ID. Workflows pass it to thegithub_app_client_idinput ofgithub.release-please, which passes it asclient-id.client-idreplaces the deprecatedapp-idincreate-github-app-tokenv3. GitHub recommends the Client ID as the JWT issuer. The script rejects a numeric App ID so that the value matches the secret name. Workflows that follow the guide pass lint now that feat(github-actions.actionlint): lint with jactionlint #37 (switch to jactionlint) is merged.