Skip to content

ci: pass new tag to release notes generator script - #3247

Merged
trueberryless merged 1 commit into
npmx-dev:mainfrom
trueberryless:ci/pass-to-tag
Sep 12, 2026
Merged

trueberryless merged 1 commit into
npmx-dev:mainfrom
trueberryless:ci/pass-to-tag

Conversation

@trueberryless

Copy link
Copy Markdown
Member

🔗 Linked issue

🧭 Context

I noticed that release notes generated by our script include the compare link from the previous release to HEAD instead of the new tag. This makes those links misleading if new releases come in because the compare link always shows the diff to the current main branch.

📚 Description

This PR fixes this by passing the new tag to the release notes generator script so it can use it in the release notes markdown heading and compare link, which makes those links always correct. This is also how @serhalp and I created the releases 0.19.0, 0.6.0, and 0.5.0 manually.

@vercel

vercel Bot commented Sep 12, 2026 •

Copy link
Copy Markdown
Contributor

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
npmx.dev Ready Ready Preview Sep 12, 2026 10:26pm UTC
2 Skipped Deployments
Project Deployment Actions Updated
docs.npmx.dev Ignored Ignored Preview Sep 12, 2026 10:26pm UTC
npmx-lunaria Ignored Ignored Sep 12, 2026 10:26pm UTC

Request Review

@coderabbitai

coderabbitai Bot commented Sep 12, 2026 •

Copy link
Copy Markdown
Contributor

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: 300a5b96-4e4f-49f3-a759-f60320a3efc2

📥 Commits

Reviewing files that changed from the base of the PR and between 955a47b and 3b62a8d.

📒 Files selected for processing (1)
  • .github/workflows/release-tag.yml

Included review availability: Your plan provides up to 8 included reviews per hour; 7 remain after this review.


📝 Summary

Summary by CodeRabbit

  • Chores
    • Updated the release-note generation workflow to use both previous and next version references when preparing release notes.

Walkthrough

The release workflow now passes both the previous and next version tags to scripts/release-notes.ts.

Changes

Release note generation

Layer / File(s) Summary
Pass both release references
.github/workflows/release-tag.yml
The release-notes step sets TO_REF to the next version tag and passes both FROM_REF and TO_REF to the script.

Priority: ⬇️ Low

Merge Risk: ⚪ Minimal · up to 3b62a

The release workflow now passes both release references correctly, so release comparisons should remain accurate.

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Description check ✅ Passed The description clearly explains the release workflow change and its effect on release-note compare links.
Title check ✅ Passed The title is concise, specific, and accurately describes the CI change to pass the new tag to the release-note generator.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

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

@codecov

codecov Bot commented Sep 12, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.

📢 Thoughts on this report? Let us know!

@trueberryless
trueberryless added this pull request to the merge queue Sep 12, 2026
Merged via the queue into npmx-dev:main with commit 78a364a Sep 12, 2026
25 checks passed
@trueberryless
trueberryless deleted the ci/pass-to-tag branch September 12, 2026 22:47

This branch was successfully deployed

1 active deployment
Preview – npmx.dev — 3b62a8dc Deployed Sep 12, 2026 by vercel[bot]
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