Merge pull request #209 from GreenBankObservatory/release-0.2.0

Release 0.2.0

.github/workflows/release.yml

@@ -7,16 +7,16 @@ on:
 
 jobs:
   build:
-    runs-on:  ${{ matrix.os }}
+    runs-on:  ubuntu-latest
     environment: release
     permissions:
       # IMPORTANT: this permission is mandatory for trusted publishing
       # See: https://github.com/pypa/gh-action-pypi-publish#trusted-publishing
       id-token: write
     steps:
-    - uses: actions/checkout@v3
-    - name: Set up Python
-      uses: actions/setup-python@v3
+    - uses: actions/checkout@v4
+    - name: Set up Python ubuntu-latest
+      uses: actions/setup-python@v4
       with:
         python-version: '3.9'  # Should always be the minimum supported Python version
         cache: 'pip'
@@ -25,6 +25,7 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install -r requirements.txt
+        pip install hatch
     - name: Build with hatch
       run: |
         hatch build --clean

docs/source/for_developers/creating_a_release.rst

@@ -0,0 +1,30 @@
+***************************************
+Steps for publishing a new dysh release
+***************************************
+
+#. 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.
+#. 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 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,
+           where `qualifier` is e.g., `b`, `rc1`, etc.
+         - Push `dysh/__init__.py`   (ok to bypass pull request rule)
+     * Freeze release branch at least a week before release
+
+#. 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.
+
+#. 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.

docs/source/for_developers/index.rst

@@ -12,5 +12,6 @@ Here's some info that developers might find useful
    doc_standards
    github_integrations
    git_workflows
+   creating_a_release
    black
    terminal_messages

src/dysh/__init__.py

@@ -1,6 +1,6 @@
 """Top-level package for dysh."""
 
-__version__ = "0.2.0b"
+__version__ = "0.2.1"
 
 all = ["version"]