Add steps for making a new release (#94)

* Add steps for making a new release

* Add PR link to release notes

* Indent

* Updates based on review comments

Author: spencerkclark

docs/index.rst

@@ -22,3 +22,9 @@ up of :py:class:`cftime.datetime` dates with any calendar type.
 
    release-notes
    api
+
+.. toctree::
+   :caption: Maintenance
+   :maxdepth: 1
+
+   releases

docs/release-notes.rst

@@ -51,6 +51,8 @@ Documentation
 * Added a start on Read the Docs documentation.  Added examples, release notes,
   and NumPy-style docstrings to nc-time-axis classes (:issue:`62`, :pull:`87`).
   By `Spencer Clark <https://github.com/spencerkclark>`_.
+* Added some basic instructions for making a new release (:pull:`94`).  By
+  `Spencer Clark <https://github.com/spencerkclark>`_.
 
 
 v1.3.1 (June 14th, 2021)

docs/releases.rst

@@ -0,0 +1,36 @@
+.. _releases:
+
+Making a new release
+====================
+
+When making a new release of ``nc-time-axis``, it is best to follow these steps.
+Note these are a trimmed-down version of the `release steps for the Iris package
+<https://scitools-iris.readthedocs.io/en/stable/developers_guide/release.html>`_.
+
+1. Create a release branch in the `SciTools/nc-time-axis repository
+   <https://github.com/SciTools/nc-time-axis>`_ with the
+   name ``v{major release number}.{minor release number}.x``.  This branch will
+   be used to make any final changes prior to the release.  It will be merged
+   back into the ``main`` branch once the release is complete.
+2. Check that the :ref:`release_notes` have been fully updated for the new
+   release. This includes adding a date for the new release where it currently
+   says "unreleased."  This can also include formatting and other minor content
+   updates.
+3. `Create a new tag in the GitHub
+   <https://github.com/SciTools/nc-time-axis/releases/new>`_ repository for the
+   new release.  This should have the same name as the release branch.
+4. Upload the release to `PyPI <https://pypi.org>`_.  A nice set of instructions
+   for this can be found in the `Iris documentation
+   <https://scitools-iris.readthedocs.io/en/stable/developers_guide/release.html#update-pypi>`_.
+5. Uploading the release to PyPI should trigger an automatic pull request to the
+   `conda-forge/nc_time_axis-feedstock
+   <https://github.com/conda-forge/nc_time_axis-feedstock>`_ repository.  Review
+   this pull request, make changes if necessary, and then merge it.
+6. Ensure the documentation has been built properly on `Read the Docs
+   <https://readthedocs.org>`_ and that the new release is an "active version."
+7. Update the :ref:`release_notes` page to include a blank section for the next
+   release.
+8. Merge the release branch into ``main``, but leave it available in case any
+   point releases are needed.
+9. Only delete / archive this release branch once no more bug fixes are needed
+   and the next minor release is being planned using a new branch.