Skip to content

docs: add release documentation and LICENSE [4/4] - #46

Merged
wyattjoh merged 2 commits into
mainfrom
wyattjoh/release-docs
Mar 25, 2026
Merged

docs: add release documentation and LICENSE [4/4]#46
wyattjoh merged 2 commits into
mainfrom
wyattjoh/release-docs

Conversation

@wyattjoh

@wyattjoh wyattjoh commented Mar 20, 2026

Copy link
Copy Markdown
Contributor

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, isPublished checks, 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

Summary by CodeRabbit

  • Documentation

    • Added comprehensive contribution guidelines covering development setup, pre-release installation, and PR workflow.
    • Enhanced README with Installation and Usage sections for the CLI.
    • Added release process documentation.
    • Updated project guidance to reference contribution instructions.
  • Chores

    • Added MIT License file.
    • Packaging now embeds the LICENSE into generated platform packages.

@wyattjoh

Copy link
Copy Markdown
Contributor Author

PR Stack — Supersedes #31

PR Description
1 #43 Monorepo restructure
2 #44 Cross-compile build + smoke tests
3 #45 Release infrastructure (changesets)
4 #46 Release documentation + LICENSE — ← this PR

Review in parallel, merge sequentially 1→2→3→4.
Squash-merge each PR, then rebase the next branch onto the updated base before merging it.

@wyattjoh
wyattjoh marked this pull request as draft March 20, 2026 17:08
@wyattjoh
wyattjoh force-pushed the wyattjoh/release-infra branch from 2bb7c54 to ba9a09c Compare March 20, 2026 17:48
@wyattjoh
wyattjoh force-pushed the wyattjoh/release-docs branch from 0de722e to 09a21fc Compare March 20, 2026 17:48
@wyattjoh

Copy link
Copy Markdown
Contributor Author

PR Stack -- Supersedes #31

PR Description
1 #43 Monorepo restructure (merged)
2 #47 Cross-compile build + smoke tests
3 #45 Release infrastructure (changesets)
4 #46 Release documentation + LICENSE -- ← this PR

Review in parallel, merge sequentially. Squash-merge each PR, retarget the next PR to main before deleting the branch, then rebase.

@wyattjoh
wyattjoh force-pushed the wyattjoh/release-docs branch from 09a21fc to 1a4fb7a Compare March 20, 2026 19:53
@wyattjoh
wyattjoh force-pushed the wyattjoh/release-infra branch from ba9a09c to 0aa883a Compare March 20, 2026 19:54
@wyattjoh
wyattjoh force-pushed the wyattjoh/release-docs branch from 1a4fb7a to bd2b0e6 Compare March 20, 2026 19:59
@wyattjoh
wyattjoh force-pushed the wyattjoh/release-infra branch from 0aa883a to 51be70a Compare March 20, 2026 19:59
@wyattjoh
wyattjoh force-pushed the wyattjoh/release-docs branch from bd2b0e6 to 94c3027 Compare March 20, 2026 20:01
@wyattjoh
wyattjoh force-pushed the wyattjoh/release-infra branch from 51be70a to 2b7f7c7 Compare March 20, 2026 20:01
@wyattjoh
wyattjoh force-pushed the wyattjoh/release-docs branch from 94c3027 to 0d8287d Compare March 20, 2026 20:18
@wyattjoh
wyattjoh force-pushed the wyattjoh/release-infra branch from 2b7f7c7 to d849ce6 Compare March 20, 2026 20:18
wyattjoh added a commit that referenced this pull request Mar 20, 2026
- 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
@wyattjoh
wyattjoh force-pushed the wyattjoh/release-docs branch 2 times, most recently from d76d44d to 9e33547 Compare March 20, 2026 22:49
wyattjoh added a commit that referenced this pull request Mar 23, 2026
* 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
Base automatically changed from wyattjoh/release-infra to main March 23, 2026 16:47
@wyattjoh
wyattjoh force-pushed the wyattjoh/release-docs branch from 9e33547 to 44c29bc Compare March 23, 2026 16:47
@wyattjoh
wyattjoh marked this pull request as ready for review March 23, 2026 16:48
@coderabbitai

coderabbitai Bot commented Mar 23, 2026

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 631b482b-b8b0-4eb1-a387-f75b21600ce4

📥 Commits

Reviewing files that changed from the base of the PR and between 7110069 and ff18bb3.

📒 Files selected for processing (6)
  • CLAUDE.md
  • CONTRIBUTING.md
  • LICENSE
  • README.md
  • docs/releasing.md
  • scripts/releaser/index.ts

📝 Walkthrough

Walkthrough

Added 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 npm install -g clerk). Updated scripts/releaser to copy the repository LICENSE into each generated platform package. Added a cross-reference to CONTRIBUTING.md in CLAUDE.md.

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the pull request as adding release documentation and a LICENSE file, and the [4/4] notation clearly contextualizes it as the final part of a multi-PR stack.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between a2c0cc5 and 7110069.

📒 Files selected for processing (6)
  • CLAUDE.md
  • CONTRIBUTING.md
  • LICENSE
  • README.md
  • docs/releasing.md
  • scripts/releaser/index.ts

Comment thread scripts/releaser/index.ts
Add docs/releasing.md covering the full release flow, channels, and
safeguards. Update README with current help output. Add MIT license.
@wyattjoh
wyattjoh force-pushed the wyattjoh/release-docs branch from 7110069 to ff18bb3 Compare March 25, 2026 15:49
@wyattjoh
wyattjoh enabled auto-merge (squash) March 25, 2026 15:49
@wyattjoh
wyattjoh merged commit 5aa7be1 into main Mar 25, 2026
3 checks passed
@wyattjoh
wyattjoh deleted the wyattjoh/release-docs branch March 25, 2026 15:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants