Improving testing of release process
Author: tim-schillingCreated Jan 18, 2025Updated Aug 28, 2026
LabelsDjangonaut Space :rocket:
I propose we allow suffixing the version number from an environment variable. This would then be utilized in our test release process to build the package with a unique version number.
The new action would run on the following events:
- A tag is pushed (same as today)
- Once a month
- A
workflow_dispatchwith a unique iteration value
There is more information on how this would be implemented here: https://github.com/django-commons/best-practices/blob/main/docs/releases.md
The relevant bits of code from the best practices:
- https://github.com/django-commons/best-practices/blob/main/pyproject.toml#L24 Identifies what version should be used. This may be different since I think we use hatchling
- https://github.com/django-commons/best-practices/blob/main/src/django_commons_best_practices/__init__.py#L8 Reads the environment variable in to suffix the version if necessary.
- https://github.com/django-commons/best-practices/blob/main/.github/workflows/test_release.yml#L25-L54 Generates the suffix if needed
- https://github.com/django-commons/best-practices/blob/main/.github/workflows/test_release.yml#L72-L74 Generates the package name to be uploaded
Source: django-commons/django-debug-toolbar