add @changesets/changelog-github for better changelogs #589
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ |
|
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 16fbce8:
|
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
turnekybc
force-pushed
the
bc-update-changelog
branch
from
7b9808b to
593cda1
Compare
andrewkmin
reviewed
Apr 14, 2025
.github/workflows/release.yml
Outdated
| uses: changesets/action@06245a4e0a36c064a573d4150030f5ec548e4fcc # v1.4.10 | ||
| with: | ||
| version: pnpm run changeset version # Updates versions and changelog | ||
| # publish: pnpm run changeset publish # Publishes to npm |
There was a problem hiding this comment.
Do we want to do anything with this comment?
There was a problem hiding this comment.
updated this to be used in the publish flow
.github/workflows/release.yml
Outdated
| # publish: pnpm run changeset publish # Publishes to npm | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # For changelog links | ||
| # NPM_TOKEN: ${{ secrets.NPM_TOKEN }} # For npm publish |
There was a problem hiding this comment.
updated this to be used in the publish flow
turnekybc
force-pushed
the
bc-update-changelog
branch
from
5e33866 to
0321b4a
Compare
turnekybc
force-pushed
the
bc-update-changelog
branch
from
8fc32db to
833f930
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary & Motivation
Created a release workflow via GitHub Action which will
@turnkey/sdk-typesfor the time being as we test the workflowenvironment: productionflag will pause the workflow at the publish step and will require a manual approval before performing the actual publish stepWith @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:
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 changesetwill 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.