Skip to content

Commit

Permalink
upgrade header
Browse files Browse the repository at this point in the history
  • Loading branch information
mpound committed Jan 18, 2024
1 parent dbd170e commit 33a9723
Showing 1 changed file with 11 additions and 9 deletions.
20 changes: 11 additions & 9 deletions docs/source/for_developers/creating_a_release.rst
Original file line number Diff line number Diff line change
@@ -1,28 +1,30 @@
##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 <https://github.com/GreenBankObservatory/dysh/actions>`_ for this branch is passing.
* Ensure all `CI <https://github.com/GreenBankObservatory/dysh/actions>`_ for this branch are passing.
* Set up readthedocs
- `Activate the release branch <https://readthedocs.org/projects/dysh/versions/>`_
- 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 <https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-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]
- Choose **pre-release** or **latest release** as appropriate
- 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 <https://github.com/GreenBankObservatory/dysh/actions>`_, `pypi.org <https://pypi.org/manage/project/dysh/releases/>`_, and `readthedocs.org <https://readthedocs.org/projects/dysh/>`_ for progress/problems.
#. Monitor the `CI <https://github.com/GreenBankObservatory/dysh/actions>`_, `pypi.org <https://pypi.org/manage/project/dysh/releases/>`_, and `readthedocs.org <https://readthedocs.org/projects/dysh/>`_ for progress/problems.

0 comments on commit 33a9723

Please sign in to comment.