use changesets by boneskull · Pull Request #3070 · endojs/endo

boneskull · 2026-02-02T22:08:45Z

Overview

This PR adopts Changesets for versioning and releasing.

Changesets are a solution to the problem of versioning and updating release notes. Unlike other solutions which generate release notes from Conventional Commits, Changesets do not prescribe a commit message format and provide more granular control over the contents of release notes. Instead, it keeps information about versions and release notes in a temporary file-based "database". These files are committed to version control, then "flushed" upon release.

Adding Changesets

To add a Changeset to your PR, you'll interface with @changesets/cli, which will ask you to choose whether the Changeset represents a patch, minor, or major version bump. It will also ask you to provide a changelog entry. That entry replaces our current convention for updating a NEWS.md file.

Once complete, you'll be reminded to commit the Changeset (which will be a unique .md file in .changeset/), which you'll then push up to your PR.

Note

Changesets don't need their own commit.
Not all PRs need changesets--only those which impact the end user.
changeset-bot will automatically detect Changesets (or the lack thereof) and comment on any PR containing them with info about the version bump and the contents of the Changelog entry.

Releasing

The Changesets Release Action runs after every push to master. It creates and maintains a PR which uses the Changeset files it finds to bump packages and update CHANGELOG.md files. Once merged, this PR will create appropriate tags for all updated packages & GitHub Releases for each tag.

Publishing

To publish to npm, a maintainer will pull down the changes, then publish via lerna publish from-package or laverna (depending; see "MAYBE TODO" below).

TODO

An incomplete list of TODOs:

Strongly recommend installing changeset-bot to automatically nag contributors to create Changesets and display information about Changesets it detects. This requires it to be added to the Endo org, however.
Update CONTRIBUTING.md to reflect the new processes.
We likely need to enable Allow GitHub Actions to create and approve pull requests in the Actions settings

MAYBE TODO

This work could be in this PR, or in a subsequent PR.

Replace lerna with @lavamoat/laverna. Since lerna will no longer handle versioning, it would only provide lerna publish from-package ... which happens to be exactly the thing @lavamoat/laverna provides. If we do this in a separate PR, we'll likely incur another change to the publishing workflow (even if slight). I could go either way on this.

boneskull · 2026-02-02T23:04:50Z

.changeset/config.json

+  "$schema": "https://unpkg.com/@changesets/config@3.1.2/schema.json",
+  "access": "public",
+  "baseBranch": "master",
+  "bumpVersionsWithWorkspaceProtocolOnly": true,


This assumes we're using those odious workspace:^ version entries everywhere we should.

boneskull · 2026-02-02T23:05:31Z

.changeset/config.json

+  "changelog": [
+    "@changesets/changelog-github",
+    {
+      "repo": "endojs/endo"
+    }
+  ],


If we don't like this, it's pretty trivial to write our own changelog-generating plugin.

boneskull · 2026-02-02T23:06:21Z

.changeset/config.json

+      "repo": "endojs/endo"
+    }
+  ],
+  "commit": false,


This means "don't automatically commit after adding a Changeset". If enabled, we can specify what the commit message should look like. I don't have an opinion about this.

boneskull · 2026-02-02T23:08:32Z

.changeset/config.json

+  "privatePackages": {
+    "tag": true,
+    "version": true
+  },


we have a lot of private packages. I figure we want to version and tag them and add release notes like any other (why not?).

boneskull · 2026-02-02T23:09:44Z

.changeset/config.json

+    "tag": true,
+    "version": true
+  },
+  "updateInternalDependencies": "patch"


boneskull · 2026-02-02T23:10:42Z

.changeset/config.json

+  "baseBranch": "master",
+  "bumpVersionsWithWorkspaceProtocolOnly": true,
+  "changelog": [
+    "@changesets/changelog-github",


this changelog-generator plugin adds references to GitHub PRs, commits, etc. the default generator does not.

boneskull · 2026-02-02T23:13:00Z

.github/workflows/release.yml

+permissions:
+  contents: write
+  pull-requests: write


I think this is sufficient.

kriskowal

Exciting. Let’s give this a hearing at the Endo meeting and move toward a first release with this process soon.

changeset-bot · 2026-02-04T00:15:31Z

⚠️ No Changeset found

Latest commit: c38e716

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

kriskowal · 2026-02-04T00:48:27Z

.github/workflows/release.yml

+on:
+  push:
+    branches:
+      - master


Does this mean we’re going to always have a release PR ready to go?

Not always, but as long as there are changesets sitting in .changeset/.

kriskowal · 2026-02-04T00:48:41Z

.github/workflows/release.yml

+      - name: Install Dependencies
+        run: yarn
+
+      - name: Create Release Pull Request


Create or create and update?

boneskull · 2026-02-04T23:53:20Z

We'll have to stick with lerna until We implement support for workspace:^ when publishing.

Ref: LavaMoat/LavaMoat#1883

boneskull self-assigned this Feb 2, 2026

boneskull added technical-debt tooling github_actions Pull requests that update GitHub Actions code labels Feb 2, 2026

boneskull force-pushed the boneskull/changesets branch from 316be6d to 3a10de7 Compare February 2, 2026 22:40

boneskull requested review from kriskowal and naugtur February 2, 2026 23:04

boneskull commented Feb 2, 2026

View reviewed changes

chore(ci): initialize changesets

73f6663

boneskull force-pushed the boneskull/changesets branch from 3a10de7 to 845e07b Compare February 2, 2026 23:07

boneskull commented Feb 2, 2026

View reviewed changes

.changeset/config.json

"tag": true,

"version": true

},

"updateInternalDependencies": "patch"

Copy link

Member Author

boneskull Feb 2, 2026

Choose a reason for hiding this comment

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

see docs

boneskull commented Feb 2, 2026

View reviewed changes

chore(ci): add Release workflow

a858b45

boneskull force-pushed the boneskull/changesets branch from 845e07b to a858b45 Compare February 2, 2026 23:12

boneskull commented Feb 2, 2026

View reviewed changes

kriskowal reviewed Feb 3, 2026

View reviewed changes

boneskull added 2 commits February 3, 2026 16:15

chore: add publish:npm script to package.json

9e2d973

docs(CONTRIBUTING): rewrite versioning/releasing section

c38e716

boneskull marked this pull request as ready for review February 4, 2026 00:16

kriskowal reviewed Feb 4, 2026

View reviewed changes

kriskowal approved these changes Feb 4, 2026

View reviewed changes

Conversation

boneskull commented Feb 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Overview

Adding Changesets

Releasing

Publishing

TODO

MAYBE TODO

Uh oh!

boneskull Feb 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kriskowal left a comment

Choose a reason for hiding this comment

Uh oh!

changeset-bot bot commented Feb 4, 2026

⚠️ No Changeset found

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

boneskull commented Feb 4, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

boneskull commented Feb 2, 2026 •

edited

Loading

boneskull Feb 2, 2026 •

edited

Loading