Skip to content

📖 Document new package steps for developers and add changeset validation to PRs#2734

Merged
rowanc1 merged 7 commits intojupyter-book:mainfrom
choldgraf:doc/new-package
Mar 10, 2026
Merged

📖 Document new package steps for developers and add changeset validation to PRs#2734
rowanc1 merged 7 commits intojupyter-book:mainfrom
choldgraf:doc/new-package

Conversation

@choldgraf
Copy link
Collaborator

@choldgraf choldgraf commented Mar 3, 2026

Two quick things:

  • Documents what to do if a new package needs to be published as part of the release process
  • Adds an npx changeset test to our CI so that malformed changesets would break

I added a bad changeset to see if this fails

@changeset-bot
Copy link

changeset-bot bot commented Mar 3, 2026

⚠️ No Changeset found

Latest commit: 266d1ed

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

@changeset-bot
Copy link

changeset-bot bot commented Mar 3, 2026

⚠️ No Changeset found

Latest commit: 862b74a

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

@rowanc1 rowanc1 added the documentation Improvements or additions to documentation label Mar 3, 2026
2. **Set the version to `0.0.0`** in the package's `package.json`. Changesets will overwrite this on the first automated release.
3. **Publish the package** manually with public access:
```shell
npm publish --access=public
Copy link
Collaborator

Choose a reason for hiding this comment

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

There's no token or anything needed for this step?

Copy link
Member

Choose a reason for hiding this comment

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

You will need to be logged in, yes.

npm publish --access=public
```
4. **Set up trusted publishing** in the NPM admin so that GitHub Actions can publish future releases automatically.
5. **Add `ebp-bot` as a maintainer** on the NPM package page. This is not needed if the package belongs to a team (e.g., `@myst-theme`).
Copy link
Collaborator

Choose a reason for hiding this comment

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

What does this statement mean?

Copy link
Member

Choose a reason for hiding this comment

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

ebp-bot is the username.

Co-authored-by: Stefan van der Walt <stefan@mentat.za.net>
@rowanc1
Copy link
Member

rowanc1 commented Mar 10, 2026

Updated based on @stefanv's feedback. Thanks @choldgraf.

@rowanc1 rowanc1 changed the title Document new package steps for developers and add changeset validation to PRs 📖 Document new package steps for developers and add changeset validation to PRs Mar 10, 2026
@rowanc1 rowanc1 merged commit b7d8011 into jupyter-book:main Mar 10, 2026
7 of 8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants