Skip to content

Commit

Permalink
update bugfix release instructions (#2474)
Browse files Browse the repository at this point in the history
* update bugfix release instructions

* add instructions for updating change log if a bug fix release is planned but skipped

* remove empty line
  • Loading branch information
cshanahan1 authored Sep 21, 2023
1 parent 3125280 commit d32cac1
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion docs/dev/release.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,12 @@ You can do a release from your fork directly without a clean code check-out.
and update the release date from ``unreleased`` to current date in the ``yyyy-mm-dd`` format.
Remove any empty subsections.

NOTE: You may encounter the case where there is a populated bugfix section
below the current feature release section, but this bugfix release is being skipped
in favor of a major release. If this happens, you will need to move those entries
to the appropriate location(s) in the newest 'released' section, and remove that
bugfix section since that release is being skipped.

#. Update the ``CITATION.cff`` file's ``date-released`` and ``version`` fields.
If there are new contributors to the project, add them in the ``authors``
section.
Expand Down Expand Up @@ -312,7 +318,7 @@ instances of ``vX.Y.x`` with ``v3.5.x``.
#. Check `Zenodo page for Jdaviz <https://doi.org/10.5281/zenodo.5513927>`_.
It should have picked up the GitHub Release automatically.

#. The release is basically done, but now you have to set it up for the
#. The release is basically done, but now you have to set up the main branch for the
*next* release cycle. Checkout the ``main`` branch and update ``CHANGES.rst``
using your admin power. If you do not have sufficient access to do that,
you will have to update it via a pull request from your fork. Make sure the
Expand Down Expand Up @@ -346,6 +352,14 @@ instances of ``vX.Y.x`` with ``v3.5.x``.

#. Commit your changes of the, uh, change log with a message, "Back to development: A.B.dev"

#. Finally, you will need to set up the vX.Y.x branch for the next (potential)
bugfix release. To do this (either through a direct commit using admin power,
or via pull request to vX.Y.x), add a new bugfix section to the top of the
change log. For example, if the bugfix release you just made was 3.6.2,
add a 3.6.3 (unreleased) section (see step 7, but no need for a feature
release section). Commit these changes with a message along the lines of
"Back to development, vX.Y.x".

#. Follow procedures for :ref:`release-milestones`.

#. For your own sanity unrelated to the release, grab the new tag for your fork::
Expand Down

0 comments on commit d32cac1

Please sign in to comment.