console
Run these steps when you begin to create a new release:
- Double-check that the changelog is up to date.
- Update requirements in
requirements*.txt
andpyproject.toml
(usepip list -o
). - Check versions of major software dependencies and:
- Update
[django-ca.release]
inpyproject.toml
with current minor versions. - Add a deprecation notice for versions no longer supported upstream.
- Update
- Run
./dev.py validate state
and fix any errors. - Update version in
ca/django_ca/__init__.py
.
Create a file with pinned requirements, so that users can reliably reproduce a setup:
$ ./dev.py pin-requirements
- Verify that
docker-compose.yml
uses up-to-date version of 3rd-party containers. - Set the default django-ca version in
docker-compose.yml
to the new version. - Update table in
docs/source/quickstart_docker_compose.rst
.
- Make sure that
tox
runs through for all environments. - Make sure that
./dev.py docker-test
runs through. - Push the last commit and make sure that GitHub actions and Read The Docs run through.
Make sure that the demo works and test the commands from the output (manage.py runserver
should obviously be run in a separate shell):
$ ./dev.py clean
$ ./dev.py init-demo
$ python ca/manage.py runserver
$ openssl verify -CAfile...
Checkout the previous version and create a test data:
$ git checkout $PREVIOUS_VERSION
$ rm -rf ca/db.sqlite3 ca/files
$ python ca/manage.py migrate
$ devscripts/standalone/create-testdata.py
Then checkout the current main branch, run migrations and validate the test data:
$ git checkout main
$ python ca/manage.py migrate
$ python ca/manage.py makemigrations --check
$ devscripts/standalone/validate-testdata.py
Finally, also make sure that devscripts/standalone/create-testdata.py
also works for the current version:
$ rm -rf ca/db.sqlite3 ca/files
$ python ca/manage.py migrate
$ devscripts/standalone/create-testdata.py
$ devscripts/standalone/validate-testdata.py
- Check if the output of CAs and certs look okay: http://localhost:8000/admin
- Check if the profile selection when creating a certificate works.
- Check if pasting a CSR shows values from the CSR next to the "Subject" field.
Create a release with:
$ ./dev.py release $version
The release script will:
- Validate the current state in your repository.
- Create a new signed git tag.
- Build and validate the Python Wheel.
- Build and test the Docker image.
- Test the various tutorials.
- Upload Python Wheel and Docker image.
Create a release on GitHub.
- Update version in
ca/django_ca/__init__.py
. - Update
ca/django_ca/deprecation.py
and remove code marked by such warnings. Search for deprecation comments that could be removed:
$ grep -A 3 -r 'deprecated:' docs/source/ ca/
- Drop support for older software versions in the
[django-ca.release]
section ofpyproject.toml
. - Run
./dev.py validate state
and fix any errors. Look for pragmas that indicate that code can be removed due to versions no longer being supported:
$ grep -r '# pragma:' ca/ docs/source/ devscripts/ *.py
- Update
docker-compose.yml
to use thelatest
version of django-ca. - Start new changelog entry in
docs/source/changelog.rst
.