Skip to content

feat(release): prepare clerk 1.0.0 release#199

Merged
wyattjoh merged 3 commits intomainfrom
wyattjoh/release-clerk-1-0-0
Apr 21, 2026
Merged

feat(release): prepare clerk 1.0.0 release#199
wyattjoh merged 3 commits intomainfrom
wyattjoh/release-clerk-1-0-0

Conversation

@wyattjoh
Copy link
Copy Markdown
Contributor

@wyattjoh wyattjoh commented Apr 21, 2026

Summary

  • add a major changeset so the next version-packages PR resolves to clerk@1.0.0
  • remove the stray release-process test changeset and add version-specific v1.0.0 GitHub release intro notes
  • update the stable releaser to prepend checked-in release intro text ahead of GitHub autogenerated notes
  • document the release-note source in docs/releasing.md and remove the stale open-questions footer from README.md
  • the currently open version-packages PR still targets 0.9.0; after this branch lands, Changesets should update/regenerate that PR to 1.0.0
  • stable GitHub release notes still use --generate-notes; this change only prepends .github/release-notes/vX.Y.Z.md when present

Test plan

  • bun test scripts/lib/release-notes.test.ts
  • bunx tsc --noEmit -p scripts/tsconfig.json
  • bun x changeset status --verbose
  • Confirm the next version-packages PR regenerates to clerk@1.0.0

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Apr 21, 2026

🦋 Changeset detected

Latest commit: 5c23f12

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
clerk Major

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@wyattjoh wyattjoh force-pushed the wyattjoh/release-clerk-1-0-0 branch from cccdec1 to e6a4fc0 Compare April 21, 2026 20:47
@wyattjoh wyattjoh force-pushed the wyattjoh/release-clerk-1-0-0 branch from e6a4fc0 to 7e56523 Compare April 21, 2026 21:08
@wyattjoh wyattjoh marked this pull request as ready for review April 21, 2026 21:17
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 21, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 0841cad8-7a25-4d90-ae26-5fa070278f50

📥 Commits

Reviewing files that changed from the base of the PR and between e83f30e and 5c23f12.

📒 Files selected for processing (3)
  • scripts/lib/release-notes.test.ts
  • scripts/lib/release-notes.ts
  • scripts/releaser.ts
🚧 Files skipped from review as they are similar to previous changes (1)
  • scripts/lib/release-notes.test.ts

📝 Walkthrough

Walkthrough

Adds infrastructure to support prepending custom stable release intros for GitHub releases and applies it to publish a clerk CLI v1.0.0 release. New files: a release-notes utility (scripts/lib/release-notes.ts) with tests, a release-notes markdown for v1.0.0, and a changeset declaring the 1.0.0 bump. The releaser script now uses the utility to compute gh release create arguments and optionally include a notes file. Removes a test changeset and the README "Open Questions" section, and documents the stable release notes workflow in docs/releasing.md.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~22 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 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 (4 passed)
Check name Status Explanation
Title check ✅ Passed The title 'feat(release): prepare clerk 1.0.0 release' directly and clearly describes the main objective of the changeset: preparing for the 1.0.0 release by adding the major changeset, updating release infrastructure, and documentation.
Description check ✅ Passed The description is comprehensive and directly related to the changeset, covering all major changes including the major changeset addition, release notes infrastructure updates, documentation changes, and test plan.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ 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.

Collapse the two places that derived the release-notes path (the lib
and the releaser call site) into a single return value. The caller now
logs whatever path the lib reports it used, so the filename convention
lives in one module. Also drops the now-unused `stableReleaseNotesPath`
export and scopes the test's `tempDir` to the describe block that uses
it.
@wyattjoh
Copy link
Copy Markdown
Contributor Author

Stack: wyattjoh/release-clerk-1-0-0

Part of a stacked PR chain. Do not merge manually.

Copy link
Copy Markdown
Contributor

@rafa-thayto rafa-thayto left a comment

Choose a reason for hiding this comment

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

LGTM

@wyattjoh wyattjoh merged commit 8e3caff into main Apr 21, 2026
10 checks passed
@wyattjoh wyattjoh deleted the wyattjoh/release-clerk-1-0-0 branch April 21, 2026 23:04
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