docs: add release documentation and LICENSE [4/4] - #46
Conversation
|
2bb7c54 to
ba9a09c
Compare
0de722e to
09a21fc
Compare
|
09a21fc to
1a4fb7a
Compare
ba9a09c to
0aa883a
Compare
1a4fb7a to
bd2b0e6
Compare
0aa883a to
51be70a
Compare
bd2b0e6 to
94c3027
Compare
51be70a to
2b7f7c7
Compare
94c3027 to
0d8287d
Compare
2b7f7c7 to
d849ce6
Compare
- Remove LICENSE copy from platform packages (added in PR #46) - Make stable release tag/release creation idempotent (remote-aware tag check, independent release existence check) - Add --clobber to GitHub Release asset uploads for safe reruns - Block snapshot publish on fork PRs to prevent OIDC token exposure - Fix notify-failure to fire even when publish job is skipped
d76d44d to
9e33547
Compare
* feat: add release infrastructure with changesets Add the complete release pipeline: - Changesets for versioning (stable, canary, snapshot channels) - Releaser script for npm publish, git tags, and GitHub Releases - CI workflows for stable/canary releases and PR snapshot comments * fix: harden release infrastructure - Remove LICENSE copy from platform packages (added in PR #46) - Make stable release tag/release creation idempotent (remote-aware tag check, independent release existence check) - Add --clobber to GitHub Release asset uploads for safe reruns - Block snapshot publish on fork PRs to prevent OIDC token exposure - Fix notify-failure to fire even when publish job is skipped * ci: declare Blacksmith runner label for actionlint * ci: reorder check-release before changesets to prevent premature release * ci: add fork guards to snapshot build and smoke-test jobs
9e33547 to
44c29bc
Compare
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (6)
📝 WalkthroughWalkthroughAdded CONTRIBUTING.md with local development, testing, PR, and pre-release installation guidance. Added a top-level LICENSE file containing the MIT license (2026 copyright). Added docs/releasing.md describing stable, canary, and snapshot release flows and tooling. Updated README with Installation and Usage sections (including 🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@scripts/releaser/index.ts`:
- Around line 69-71: The packaging change now copies LICENSE (licensePath /
copyFile) into each platform package but there is no test; add a
unit/integration test that invokes the packaging step (call
generatePlatformPackage or the equivalent function used by the releaser) against
a temporary output location, then assert that each produced package output
(directory or archive for each platform) contains a top-level LICENSE file;
ensure the test creates its own temp workspace, runs the packaging function,
inspects each generated package (extract archive if needed) to check for a file
named "LICENSE", and cleans up after itself.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 1bee525e-0583-43ad-8091-31330d8ac5db
📒 Files selected for processing (6)
CLAUDE.mdCONTRIBUTING.mdLICENSEREADME.mddocs/releasing.mdscripts/releaser/index.ts
Add docs/releasing.md covering the full release flow, channels, and safeguards. Update README with current help output. Add MIT license.
7110069 to
ff18bb3
Compare
Summary
#43, #47, and #45 add a non-trivial release pipeline with three channels, multiple CI workflows, and safeguards that aren't obvious from reading the code alone. Without documentation, contributors won't know how to cut a release, what the channel model is, or what guardrails exist.
This PR adds:
docs/releasing.md-- documents the full release flow end-to-end: the architecture (wrapper + platform packages), all three channels (stable, canary, snapshot) with their triggers and version formats, the versioning workflow via Changesets, and the safeguards built into each step (smoke tests,isPublishedchecks, org membership gating for snapshots).README.md-- updated with current CLI help output reflecting the monorepo commands.LICENSE-- MIT license.Merge instructions
This is the last PR in a 4-PR stack (#43, #47, #45, #46). Squash-merge normally, no rebase needed after.
Test plan
format:check,lint,build,testdocs/releasing.mdfor accuracy against the workflows added in feat: add release infrastructure with changesets [3/4] #45bun run dev -- --helpSummary by CodeRabbit
Documentation
Chores