From 255a7fc30a6cd8bed53a61ec8f7c1a12936f662d Mon Sep 17 00:00:00 2001 From: "Jeffrey A. Clark" Date: Wed, 22 Oct 2025 10:34:23 -0400 Subject: [PATCH 1/4] Add release process for DBX team members --- docs/internals/release-process.rst | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/docs/internals/release-process.rst b/docs/internals/release-process.rst index 09f560217..14b0da9a9 100644 --- a/docs/internals/release-process.rst +++ b/docs/internals/release-process.rst @@ -40,3 +40,25 @@ merge of a "Add support for Django X.Y" pull request. Before merging that pull request, a branch is created off of main to track the previous feature release. For example, the 5.1.x branch is created shortly after the release of Django 5.2, and main starts tracking the Django 5.2.x series. + +Release +======= + +Django MongoDB Backend uses GitHub Actions to publish new releases to PyPI. To +publish a new release to PyPI: + +- Bump the version number in ``django_mongodb_backend/__init__.py`` + according to :ref:`the supported versions policy + `. + +- Update the release notes in ``docs/releases/#.#.x.rst`` for the new version. + +- Run the ``Release`` workflow on GitHub Actions, providing the new (dev) + version number as input. + + - First run with ``Dry Run?`` selected and check test PyPI to ensure that + ``pip install`` works as expected. + + - Then run without ``Dry Run?`` to publish the release to PyPI. + +- Announce the new release on the relevant communication channels. From 7a500f132f894dd7f20c7cb006399ef61e020483 Mon Sep 17 00:00:00 2001 From: "Jeffrey A. Clark" Date: Wed, 22 Oct 2025 10:42:00 -0400 Subject: [PATCH 2/4] Add example of new version number --- docs/internals/release-process.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/internals/release-process.rst b/docs/internals/release-process.rst index 14b0da9a9..a046e2841 100644 --- a/docs/internals/release-process.rst +++ b/docs/internals/release-process.rst @@ -53,8 +53,10 @@ publish a new release to PyPI: - Update the release notes in ``docs/releases/#.#.x.rst`` for the new version. -- Run the ``Release`` workflow on GitHub Actions, providing the new (dev) - version number as input. +- Run the ``Release`` workflow on GitHub Actions, optionally providing the new + (dev) version number as input. E.g. ``5.3.x.dev0`` for a new development + release after ``5.2.x``. (The workflow defaults to incrementing the + version automatically.) - First run with ``Dry Run?`` selected and check test PyPI to ensure that ``pip install`` works as expected. From f9d8e94614677f1aa5363f838f5d63a74aaa2dd4 Mon Sep 17 00:00:00 2001 From: "Jeffrey A. Clark" Date: Wed, 22 Oct 2025 10:46:39 -0400 Subject: [PATCH 3/4] Fix version number example --- docs/internals/release-process.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/internals/release-process.rst b/docs/internals/release-process.rst index a046e2841..c93559964 100644 --- a/docs/internals/release-process.rst +++ b/docs/internals/release-process.rst @@ -54,8 +54,8 @@ publish a new release to PyPI: - Update the release notes in ``docs/releases/#.#.x.rst`` for the new version. - Run the ``Release`` workflow on GitHub Actions, optionally providing the new - (dev) version number as input. E.g. ``5.3.x.dev0`` for a new development - release after ``5.2.x``. (The workflow defaults to incrementing the + (dev) version number as input. E.g. ``5.2.3.dev0`` for a new development + release after ``5.2.2``. (The workflow defaults to incrementing the version automatically.) - First run with ``Dry Run?`` selected and check test PyPI to ensure that From 58246370bda19e0ec188552e57a1844ca6e0ba0b Mon Sep 17 00:00:00 2001 From: "Jeffrey A. Clark" Date: Wed, 22 Oct 2025 10:47:57 -0400 Subject: [PATCH 4/4] Lint --- docs/internals/release-process.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/internals/release-process.rst b/docs/internals/release-process.rst index c93559964..84f8fa962 100644 --- a/docs/internals/release-process.rst +++ b/docs/internals/release-process.rst @@ -58,9 +58,9 @@ publish a new release to PyPI: release after ``5.2.2``. (The workflow defaults to incrementing the version automatically.) - - First run with ``Dry Run?`` selected and check test PyPI to ensure that - ``pip install`` works as expected. + - First run with ``Dry Run?`` selected and check test PyPI to ensure that + ``pip install`` works as expected. - - Then run without ``Dry Run?`` to publish the release to PyPI. + - Then run without ``Dry Run?`` to publish the release to PyPI. - Announce the new release on the relevant communication channels.