docs: use APP_ prefix instead of reserved GITHUB_ prefix#363
docs: use APP_ prefix instead of reserved GITHUB_ prefix#363parkerbxyz merged 3 commits intoactions:mainfrom
APP_ prefix instead of reserved GITHUB_ prefix#363Conversation
There was a problem hiding this comment.
Pull request overview
Updates the README documentation to avoid using the reserved GITHUB_ prefix for GitHub Actions variables/secrets by switching examples to an APP_-prefixed naming scheme.
Changes:
- Replaces
GITHUB_APP_CLIENT_ID/GITHUB_APP_PRIVATE_KEYwithAPP_CLIENT_ID/APP_PRIVATE_KEYin workflow examples. - Updates the base64 decode example to reference the renamed secret.
Show a summary per file
| File | Description |
|---|---|
| README.md | Adjusts docs examples to avoid reserved GITHUB_-prefixed variable/secret names. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 1/1 changed files
- Comments generated: 1
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Updates the README workflow examples to avoid using the reserved GITHUB_ prefix for Actions variables/secrets, keeping the docs copy‑pasteable for users configuring client-id and private-key.
Changes:
- Replace
vars.GITHUB_APP_CLIENT_IDwithvars.APP_CLIENT_IDacross usage examples. - Replace
secrets.GITHUB_APP_PRIVATE_KEYwithsecrets.APP_PRIVATE_KEYacross usage examples (including the base64 decode snippet).
Show a summary per file
| File | Description |
|---|---|
| README.md | Updates documentation examples to use non-reserved APP_-prefixed variable/secret names. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 1/1 changed files
- Comments generated: 2
APP_ prefix instead of reserved GITHUB_ prefix
parkerbxyz
left a comment
There was a problem hiding this comment.
Thank you for catching this and opening this pull request, @joshjohanning! ✨
I saw this PR was merged changing the Client ID and Private Key variable/secret used in the docs.
However,
The same applies for secrets as well.
My PR suggests
Thanks for the consideration!