Skip to content

Commit

Permalink
Add release process notes to dev docs
Browse files Browse the repository at this point in the history
  • Loading branch information
douglatornell committed Dec 22, 2022
1 parent 5feb9e5 commit f365452
Showing 1 changed file with 50 additions and 0 deletions.
50 changes: 50 additions & 0 deletions docs/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -536,3 +536,53 @@ by the `SalishSeaCast Project Contributors`_ and The University of British Colum
They are licensed under the Apache License, Version 2.0.
https://www.apache.org/licenses/LICENSE-2.0
Please see the LICENSE file for details of the license.


Release Process
===============

Releases are done at Doug's discretion when significant pieces of development work have been
completed.

The release process steps are:

#. Use :command:`hatch version release` to bump the version from ``.devn`` to the next release
version identifier

#. Confirm that :file:`docs/breaking_changes.rst` includes any relevant notes for the
version being released

#. Commit the version bump and breaking changes log update

#. Create an annotated tag for the release with :guilabel:`Git -> New Tag...` in PyCharm
or :command:`git tag -e -a vyy.n`

#. Push the version bump commit and tag to GitHub

#. Use the GitHub web interface to create a release,
editing the auto-generated release notes as necessary

#. Use the GitHub :guilabel:`Issues -> Milestones` web interface to edit the release
milestone:

* Change the :guilabel:`Due date` to the release date
* Delete the "when it's ready" comment in the :guilabel:`Description`
* Close the release milestone

#. Use the GitHub :guilabel:`Issues -> Milestones` web interface to create a milestone for
the next release:

* Set the :guilabel:`Title` to the next release version,
prepended with a ``v``;
e.g. ``v23.1``
* Set the :guilabel:`Due date` to the end of the year of the next release
* Set the :guilabel:`Description` to something like
``v23.1 release - when it's ready :-)``
* Create the next release milestone

#. Use :command:`hatch version minor,dev` to bump the version for the next development cycle,
or use :command:`hatch version major,minor,dev` for a year rollover version bump

#. Commit the version bump

#. Push the version bump commit to GitHub

0 comments on commit f365452

Please sign in to comment.