Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add @changesets/changelog-github for better changelogs #589

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

turnekybc
Copy link
Contributor

@turnekybc turnekybc commented Apr 10, 2025

Summary & Motivation

With @changesets/changelog-github, it includes GitHub PR and author links if run in CI with a GITHUB_TOKEN.

The new changelog format will look like this:

# my-package

## 1.1.0
### Minor Changes
- Added support for dark mode (#123) via @yourusername

How I Tested These Changes

Did you add a changeset?

If updating one of our packages, you'll likely need to add a changeset to your PR. To do so, run pnpm changeset. pnpm changeset will generate a file where you should write a human friendly message about the changes. Note how this (example) includes the package name (should be auto added by the command) along with the type of semver change (major.minor.patch) (which you should set).

These changes will be used at release time to determine what packages to publish and how to bump their version. For more context see this comment.

Copy link

vercel bot commented Apr 10, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sdk-email-auth ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 11, 2025 4:34pm
sdk-otp-auth ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 11, 2025 4:34pm

Copy link

codesandbox-ci bot commented Apr 10, 2025

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 5e33866:

Sandbox Source
@turnkey/example-react-components Configuration

Copy link

socket-security bot commented Apr 10, 2025

Review the following changes in direct dependencies. Learn more about Socket for GitHub ↗.

Package Supply Chain
Security
Vulnerability Quality Maintenance License
Added@changesets/[email protected]1001006581100

View full report ↗

@turnekybc turnekybc marked this pull request as ready for review April 10, 2025 15:33
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.

1 participant