Prepare for release of v0.3.1

Author: znicholls

CHANGELOG.rst

@@ -4,6 +4,10 @@ Changelog
 master
 ------
 
+
+v0.3.1
+------
+
 - (`#17 <https://github.com/znicholls/netcdf-scm/pull/17>`_) Update to crunch global and hemispheric means even if land-surface fraction data is missing
 - (`#16 <https://github.com/znicholls/netcdf-scm/pull/16>`_) Tidy up experimental crunching script
 - (`#15 <https://github.com/znicholls/netcdf-scm/pull/15>`_) Add ability to load from a directory with data that is saved in multiple timeslice files, also adds:

Makefile

@@ -78,18 +78,11 @@ black:
 
 .PHONY: new_release
 new_release:
-	@echo 'For a new release on PyPI:'
-	@echo 'git tag vX.Y.Z'
-	@echo 'make publish-on-pypi'
+	@echo 'See instructions in the Releasing sub-section of the Development section of the docs'
 
 .PHONY: release-on-conda
 release-on-conda:
-	@echo 'For now, this is all very manual'
-	@echo 'Checklist:'
-	@echo '- version number'
-	@echo '- sha'
-	@echo '- README.rst badge'
-	@echo '- CHANGELOG.rst up to date'
+	@echo 'See instructions in the Releasing sub-section of the Development section of the docs'
 
 # first time setup, follow this https://blog.jetbrains.com/pycharm/2017/05/how-to-publish-your-package-on-pypi/
 # then this works

docs/source/development.rst

@@ -4,6 +4,7 @@ Development
 If you're interested in contributing to NetCDF-SCM, we'd love to have you on board!
 This section of the docs details how to get setup to contribute and how best to communicate.
 
+.. contents:: :local:
 
 Contributing
 ------------
@@ -133,7 +134,59 @@ For more information on these, `here is the full guide <https://numpydoc.readthe
 Releasing
 ---------
 
-[To be written, once I've done it]
+The steps to release a new version of NetCDF-SCM are shown below.
+Please do all the steps below and all the steps for both release platforms.
+
+#. Update ``CHANGELOG.rst``:
+
+    - add a header for the new version between ``master`` and the latest bullet point
+    - this should leave the section underneath the master header empty
+
+#. ``git add .``
+#. ``git commit -m "Prepare for release of vX.Y.Z"``
+#. ``git push``
+#. ``git tag vX.Y.Z``
+#. ``git push --tags``
+
+PyPI
+~~~~
+
+#. ``make publish-on-testpypi``
+#. Go to `test PyPI <https://test.pypi.org/project/netcdf-scm/>`_ and check that the new release is as intended. If it isn't, stop and debug.
+#. ``make publish-on-pypi``
+#. Go to `PyPI <https://pypi.org/project/netcdf-scm/>`_ and check that the new release is as intended.
+
+
+Conda
+~~~~~
+
+#. If you haven't already, fork the `NetCDF-SCM conda feedstock`_.
+#. Create a new branch in the feedstock for the version you want to bump to.
+#. Edit ``recipe/meta.yaml`` and update:
+
+    - version number in line 1 (don't include the 'v' in the version tag)
+    - the build number to zero (you should only be here if releasing a new version)
+
+#. Make a PR into the `NetCDF-SCM conda feedstock`_
+#. If the PR passes, merge
+#. Check https://anaconda.org/conda-forge/netcdf-scm to double check that the version has increased
+
+.. _`NetCDF-SCM conda feedstock`: https://github.com/conda-forge/netcdf-scm-feedstock
+
+
+    @echo 'Checklist:'
+    @echo '- version number'
+    @echo '- sha'
+    @echo '- README.rst badge'
+    @echo '- CHANGELOG.rst up to date'
+
+Last steps
+~~~~~~~~~~
+
+#. Update any badges in ``README.rst`` that don't update automatically
+#. ``git add .``
+#. ``git commit -m "Update README badges"``
+#. ``git push``
 
 
 Why is there a ``Makefile`` in a pure Python repository?