Repository navigation
feat(release)!: take the release-bot App client ID instead of its app id - #26
Merged
Merged
Conversation
actions/create-github-app-token deprecates app-id in favor of client-id.
release-prepare.yml now takes a client-id input, and the caller stub reads
vars.RELEASE_APP_CLIENT_ID.
A dry run now also mints a read-only App token and checks its slug, so it
proves the App credentials as well as the plan. It still writes nothing.
BREAKING CHANGE: the app-id input of release-prepare.yml is replaced by
client-id. Set a RELEASE_APP_CLIENT_ID repository variable to the App's
Client ID and pass client-id: ${{ vars.RELEASE_APP_CLIENT_ID }}.
1 of 2 tasks
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.
Summary
release-prepare.ymlreplaces theapp-idinput withclient-id.actions/create-github-app-tokenv3 marksapp-iddeprecated.client-id: ${{ vars.RELEASE_APP_CLIENT_ID }}.dry-runnow runs acheck-appjob. It mints a read-only App token and fails if the minted slug is notrelease-bot-app-slug. Before this, a dry run made no App call, so it could not catch bad App credentials. It still pushes nothing and opens no PR.release-pipeline-plan.mddescribe the new variable and the dry-run check. The versioning section now talks about v5.This is the v5.0.0 breaking change. Caller stubs move to the v5.0.0 SHA in a follow-up once the tag exists, as #24 did for v4.1.0.
Migration
Set a
RELEASE_APP_CLIENT_IDrepository variable to the App's Client ID (App settings -> General,Iv23li...), then change the prepare stub'sapp-id: ${{ vars.RELEASE_APP_ID }}toclient-id: ${{ vars.RELEASE_APP_CLIENT_ID }}.Test plan