From bde926ed871136cd82baaf10bc1a5ae71703cf2b Mon Sep 17 00:00:00 2001 From: Tim Schilling Date: Tue, 16 Dec 2025 15:21:06 -0600 Subject: [PATCH] Document release process for Django Commons releases Added release process steps to CONTRIBUTING.rst. --- CONTRIBUTING.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 58136c60..8f12aaf6 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -94,3 +94,20 @@ steps: 5. Commit and publish your translations as described above. .. _translation docs: https://docs.djangoproject.com/en/stable/topics/i18n/translation/#localization-how-to-create-language-files + +Releases +-------- + +The release process follow's `Django Commons Best Practices`_. The steps are as +follows: + +1. Prepare a PR that updates the version +2. Merge version update PR +3. Create tag locally +4. Push tag to GitHub +5. A member of ``@django-commons/django-simple-history-admins`` team will need to + approve deployment GitHub Action +6. [Automated] The release GitHub Action will create the GitHub release for the + new tag which can then be edited + +.. _Django Commons Best Practices: https://github.com/django-commons/best-practices/blob/main/docs/releases.md#releases