Skip to content

Add section about NPM package to documentation #2013

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Sep 8, 2025
Merged

Add section about NPM package to documentation #2013

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions docs/source/contribute.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -452,6 +452,31 @@ to prepare for breaking changes associated with the version bump.
For more details, see this [guide on uploading package to
PyPI](https://packaging.python.org/guides/distributing-packages-using-setuptools/#uploading-your-project-to-pypi).

#### BinderHub NPM package release checklist

- update the version number in `js/packages/binderhub-client/package.json` and `js/packages/binderhub-react-components/package.json`
- update/close the `CHANGES.md` for this release (see below)
- create a git tag for the release
- login into NPM
- run

```bash
npm publish -w js/packages/binderhub-client/ --access public
```

and follow the instructions for authentication.

- run

```bash
npm publish -w js/packages/binderhub-react-components/ --access public
```

and follow the instructions for authentication.

- create a new release on https://github.com/jupyterhub/binderhub/releases
- add a new section at the top of the change log for future releases

#### Updating the changelog

As BinderHub does not have a typical semver release schedule, we try to
Expand Down