Updated release process for Search and Comments UI #22146
Conversation
WalkthroughThis pull request updates the release process for specific applications by refining configuration management and automating package publication. In the release script ( Possibly related PRs
Suggested labels
Suggested reviewers
Poem
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[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
.github/scripts/release-apps.js(1 hunks).github/workflows/ci.yml(1 hunks)apps/comments-ui/package.json(1 hunks)apps/sodo-search/package.json(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (14)
- GitHub Check: Unit tests (Node 20.11.1)
- GitHub Check: Regression tests (Node 20.11.1, sqlite3)
- GitHub Check: Unit tests (Node 18.12.1)
- GitHub Check: Signup-form tests
- GitHub Check: Regression tests (Node 20.11.1, mysql8)
- GitHub Check: Database tests (Node 20.11.1, sqlite3)
- GitHub Check: Database tests (Node 20.11.1, mysql8)
- GitHub Check: Lint
- GitHub Check: i18n
- GitHub Check: Database tests (Node 18.12.1, mysql8)
- GitHub Check: Ghost-CLI tests
- GitHub Check: Comments-UI tests
- GitHub Check: Admin-X Settings tests
- GitHub Check: Admin tests - Chrome
🔇 Additional comments (4)
.github/scripts/release-apps.js (1)
9-13: LGTM! Configuration mapping follows existing pattern.The new entries for sodo-search and comments-ui follow the same pattern as the existing portal entry, maintaining consistency in the configuration structure.
apps/sodo-search/package.json (1)
36-36: LGTM! Ship script updated to use centralized release process.The ship script now uses the centralized release-apps.js script, aligning with the standardized release process.
apps/comments-ui/package.json (1)
30-30: LGTM! Ship script updated to use centralized release process.The ship script now uses the centralized release-apps.js script, aligning with the standardized release process.
.github/workflows/ci.yml (1)
1142-1276: LGTM! New publish jobs follow existing patterns.The new publish jobs for sodo-search and comments-ui follow the same secure patterns as existing jobs:
- Proper job dependencies
- Version change checks
- Secure npm configuration
- CDN cache purging
ref #22127 The update to the Portal release process has now been tested on main, it would be good to get Search & Comments updated to the same process so that it's easier to reason about releasing all of them.
allouis
force-pushed
the
improve-apps-release
branch
from
b0c792b to
6bc243e
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
apps/comments-ui/package.json (1)
30-30: Streamlined "ship" Script Implementation
The "ship" script now directly calls the centralized release-apps.js command, removing the earlier git status check and version bump logic. This simplification aligns the release process for Comments UI with the updated Portal process. Please verify that any pre-release validations now occur inside release-apps.js and that removal of the "postship" script has no unintended downstream effects..github/workflows/ci.yml (2)
1142-1209: Addition of the Publish @tryghost/sodo-search Job
This new job automates the publishing process for the @tryghost/sodo-search package. It performs a version comparison, conditionally builds the package when a version change is detected, and then publishes the package to npm. Additionally, it purges both the JavaScript and CSS assets from the jsdelivr cache using the extracted current minor version. Please verify that the working directory ("apps/sodo-search") is correctly configured and that the version-check logic reliably detects changes.
1210-1276: Addition of the Publish @tryghost/comments-ui Job
This job introduces an automated workflow for publishing the @tryghost/comments-ui package. It mirrors the logic used in the publish_search job by checking for a version change, building the package if needed, setting up npm credentials, publishing to npm, and purging the jsdelivr cache. Ensure that the working directory ("apps/comments-ui") and environment variable interpolations (such as for "current_minor") are correct, and that the overall job condition reliably restricts publishing to the main branch.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
.github/scripts/release-apps.js(1 hunks).github/workflows/ci.yml(1 hunks)apps/comments-ui/package.json(1 hunks)apps/sodo-search/package.json(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
- .github/scripts/release-apps.js
- apps/sodo-search/package.json
⏰ Context from checks skipped due to timeout of 90000ms (14)
- GitHub Check: Unit tests (Node 20.11.1)
- GitHub Check: Unit tests (Node 18.12.1)
- GitHub Check: Regression tests (Node 20.11.1, sqlite3)
- GitHub Check: Signup-form tests
- GitHub Check: Regression tests (Node 20.11.1, mysql8)
- GitHub Check: Database tests (Node 20.11.1, sqlite3)
- GitHub Check: Lint
- GitHub Check: Database tests (Node 20.11.1, mysql8)
- GitHub Check: i18n
- GitHub Check: Ghost-CLI tests
- GitHub Check: Database tests (Node 18.12.1, mysql8)
- GitHub Check: Admin tests - Chrome
- GitHub Check: Admin-X Settings tests
- GitHub Check: Comments-UI tests
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
apps/comments-ui/README.md (1)
30-32: Clarify Manual JsDelivr Cache Clearing Instructions
The new “JsDelivr cache” section offers helpful guidance for manually clearing the cache when CI does not do it automatically. It would be beneficial to:
- Ensure that the variable
${COMMENTS_UI_VERSION}is clearly documented elsewhere so users know where to find or update it.- Consider providing an example or further context on how to verify the cache has been cleared successfully.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
apps/comments-ui/README.md(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (10)
- GitHub Check: Signup-form tests
- GitHub Check: Ghost-CLI tests
- GitHub Check: Regression tests (Node 20.11.1, sqlite3)
- GitHub Check: Comments-UI tests
- GitHub Check: Database tests (Node 20.11.1, sqlite3)
- GitHub Check: Regression tests (Node 20.11.1, mysql8)
- GitHub Check: Database tests (Node 20.11.1, mysql8)
- GitHub Check: Database tests (Node 18.12.1, mysql8)
- GitHub Check: Admin-X Settings tests
- GitHub Check: Admin tests - Chrome
🔇 Additional comments (2)
apps/comments-ui/README.md (2)
22-22: Streamlined Patch Release Step
The new step “Merge the release commit tomain” provides a clear and concise action for patch releases, ensuring consistency with the updated Portal release process. Please confirm that this new step is coordinated with the rest of the release workflow documentation.
27-27: Streamlined Minor/Major Release Step
Adding “Merge the release commit tomain” as the second step for minor/major releases aligns the process with the patch release flow. Verify that all release-related scripts and documentation reflect this change consistently.
ref #22127
The update to the Portal release process has now been tested on main, it would be good to get Search & Comments updated to the same process so that it's easier to reason about releasing all of them.