Skip to main content

Pypi release process

Follow the steps to do a manual release on PyPi.

  • Please confirm that Python 3.11.x with Pipenv is installed and setup on this machine

  • Clone the repo

    git clone https://github.com/chkware/cli.git cli-wheel
  • Change to the directory

    cd cli-wheel
  • Update version number on setup.cfg

    version = 0.X.X
  • Update version number on chk/console/main.py

    """v0.X.X | supported version strings: 0.7.2, ..."""
  • Update docs/CHANGELOG.md with the release 0.X.X information

  • Make directory for local virtualenv setup

    mkdir ./.venv
  • Install all required packages

    pipenv install
  • Install all required packages for build and push to PyPI

    pipenv run pip install -U build twine
  • Use the environment's python to build

    pipenv run python -m build --wheel --sdist
  • Push the packages to PyPi. This setup will require your PyPi username and password. So, make sure to setup an account, and have permission to push setup ready on the chk package repository.

    pipenv run twine upload dist/*
  • Publish and push an annotated tag

    git tag -a v0.X.X -m "..."
    git push -u origin v0.X.X
  • [OPTIONAL][build a zipapp](/docs/setup/build-zipapp), and release a version

A new version is release.