Skip to content

Latest commit

 

History

History
49 lines (33 loc) · 1.21 KB

RELEASE.md

File metadata and controls

49 lines (33 loc) · 1.21 KB

How to make a release

autodoc-traits is a package available on PyPI. These are instructions on how to make a release.

Pre-requisites

Steps to make a release

  1. Create a PR updating CHANGELOG.md with github-activity and continue only when its merged.

    pip install github-activity
    
    github-activity --heading-level=3 jupyterhub/autodoc-traits
  2. Checkout main and make sure it is up to date.

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

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

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

  4. Reset the version back to dev, e.g. 2.1.0.dev after releasing 2.0.0

    tbump --no-tag ${NEXT_VERSION}.dev