docs: use client-id secret name for the releaser app in the maintainers guide - #640
Draft
zimeg wants to merge 1 commit into
Draft
docs: use client-id secret name for the releaser app in the maintainers guide#640zimeg wants to merge 1 commit into
zimeg wants to merge 1 commit into
Conversation
…rs guide The releaser GitHub App workflows now authenticate with client-id (GH_APP_CLIENT_ID_RELEASER) after #639, but the maintainers guide still listed the deprecated GH_APP_ID_RELEASER. Update the credentials list so anyone bootstrapping the releaser app sets the right secret name.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #640 +/- ##
==========================================
- Coverage 72.26% 72.25% -0.01%
==========================================
Files 238 238
Lines 20072 20072
==========================================
- Hits 14505 14503 -2
- Misses 4298 4299 +1
- Partials 1269 1270 +1 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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.
Changelog
N/A — maintainer docs only, no user-facing change.
Summary
This pull request updates the maintainers guide so its releaser-app credentials list matches the secret names the workflows actually use.
.github/workflows/release.ymlanddependencies.ymlfromapp-id: ${{ secrets.GH_APP_ID_RELEASER }}toclient-id: ${{ secrets.GH_APP_CLIENT_ID_RELEASER }}(followingcreate-github-app-token'sapp-iddeprecation).GH_APP_ID_RELEASER, leaving docs and workflows out of sync.Preview
N/A — text-only doc change.
Testing
grep -rn GH_APP_ID_RELEASER .github/returns no matches;GH_APP_CLIENT_ID_RELEASERnow appears in the guide and both workflows.Notes
GH_APP_CLIENT_ID_RELEASER, the now-unreferencedGH_APP_ID_RELEASERrepo secret should be deleted to keep the secret surface tidy.Requirements