-
-
Notifications
You must be signed in to change notification settings - Fork 142
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
ci: update GitHub token in release workflow #481
Conversation
- Replace personal access token with GITHUB_TOKEN for create-pull-request action - Enhance security by using built-in GitHub token for authentication
Caution Review failedThe pull request is closed. 📝 Walkthrough📝 WalkthroughWalkthroughThe pull request introduces modifications to the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Workflow
participant GitHub
participant Repository
User->>Workflow: Trigger release with type
Workflow->>Repository: Checkout dev branch
Workflow->>GitHub: Configure Git
Workflow->>Repository: Fetch current version from package.json
Workflow->>Workflow: Calculate new version
Workflow->>Repository: Push changes to dev branch
Workflow->>GitHub: Create draft pull request to main
alt Push to main branch
Workflow->>GitHub: Create GitHub release
end
Warning Rate limit exceeded@EvanNotFound has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 18 minutes and 10 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📜 Recent review detailsConfiguration used: .coderabbit.yaml 📒 Files selected for processing (1)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
There was a problem hiding this 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
🧹 Outside diff range and nitpick comments (3)
.github/workflows/release.yml (3)
Line range hint
26-27
: Lock down Node.js version for better stabilityUsing
20.x
could potentially use an unstable version. Consider pinning to a specific LTS version (e.g.,20.10.0
).- node-version: '20.x' + node-version: '20.10.0'
Line range hint
73-75
: Avoidnpm install
after version bumpUsing
npm install
instead ofnpm ci
here could lead to inconsistent dependencies between testing and release. Thepackage-lock.json
should be updated during development, not during release.- npm install + npm ci
Line range hint
89-91
: Consider enhancing the PR body with a changelogThe PR body could be more informative by including a generated changelog of changes since the last release.
- body: "Automated release PR for version ${{ env.new_version }}" + body: | + # Release v${{ env.new_version }} + + ## What's Changed + <!-- Consider using action/github-changelog-generator here --> + + ## Upgrade Instructions + No breaking changes.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (1)
.github/workflows/release.yml
(1 hunks)
🔇 Additional comments (2)
.github/workflows/release.yml (2)
84-84
: LGTM! Good security improvement
Switching to GITHUB_TOKEN
from a personal access token (PAT) is a security best practice. The GITHUB_TOKEN
is automatically created and rotated by GitHub, reducing security risks associated with long-lived PATs.
Line range hint 51-56
: Consider adding version increment verification
The version increment step could benefit from a validation check to ensure the new version is actually greater than the current version.
- Remove 'v' prefix from new version for consistency - Improve version extraction and environment variable setting - Ensure clean version number is used in subsequent steps
• Modify checkout action to use dev branch • Remove creation of separate release branch • Update PR creation to use dev as source branch • Set PR to draft status • Add condition for GitHub release creation • Simplify overall release process
Summary by CodeRabbit
New Features
Improvements