Merge pull request JiaweiZhuang#75 from pangeo-data/deploy-doc

Add how-to instructions on how to cut a new release

doc/conf.py

@@ -58,7 +58,7 @@
 
 # To avoid installing xESMF and all its dependencies when building doc
 # https://stackoverflow.com/a/15912502/8729698
-autodoc_mock_imports = ['numpy', 'xarray', 'scipy', 'ESMF']
+autodoc_mock_imports = ['numpy', 'xarray', 'scipy', 'ESMF', 'dask']
 
 # avoid automatic execution for notebooks
 nbsphinx_execute = 'never'

doc/index.rst

@@ -58,6 +58,7 @@ Contents
 
    changes
    notebooks/Backend
+   releases
 
 .. toctree::
    :maxdepth: 1

doc/releases.rst

@@ -0,0 +1,26 @@
+Release how-to
+==============
+
+Here are the step by step instructions to release a new version of xESMF.
+
+#. Make sure :file:`CHANGES.rst` is up to date and includes a section on the version to be released;
+#. On GitHub, go the Releases_ page and click on :guilabel:`Draft a new release`;
+#. Enter new version in :guilabel:`Tag version` (e.g. v<major>.<minor>.<patch>);
+#. Enter the :guilabel:`Release title` (e.g. the same tag);
+#. Copy the relevant section of :file:`CHANGES.rst` in the description;
+#. Click :guilabel:`Publish release`;
+#. Go to Actions_ and in the left-hand menu select :guilabel:`Upload xesmf to PyPi`;
+#. Click on the release you just made;
+#. At the bottom of the page, download the :guilabel:`artifact` locally;
+#. Unzip it;
+#. Run shell command ``sha256sum`` on `xesmf-<version>.tar.gz` and copy the checksum string;
+#. Go to the conda-forge repo and edit the `recipe/meta.yml <https://github.com/conda-forge/xesmf-feedstock>`_ file;
+#. Update the version on the first line to the latest release;
+#. Update the `sha256` value in the `source` section to the checksum just calculated;
+#. Enter a commit message, e.g. (Update version to <version>);
+#. Submit the pull request (:guilabel:`Propose changes`);
+#. Get an approval from a maintainer to merge the pull request.
+
+
+.. _Releases: https://github.com/pangeo-data/xESMF/releases
+.. _Actions: https://github.com/pangeo-data/xESMF/actions