From 33a9723480224fa0cf7ce772ce5984c02ece93cd Mon Sep 17 00:00:00 2001 From: Marc Pound <22331890+mpound@users.noreply.github.com> Date: Thu, 18 Jan 2024 13:09:43 -0500 Subject: [PATCH] upgrade header --- .../for_developers/creating_a_release.rst | 20 ++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/docs/source/for_developers/creating_a_release.rst b/docs/source/for_developers/creating_a_release.rst index 6398a31d..ea5f60bb 100644 --- a/docs/source/for_developers/creating_a_release.rst +++ b/docs/source/for_developers/creating_a_release.rst @@ -1,23 +1,25 @@ -##Steps for publishing a new dysh release +*************************************** +Steps for publishing a new dysh release +*************************************** -0. Prerequisites +#. Prerequisites * A release branch *release-M.m.p* (**M**\ajor, **m**\inor, **p**\atch) should have been created a few weeks before the release date. * This branch is to be used for betas and other pre-releases, with versioning managed as described below. -1. Housekeeping +#. Housekeeping * Switch to the release branch in your sandbox * Ensure all required functionality/bug fixes are merged, no outstanding PRs. - * Ensure all `CI `_ for this branch is passing. + * Ensure all `CI `_ for this branch are passing. * Set up readthedocs - `Activate the release branch `_ - Ensure docs are building * Change version string `dysh/__init__.py` - - we follow the `major.minor.patch[qualifier]` paradigm, + - We follow the `major.minor.patch[qualifier]` paradigm, where `qualifier` is e.g., `b`, `rc1`, etc. - - push `dysh/__init__.py` - * Freeze release branch at least week before release + - Push `dysh/__init__.py` (ok to bypass pull request rule) + * Freeze release branch at least a week before release -2. Create the release on github.com +#. Create the release on github.com - Follow `these steps to begin the release and generate release notes `_ - Create a new tag that matches your version in step 1, e.g. '0.2.0' - The release title should be 'v'+[the tag] @@ -25,4 +27,4 @@ - If you want another pair of eyeballs, click *Save Draft*, otherwise click *Publish Release*. - The CI should create the release and upload it to pypi.org. -3. Monitor the `CI `_, `pypi.org `_, and `readthedocs.org `_ for progress/problems. +#. Monitor the `CI `_, `pypi.org `_, and `readthedocs.org `_ for progress/problems.