Skip to content

Document release process for Django Commons releases #1573

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tim-schilling wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Document release process for Django Commons releases #1573

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions CONTRIBUTING.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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