Prepare release (#35)

* add a warning about the package status

* add a release guide

* fill in the release date in whats-new.rst

* update the release guide to mention the build CI

Author: keewis

HOW_TO_RELEASE.rst

@@ -0,0 +1,44 @@
+Release process
+===============
+1. the release happens from `master` so make sure it is up-to-date:
+
+   .. code:: sh
+
+      git pull origin master
+
+2. look at `whats-new.rst` and make sure it is complete and with
+   references to issues and pull requests
+
+3. open and merge a pull request with these changes and the filled in release date
+
+4. run the test suite
+
+5. check that the documentation is building
+
+6. Commit the release:
+
+   .. code:: sh
+
+      git commit --allow-empty -am "Release v0.X.Y"
+
+7. Tag the release and push to master:
+
+   .. code:: sh
+
+      git tag -a v0.X.Y -m "v0.X.Y"
+      git push origin --tags
+
+8. Draft a release for the new tag on github. A CI will pick that up, build the project
+   and push to PyPI. Be careful, this can't be undone.
+              
+9. Update stable:
+
+    .. code:: sh
+
+       git checkout stable
+       git merge v0.X.Y
+       git push origin stable
+
+10. Make sure readthedocs builds both `stable` and the new tag
+
+11. Add a new section to `whats-new.rst` and push directly to master

docs/index.rst

@@ -5,6 +5,11 @@ A convenience wrapper for using `pint`_ in `xarray`_ objects.
 .. _pint: https://pint.readthedocs.io/en/stable
 .. _xarray: https://xarray.pydata.org/en/stable
 
+.. warning::
+
+   This package is experimental, and new versions might introduce backwards incompatible
+   changes.
+
 Documentation
 -------------
 

docs/whats-new.rst

@@ -1,8 +1,8 @@
 What's new
 ==========
 
-0.1 (*unreleased*)
-------------------
+0.1 (October 26 2020)
+---------------------
 - add initial draft of documentation (:pull:`13`, :pull:`20`)
 - implement :py:meth:`DataArray.pint.to` and :py:meth:`Dataset.pint.to`
   (:pull:`11`)