Skip to content

Release procedure

John McGehee edited this page Oct 2, 2016 · 24 revisions

This article shows developers how to prepare a release for pyfakefs. Ordinary users will not be interested in this article.

The pyfakefs package is released on PyPi.

Procedure

Decide a new version "M.mm" according to semantic versioning.

Clone or pull pyfakefs to your local computer. Check out a new branch version-M.mm.

Edit pyfakefs/fake_filesystem.py attribute __version__ with the new version number.

Run the tests:

./all_tests.py

Git add, commit. Tag the commit with the version:

git tag vM.mm    # Where M.mm is your version

If you have to re-do the above, move the tag to the new commit using the -f flag:

git tag -f vM.mm    # Where M.mm is your version

, push your branch to GitHub

Go to the pyfakefs project on github.com. Create a Pull Request for your release branch.

Wait until Travis says your pull request passes the tests.

Returning to your local computer. Following this article on releasing to PyPi, test release your release:

python setup.py register -r pypitest
python setup.py sdist upload -r pypitest

You should get no errors, and should also now be able to see your library in the test PyPI repository.

Once you've successfully uploaded to PyPI Test, perform the same steps but point to the live PyPI server instead. To register, run:

python setup.py register -r pypi
python setup.py sdist upload -r pypi

Check that pyfakefs is now live on PyPi.

Clone this wiki locally