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"
- You can usually use the following values for the workflow:
- 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.
- You will need the URL to the created draft release in the form
- Run the "Step 2: Publish Release" workflow to finalize the release.
To create a manual release, perform the following steps:
pip install pipx
git pull origin $(git branch --show-current)
git clean -dffx
echo "Enter new version"
read new_version
pipx run hatch version ${new_version}
git tag -a ${new_version} -m "Release ${new_version}"
rm -rf dist
pipx run build .
pipx run twine check dist/*
pipx run twine upload dist/*