docs(SUP-1648): add v0.1 release process - #36
Conversation
|
Warning Rate limit exceeded
You’ve run out of usage credits. Purchase more in the billing tab. ⌛ 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. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughThe PR establishes jarvOS's release infrastructure by introducing standardized release documentation (template, process guide, and v0.1.0 notes), updating the changelog, and implementing an automated release-readiness validation script that checks version format, required documentation, git state, and smoke tests. ChangesRelease Infrastructure Setup
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested labels
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
docs/release-process.md (1)
18-19: ⚡ Quick winGeneralize version-specific checklist commands.
Line 18/19 and Line 35/39 hardcode
v0.1.0; this process doc will age quickly after the first release. Use<version>placeholders (and one concrete example) so future releases don’t copy stale commands/paths.♻️ Proposed doc update
-5. Prepare the GitHub Release notes at `docs/releases/v0.1.0.md` using `.github/release-template.md`. +5. Prepare the GitHub Release notes at `docs/releases/v<version>.md` using `.github/release-template.md`. - git tag v0.1.0 - git push origin v0.1.0 + git tag v<version> + git push origin v<version> -9. Publish a GitHub Release using `docs/releases/v0.1.0.md`. +9. Publish a GitHub Release using `docs/releases/v<version>.md`.Also applies to: 35-39
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/release-process.md` around lines 18 - 19, Replace all hardcoded "v0.1.0" occurrences in the release process steps with a generic "<version>" placeholder and add a single concrete example command showing how to substitute it (e.g., example: "<version> = v0.1.0") so maintainers know how to use it; update the two places that mention the release notes path and commands (the reference to docs/releases/v0.1.0.md and any commands that use that path) to use docs/releases/<version>.md and similarly parameterize any CLI commands or paths in the later block (the second block around lines 35-39) so future releases don't require editing the doc text.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@scripts/release-readiness-check.js`:
- Around line 97-105: The script calls readText('CHANGELOG.md') unguarded which
will throw if the file is missing; wrap the read and parsing logic (the readText
call that sets the changelog variable and the subsequent changelog.match into
changelogHeading) in a try/catch or pre-check for file existence and on error
call fail('CHANGELOG.md missing or unreadable', `Could not read CHANGELOG.md:
${error.message}`) (or similar) instead of letting the process crash, then
return/exit so later calls to pass/fail for changelogHeading aren't executed;
ensure you reference readText, changelog, changelogHeading, tag and
opts.allowUnreleased when adding the guard.
- Around line 132-148: The git command results (tagCheck, status, tracked from
run(...)) currently only inspect .status and treat null status as success;
update each block to first check for a non-null result.error (e.g., if
(tagCheck.error) fail('git tag preflight', `git not found:
${tagCheck.error.message}`)) and return/fail early, then proceed to check
tagCheck.status === 0, status.error, tracked.error similarly; ensure messages
include the underlying error.message so missing Git (ENOENT) is reported instead
of incorrectly passing (apply this change to the tagCheck, status, and tracked
handling).
---
Nitpick comments:
In `@docs/release-process.md`:
- Around line 18-19: Replace all hardcoded "v0.1.0" occurrences in the release
process steps with a generic "<version>" placeholder and add a single concrete
example command showing how to substitute it (e.g., example: "<version> =
v0.1.0") so maintainers know how to use it; update the two places that mention
the release notes path and commands (the reference to docs/releases/v0.1.0.md
and any commands that use that path) to use docs/releases/<version>.md and
similarly parameterize any CLI commands or paths in the later block (the second
block around lines 35-39) so future releases don't require editing the doc text.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: d3554f5f-c11a-44d5-baa8-d572203b4adf
📒 Files selected for processing (6)
.github/release-template.mdCHANGELOG.mddocs/release-process.mddocs/releases/v0.1.0.mdpackage.jsonscripts/release-readiness-check.js
Summary
Verification
Part of SUP-1648.
Summary by CodeRabbit
Documentation
Chores