###############
Release process
###############

.. highlight:: console

***********
Preparation
***********

Run these steps when you begin to create a new release:

* Double-check that the changelog is up to date.
* Update requirements in :file:`pyproject.toml`.
* Check versions of major software dependencies and:

  * Update ``[django-ca.release]`` in :file:`pyproject.toml` with current minor versions.
  * Add a deprecation notice for versions no longer supported upstream.

* Update table in ``docs/source/quickstart/as_app.rst``
* Run :command:`./dev.py validate state` and fix any errors.

Upgrade ``uv.lock``
===================

Create a file with pinned requirements, so that users can reliably reproduce a setup::

   $ uv sync --all-extras --upgrade

Update Docker maintenance action
================================

Add the new release ``.github/workflows/docker-maintenance.yml``.

Docker Compose
==============

* Verify that :file:`compose.yaml` uses up-to-date version of 3rd-party containers.
* Set the default django-ca version in :file:`compose.yaml` to the new version.
* Update table in ``docs/source/quickstart/docker_compose.rst``.

******************
Test current state
******************

* Make sure that :command:`tox` runs through for all environments.
* Push the last commit and make sure that GitHub actions and Read The Docs run through.

Test demo
=========

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...

Test update
===========

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

Test admin interface
====================

* 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.

Test tutorials
==============

Validate that the tutorials are still working::

    $ ./dev.py validate docker
    $ ./dev.py validate docker-compose --no-rebuild

****************
Create a release
****************

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 test the Docker image.
* Test the various tutorials.
* Push the git tag.

Update Docker Hub
=================

* Update `Docker Hub <https://hub.docker.com/r/mathiasertl/django-ca>`_.

*********************
Create release branch
*********************

Note that the release branch solely exists to update Docker images on a regular basis:

* Create the branch.
* Run ``./dev.py validate state --release-branch`` and fix errors.
* Push that branch.

***************
After a release
***************

* Start new changelog entry in ``docs/source/changelog/``.
* Update :file:`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 of :file:`pyproject.toml`.
* Run :command:`./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 :file:`compose.yaml` to use the ``latest`` version of **django-ca**.
* Update ``.github/workflows/docker-maintenance.yml`` to include the new release.

  * Make sure that ``NEWEST_DJANGO_CA`` is also updated!