RELEASING.md

Releasing

Prerequisites

• If you have a schema version change, you need to bump the schema version manually: First copy nbformat/v4/nbformat/.v4.schema.json to nbformat/v4/nbformat/.v4.<new_minor_version_here>schema.json. Then edit the top of nbformat/v4/nbbase.py:

  # Change the nbformat_minor and nbformat_schema variables when incrementing the
  # nbformat version
  
  # current major version
  nbformat = 4
  
  # current minor version
  nbformat_minor = new_minor_version_here
  
  # schema files for (major, minor) version tuples. (None, None) means the current version
  nbformat_schema = {
      (None, None): "nbformat.v4.schema.json",
      (4, 0): "nbformat.v4.0.schema.json",
      # ...
      (4, new_minor_version_here): "nbformat.v4.<new_minor_version_here>.schema.json",
  }

  If you do one of these steps but not the others it will fail many tests.

Automated Release

The recommended way to make a release is to use jupyter_releaser from this repository.

• Run the "Step 1: Prep Release" workflow with the appropriate inputs.
• Review the changelog in the draft GitHub release created in Step 1.

Manual Release

We use hatch to manage versions.

You must first install pipx (or install hatch itself if you prefer).

To bump versions we use the pipx run hatch version <new_version> command.

To make a release

# Commit, test, publish, beta tag
pipx run hatch version <new_version>
git tag -a <new_version> -m "<new_version>"

git push upstream master
git push upstream --tags

Push to PyPI

rm -rf dist/*
rm -rf build/*
pipx run build .
# Double check the dist/* files have the right version (no `.dev`) and install the wheel to ensure it's good
pip install dist/*
pipx run twine upload dist/*

Push to npm

npm publish

Note for JavaScript developers -- hatch updates the version in package.json.