Skip to content

Latest commit

 

History

History
51 lines (36 loc) · 1.54 KB

RELEASE.md

File metadata and controls

51 lines (36 loc) · 1.54 KB

How to make a release

simpervisor 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 CHANGELOG.md with github-activity and continue only when its merged.

  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}
    
    # run
    tbump ${VERSION}

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

  4. Reset the version back to dev, e.g. 1.0.1.dev after releasing 1.0.0.

    tbump --no-tag ${NEXT_VERSION}.dev
  5. Following the release to PyPI, an automated PR should arrive within 24 hours to conda-forge/simpervisor-feedstock with instructions on releasing to conda-forge. You are welcome to volunteer doing this, but aren't required as part of making this release to PyPI.