feat!: migrate all templates from app_id to client_id (major)#458
Open
timdittler wants to merge 1 commit into
Open
feat!: migrate all templates from app_id to client_id (major)#458timdittler wants to merge 1 commit into
timdittler wants to merge 1 commit into
Conversation
timdittler
force-pushed
the
feat/automerge-client-id
branch
from
15a21cf to
ec07e3d
Compare
timdittler
force-pushed
the
feat/automerge-client-id
branch
from
ec07e3d to
1fcb43d
Compare
timdittler
changed the title
BREAKING CHANGE: every template that authenticated via a GitHub App now requires a client_id (client-id) secret instead of app_id (app-id), and passes it to create-github-app-token's client-id input. The action deprecated app-id in favor of client-id. Migrated templates: - template_automerge_dependabot: app_id -> client_id (now required) - template_autodev: app_id -> client_id - template_changeset_release: app_id -> client_id - template_release_drafter: app_id -> client_id - template_terraform_format: app-id -> client-id - template_gitops: app-id -> client-id - versions.yml (internal): STAFFBASE_ACTIONS_APP_ID -> STAFFBASE_ACTIONS_CLIENT_ID Callers must pass their App's client id (not app id). Existing callers are unaffected until they bump to this major version, at which point they must rename the secret. README examples updated.
timdittler
force-pushed
the
feat/automerge-client-id
branch
from
1fcb43d to
451b53d
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
1 participant
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.
What
Org-wide migration of the GitHub App auth secret from
app_id/app-idtoclient_id/client-idacross all templates.create-github-app-tokendeprecated itsapp-idinput in favor ofclient-id; templates now pass the secret toclient-id.Migrated
app_id(required)client_id(required)app_idclient_idapp_idclient_idapp_idclient_idapp-idclient-idapp-idclient-idvars.STAFFBASE_ACTIONS_APP_IDvars.STAFFBASE_ACTIONS_CLIENT_IDREADME examples updated.
Breaking / semver
majorlabel set so release-drafter cuts v14.0.0. Callers pin exact tags/SHAs, so nothing breaks until a caller bumps to v14 — at which point it must rename its secret toclient_id/client-idand pass the App's client id value (not the numeric app id). Callers are intentionally not migrated here.Prerequisites
STAFFBASE_ACTIONS_CLIENT_ID(staffbase-actions app client id) must exist —versions.ymlin this repo uses it immediately on merge.Related