Skip to content

Use GitHub App token instead of default token#314

Merged
5ouma merged 1 commit intomainfrom
ci-release-app-token
Jun 14, 2025
Merged

Use GitHub App token instead of default token#314
5ouma merged 1 commit intomainfrom
ci-release-app-token

Conversation

@5ouma
Copy link
Owner

@5ouma 5ouma commented Jun 14, 2025

⚠️ Issue

close #


✏️ Description

It will fire workflows that can't be with the default token.

@5ouma
ci(release): Use GitHub App token instead of default token
73f2465 
It will fire workflows that can't be with the default token.
Copilot AI review requested due to automatic review settings June 14, 2025 14:02
@coderabbitai
Copy link

coderabbitai bot commented Jun 14, 2025 •
edited
Loading

Walkthrough

The changes remove a GitHub Actions linter configuration file that excluded a specific policy warning and update the release workflow. The workflow now generates a GitHub App token with specific permissions and disables credential persistence during checkout, modifying how tokens are handled in the release process.

Changes

Files/Groups Change Summary
.github/ghalint.yml Deleted configuration file that excluded a linter policy warning for persistent credentials.
.github/workflows/release.yml Updated workflow: removed explicit permissions, added GitHub App token generation, disabled credential persistence in checkout, and reordered a step in the release job.
✨ Finishing Touches
🧪 Generate Unit Tests
  • Create PR with Unit Tests
  • Commit Unit Tests in branch ci-release-app-token
  • Post Copyable Unit Tests in Comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai auto-generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added the 🎽 CI Changes to CI configuration files and scripts label Jun 14, 2025
Copilot AI reviewed Jun 14, 2025
View reviewed changes
Copy link

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

This PR replaces the default GITHUB_TOKEN with a GitHub App token for workflows that need elevated permissions.

  • Disable checkout’s default credentials and add steps to generate an App token
  • Inject the App token into the tagpr job
  • Mirror the App token setup in the release job and clean up lint config

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
.github/workflows/release.yml Swapped out default token, added actions/create-github-app-token steps and updated GITHUB_TOKEN usage for tagpr
.github/ghalint.yml Removed exclusion for checkout_persist_credentials_should_be_false policy
Comments suppressed due to low confidence (2)

.github/workflows/release.yml:25

  • After generating the App token in the release job, you need to override GITHUB_TOKEN for subsequent steps (e.g., env: { GITHUB_TOKEN: ${{ steps.app-token.outputs.token }} }) so actions use the new token instead of the default.
- name: 💳 Create GitHub App Token

.github/ghalint.yml:1

  • [nitpick] Removing this exclusion may trigger lint failures for the persist-credentials rule. Ensure the updated workflows comply with the policy or reintroduce an appropriate exception.
-excludes:

@5ouma
Copy link
Owner Author

5ouma commented Jun 14, 2025

@coderabbitai review

@coderabbitai
Copy link

coderabbitai bot commented Jun 14, 2025

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

coderabbitai[bot]
coderabbitai bot reviewed Jun 14, 2025
View reviewed changes
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
.github/workflows/release.yml (1)

66-73: Generate GitHub App token in the release job
The App token scoped to contents: write and pull-requests: write is correctly generated for the homebrew-tap repository.

Consider renaming the step IDs (e.g., tagpr-app-token vs. release-app-token) to improve log clarity across jobs.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d7a06ec and 73f2465.

📒 Files selected for processing (2)
  • .github/ghalint.yml (0 hunks)
  • .github/workflows/release.yml (2 hunks)
💤 Files with no reviewable changes (1)
  • .github/ghalint.yml
🔇 Additional comments (3)
.github/workflows/release.yml (3)

23-23: Disable credential persistence for security
The persist-credentials: false flag ensures the default GITHUB_TOKEN isn’t accidentally stored in Git config, preventing unintentional usage by downstream steps.

25-32: Introduce GitHub App token for the tagpr job
Replacing the default token with an App token scoped to contents: write and pull-requests: write correctly grants only the permissions needed to create tags and PRs.

Please confirm that TAGPR_APP_ID/TAGPR_PRIVATE_KEY are configured and that the App installation covers this repository.

40-40: Override GITHUB_TOKEN with the App token
Setting GITHUB_TOKEN: ${{ steps.app-token.outputs.token }} makes the Songmu/tagpr action use the new App token. Ensure that this override behaves as expected during tagging.

@5ouma 5ouma merged commit 3406b98 into main Jun 14, 2025
5 of 6 checks passed
@5ouma 5ouma deleted the ci-release-app-token branch June 14, 2025 14:23
@5ouma 5ouma bot mentioned this pull request Jun 14, 2025
Merged
This was referenced Dec 12, 2025
Merged
Merged
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@coderabbitai coderabbitai[bot] coderabbitai[bot] approved these changes

Assignees

@5ouma 5ouma

Labels

🎽 CI Changes to CI configuration files and scripts

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@5ouma