Skip to content

make_a_release.rst

Latest commit

 

History

History
145 lines (84 loc) · 3.53 KB

make_a_release.rst

File metadata and controls

145 lines (84 loc) · 3.53 KB

Making a release

A core developer should use the following steps to create a release X.Y.Z of CastXML-python-distributions on PyPI.

This is usually done after :ref:`updating_castxml_version`.

Prerequisites

Documentation conventions

The commands reported below should be evaluated in the same terminal session.

Commands to evaluate starts with a dollar sign. For example:

$ echo "Hello"
Hello

means that echo "Hello" should be copied and evaluated in the terminal.

PyPI: Step-by-step

  1. Make sure that all CI tests are passing on AppVeyor, CircleCI and Travis CI.
  2. Download the latest sources
$ cd /tmp && \
  git clone git@github.com:CastXML/CastXML-python-distributions CastXML-python-distributions-release && \
  cd CastXML-python-distributions-release
  1. List all tags sorted by version
$ git fetch --tags && \
  git tag -l | sort -V
  1. Choose the next release version number
$ release=X.Y.Z

Warning

To ensure the packages are uploaded on PyPI, tags must match this regular expression: ^[0-9]+(\.[0-9]+)*(\.post[0-9]+)?$.

  1. In README.md, update PyPI download count after running pypistats overall CastXML and commit the changes.
$ git add README.rst && \
  git commit -m "README: Update download stats"

Note

To learn more about pypistats, see https://pypi.org/project/pypistats/

  1. Tag the release
$ git tag --sign -m "CastXML-python-distributions ${release}" ${release} master

Warning

We recommend using a GPG signing key to sign the tag.

  1. Publish the release tag
$ git push origin ${release}

Note

This will trigger builds on each CI services and automatically upload the wheels and source distribution on PyPI.

  1. Check the status of the builds on AppVeyor, CircleCI and Travis CI.
  2. Once the builds are completed, check that the distributions are available on PyPI.
  3. Create a clean testing environment to test the installation
$ pushd $(mktemp -d) && \
  mkvirtualenv CastXML-${release}-install-test && \
  pip install CastXML && \
  castxml --version

Note

If the mkvirtualenv command is not available, this means you do not have virtualenvwrapper installed, in that case, you could either install it or directly use virtualenv or venv.

  1. Cleanup
$ popd && \
  deactivate  && \
  rm -rf dist/* && \
  rmvirtualenv CastXML-${release}-install-test
  1. Publish master branch
$ git push origin master
⚡