Skip to content

docs: use APP_ prefix instead of reserved GITHUB_ prefix#363

Merged
parkerbxyz merged 3 commits intoactions:mainfrom
joshjohanning:main
Apr 21, 2026
Merged

docs: use APP_ prefix instead of reserved GITHUB_ prefix#363
parkerbxyz merged 3 commits intoactions:mainfrom
joshjohanning:main

Conversation

@joshjohanning
Copy link
Copy Markdown
Contributor

I saw this PR was merged changing the Client ID and Private Key variable/secret used in the docs.

  client-id: ${{ vars.GITHUB_APP_CLIENT_ID }}
  private-key: ${{ secrets.GITHUB_APP_PRIVATE_KEY }}

However,

Variable name cannot start with "GITHUB_" prefix. (nor can secrets for that matter).  Perhaps just use CLIENT_ID and then use PRIVATE_KEY again.

The same applies for secrets as well.

My PR suggests

  client-id: ${{ vars.APP_CLIENT_ID }}
  private-key: ${{ secrets.APP_PRIVATE_KEY }}

Thanks for the consideration!

@joshjohanning joshjohanning requested a review from a team as a code owner April 21, 2026 13:01
Copilot AI review requested due to automatic review settings April 21, 2026 13:01
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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_KEY with APP_CLIENT_ID / APP_PRIVATE_KEY in 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

Comment thread README.md Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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_ID with vars.APP_CLIENT_ID across usage examples.
  • Replace secrets.GITHUB_APP_PRIVATE_KEY with secrets.APP_PRIVATE_KEY across 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

Comment thread README.md Outdated
Comment thread README.md
@parkerbxyz parkerbxyz changed the title docs: use APP_ prefix instead of reserved GITHUB_ prefix docs: use APP_ prefix instead of reserved GITHUB_ prefix Apr 21, 2026
Copy link
Copy Markdown
Contributor

@parkerbxyz parkerbxyz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for catching this and opening this pull request, @joshjohanning! ✨

@parkerbxyz parkerbxyz merged commit 7989d20 into actions:main Apr 21, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants