Skip to content

Latest commit

 

History

History
50 lines (37 loc) · 1.58 KB

RELEASE.md

File metadata and controls

50 lines (37 loc) · 1.58 KB

Making an NBConvert Release

Using jupyter_releaser

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.
    • You can usually use the following values for the workflow:
      • branch : 'main' when releasing from the main branch
      • "Post Version Specifier" empty unless you do a beta or rc release
      • keep since_last_stable unchecked
      • "Use PRs with activity since this date or git reference"
  • Review the changelog in the draft GitHub release created in Step 1.
    • You will need the URL to the created draft release in the form https://github.com/jupyter/nbconvert/releases/tag/<something>-<some-numbers> for next step.
  • Run the "Step 2: Publish Release" workflow to finalize the release.

Manual Release

To create a manual release, perform the following steps:

Set up

pip install pipx
git pull origin $(git branch --show-current)
git clean -dffx

Update the version and apply the tag

echo "Enter new version"
read new_version
pipx run hatch version ${new_version}
git tag -a ${new_version} -m "Release ${new_version}"

Build the artifacts

rm -rf dist
pipx run build .

Publish the artifacts to pypi

pipx run twine check dist/*
pipx run twine upload dist/*