Manage releases using changesets

[trivikr]

Fixes: #494

The steps maintainers have to take:

• Optional: enable only squash merge on Pull Requests and disable others https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-squashing-for-pull-requests
  • This step is not required, but will keep the commit history clean.
• Enable https://github.com/apps/changeset-bot which will inform contributors to optionally add a changeset in their PRs.
• Create and store npm publish token in GitHub secret NPM_TOKEN

Changesets Action will create a pull request for publishing new version whenever changesets are available.
When the pull request is reviewed and merged, a new GitHub Release will be created and npm version will be published.

[vercel]

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

Name	Status	Preview	Comments	Updated (UTC)
jscodeshift	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 5, 2024 6:19am

[trivikr]

I've copied setup from https://github.com/aws/aws-sdk-js-codemod/releases, a consumer of jscodeshift which has done 150+ releases using changesets.

[Daniel15]

Create and store npm publish token in GitHub secret NPM_TOKEN

Do you know what the security risks are of this approach, and how they can be avoided? How does this play with npm requiring two-factor authentication to publish?

Edit: Also, does this create a GitHub release, or just an npm release? Ideally we'd have both.

[trivikr]

Do you know what the security risks are of this approach, and how they can be avoided?

The Chsngeset Action will have access to NPM and GitHub tokens to do the releases.
It's downloaded 800K times weekly which helps gaining trust https://npmtrends.com/@changesets/cli

How does this play with npm requiring two-factor authentication to publish?

At aws-sdk-js-codemod, we use npm automation token for publishing.

Also, does this create a GitHub release

Yes. The aws-sdk-js-codemod for reference:

• GitHub Release https://github.com/aws/aws-sdk-js-codemod/releases/tag/v2.3.1
• npm release https://www.npmjs.com/package/aws-sdk-js-codemod/v/2.3.1

[trivikr]

@Daniel15 Are there other open questions about using changesets, or the extra actions maintainers have to take?

[Daniel15]

Sorry - I replied to this via email but it looks like it never posted. I should be able to get some time to look into this later this week 😄

In particular, I'll have to see if we're allowed to store npm tokens in GitHub secrets, since it introduces a new attack vector.

[Daniel15]

Enable github.com/apps/changeset-bot which will inform contributors to optionally add a changeset in their PRs.

I'm still trying to figure out how to properly do this. I want to install pkg.pr.new too. GitHub's UI seems buggy and doesn't properly send the app installation request to the admins.

[Daniel15]

I finally got pkg.pr.new GitHub app approved so now I'm attempting again to get this one approved.

[trivikr]

Looks like v17.1.0 published artifacts which did not remove temp dependency, breaking consumers.
Details in #638

That's another reason to switch to automated publish mechanism like changesets done in this PR.

[Daniel15]

@trivikr I'm looking into this now that the GitHub changesets app was approved by the Meta open-source team yesterday. I think I've done all the steps correctly - installed the app and created an NPM_TOKEN. how do we ensure it's working? Do I need to merge this PR before we can test it?

[trivikr]

I tested changesets on aws-sdk-js-codemod by merging the code, and releasing a patch version.

The app will post comment on PRs as soon as they're posted. If a changeset is added, it'll provide details on which new version will be released. If no changeset is present, it'll request author to add one.

PRs without changeset will not update the CHANGELOG. When there are unreleased changesets, a PR will get created clubbing all the unreleased changesets. A new version will be released when that PR is merged.

[trivikr]

For jscodeshift, we can try releasing v17.1.2 or v17.2.0 using changeset whenever new changes are ready.

We can consider releasing a prerelease version too using changesets by going through their documentation. I haven't tried it before.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 0169599

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

[pkg-pr-new]

Open in Stackblitz

yarn add https://pkg.pr.new/[email protected]

commit: 0169599

[trivikr]

Changeset Bot is working, and it posted message on this PR #625 (comment)

@Daniel15 I can add a changeset message for this PR, if you want to test releasing v17.1.2 using changesets.

[Daniel15]

Great, let's merge this and test with new PRs.