Merge pull request #44 from TomAugspurger/release

Release procedure.

.github/workflows/release.yaml

@@ -0,0 +1,23 @@
+---
+name: Release
+
+on: [push]
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+      - name: Install dependencies
+        run: |
+          python -m pip install -U pip wheel setuptools twine
+      - name: Build distributions
+        run: python setup.py sdist bdist_wheel
+
+      - name: Publish to PyPI
+        if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
+        uses: pypa/gh-action-pypi-publish@master
+        with:
+          user: tomaugspurger
+          password: ${{ secrets.pypi_token }}

docs/contributing.rst

@@ -0,0 +1,16 @@
+Contributing
+============
+
+Releasing
+---------
+
+On the master branch, with a clean checkout
+
+.. code-block::
+
+   git commit --allow-empty -m "RLS: v0.2.0"
+   git tag -a 0.2.0 -m "RLS: 0.2.0"
+   git push upstream master --follow-tags
+
+A GitHub Action should push the release to PyPI. After that, conda-forge's
+bot will update the conda packages.

docs/index.rst

@@ -51,7 +51,9 @@ Contents
    tutorial
    api
    algorithm
+   executors
    release_notes
+   contributing
 
 
 .. _Zarr: https://zarr.readthedocs.io/en/stable/

rechunker/api.py

@@ -270,7 +270,14 @@ def rechunk(
         Implementation of the execution engine for copying between zarr arrays.
         Supplying a custom Executor is currently even more experimental than the
         rest of Rechunker: we expect the interface to evolve as we add more
-        executors and make no guarantees of backwards compatibility.
+        executors and make no guarantees of backwards compatibility. The
+        currently implemented executors are
+
+        * dask
+        * beam
+        * prefect
+        * python
+        * pywren
 
     Returns
     -------