chore: enable auto release on 3.x #5372
Conversation
WalkthroughThe pull request introduces several changes primarily focused on the GitHub Actions workflows and documentation for the Egg.js project. The CodeQL analysis workflow is updated to trigger on the Changes
Possibly related PRs
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
CodeRabbit Configuration File (
|
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
![coderabbitai[bot]](/~https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
package.json (1)
4-7: Consider adding release notes in package.jsonSince this is a significant change in the package distribution strategy, consider adding a
notefield in the publishConfig to document this change for future reference."publishConfig": { "tag": "latest", - "access": "public" + "access": "public", + "note": "Changed from release-3.x to latest tag on <DATE> for auto-release workflow" },
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (5)
.github/workflows/codeql-analysis.yml(1 hunks).github/workflows/release-3.x.yml(1 hunks)README.md(1 hunks)README.zh-CN.md(1 hunks)package.json(1 hunks)
✅ Files skipped from review due to trivial changes (3)
- .github/workflows/release-3.x.yml
- README.md
- README.zh-CN.md
🔇 Additional comments (4)
.github/workflows/codeql-analysis.yml (2)
16-16: LGTM! Good security practice.
Adding CodeQL analysis for the 3.x branch ensures consistent security scanning across all active development branches.
16-16: Verify branch protection rules for 3.x
Ensure that branch protection rules for the 3.x branch require CodeQL checks to pass before merging.
package.json (2)
5-5: Verify the implications of changing the npm publish tag
Changing the publish tag from "release-3.x" to "latest" means that version 3.x will become the default version when users run npm install egg. Please ensure that:
- This change aligns with the project's versioning strategy
- Users are properly notified about this change
- Documentation is updated to reflect this change
Let's verify the current npm tags and versions:
✅ Verification successful
Changing the publish tag to "latest" is already aligned with current npm configuration
The verification shows that version 3.29.0 is already tagged as "latest" in the npm registry, which means this change in package.json is actually synchronizing the configuration with the current state. The npm tags show:
latest: '3.29.0'- Beta version 4.0.0-beta.0 is properly tagged as
beta - Older major versions (1.x, 2.x) are properly tagged with
latest-1andlatest-2
This change is safe and follows proper semantic versioning practices.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Check current npm tags and recent versions to understand the impact
# Get current npm dist-tags
npm view egg dist-tags
# Get recent versions and their publish dates
npm view egg versions --json | jq -r '.[-10:]'
Length of output: 315
2-2: Verify version management strategy
The current version is 3.29.0. With the new auto-release workflow and latest tag, ensure that:
- The version bump automation is properly configured
- The version follows semantic versioning
- The auto-release workflow correctly updates this version
Let's check the version management setup:
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## 3.x #5372 +/- ##
=======================================
Coverage 99.69% 99.69%
=======================================
Files 35 35
Lines 3583 3583
Branches 528 528
=======================================
Hits 3572 3572
Misses 11 11 ☔ View full report in Codecov by Sentry. |
Summary by CodeRabbit
Release Notes
New Features
3.xbranch.Improvements
3.xbranch.Chores