Skip to content

Latest commit

 

History

History
66 lines (47 loc) · 2.08 KB

RELEASE.md

File metadata and controls

66 lines (47 loc) · 2.08 KB

How to make a release

jupyter-server-proxy is a package available on PyPI and conda-forge. These are instructions on how to make a release.

Pre-requisites

Steps to make a release

  1. Create a PR updating labextension/yarn.lock and continue only when its merged.

    This helps us avoid leaving known vulnerabilities are unfixed. To do this, delete the file and manually perform the the build dist step in the .github/workflows/publish.yaml workflow's build job as summarized below.

    # git clean -xfd can be needed to ensure labextension/yarn.lock
    # gets re-created during pyproject-build
    rm labextension/yarn.lock
    
    pip install --upgrade pip build
    pyproject-build
  2. Create a PR updating docs/source/changelog.md with github-activity and continue only when its merged.

  3. Checkout main and make sure it is up to date.

    git checkout main
    git fetch origin main
    git reset --hard origin/main
  4. Update the version, make commits, and push a git tag with tbump.

    pip install tbump
    tbump --dry-run ${VERSION}
    
    # run
    tbump ${VERSION}

    Following this, the CI system will build and publish a release.

  5. Reset the version back to dev, e.g. 4.0.1-0.dev after releasing 4.0.0.

    tbump --no-tag ${NEXT_VERSION}-0.dev
  6. Following the release to PyPI, an automated PR should arrive to conda-forge/jupyter-server-proxy-feedstock with instructions.