Release process

Before release

Check versions

  • Update requirements*.txt (use pip list -o).
  • Make sure that setup.py has proper requirements.
  • Check .travis.yaml.
  • Check tox.ini.
  • Check NEWEST_PYTHON, NEWEST_DJANGO and NEWEST_CRYPTOGRAPHY in test_settings.py.
  • Update VERSION and __version__ in ca/django_ca/__init__.py (see PEP 440).
  • Update version parameter in setup.py.

Other tasks

  • Check if any version of a dependency is no longer supported and we can depcreate support for it:
  • Make sure that setup.py has proper classifiers.
  • Make sure that docs/source/changelog.rst is up to date.

Run testsuite

  • Check code quality (python dev.py code-quality).
  • Check test coverage (python dev.py coverage).
  • Make sure that python dev.py docker-test runs through.
  • Make sure that tox runs through for all environments.

Test demo

Make sure that the demo works:

rm -rf ca/db.sqlite3 ca/files/
./dev.py init-demo

# test commands from the output:
openssl verify -CAfile...

Test admin interface

  • Check if the output of CAs and certs look okay.
  • Check if the profile selection when creating a certificate works.

Docker image

Create a docker image:

docker build --no-cache -t django-ca-dev .
docker run --rm -d --name=django-ca-dev -p 8000:8000 django-ca-dev
docker exec -it django-ca-dev python ca/manage.py createsuperuser
docker exec -it django-ca-dev python ca/manage.py init_ca \
   example /C=AT/ST=Vienna/L=Vienna/O=Org/CN=ca.example.com

… and browse http://localhost:8000/admin.

Release process

  • Push the last commit and make sure that Travis and Read The Docs are updated.

  • Tag the release: git tag -s $version

  • Push the tag: git push origin --tags

  • Create a release on GitHub.

  • Create package for PyPi: python setup.py sdist bdist_wheel.

  • Upload package to PyPi: twine upload dist/*

  • Tag and upload the docker image (note that we create a image revision by appending -1):

    docker tag django-ca-dev mathiasertl/django-ca
docker tag django-ca-dev mathiasertl/django-ca:$version
docker tag django-ca-dev mathiasertl/django-ca:$version-1
docker push mathiasertl/django-ca:$version-1
docker push mathiasertl/django-ca:$version
docker push mathiasertl/django-ca

After a release

  • Update VERSION and __version__ in ca/django_ca/__init__.py to the next development release (see PEP 440).
  • Update version in setup.py.
  • Drop support for older software versions in .travis.yml, tox.ini and dev.py docker-test.
  • Remove files in dist: rm -rf dist/*