Merge pull request #284 from hakonanes/post-0.8.1-release

Post 0.8.1 release updates

CHANGELOG.rst

@@ -7,6 +7,9 @@ All notable changes to this project will be documented in this file.
 The format is based on `Keep a Changelog <https://keepachangelog.com/en/1.0.0/>`_, and
 this project adheres to `Semantic Versioning <https://semver.org/spec/v2.0.0.html>`_.
 
+Unreleased
+==========
+
 2022-02-14 - version 0.8.1
 ==========================
 

MANIFEST.in

@@ -3,9 +3,10 @@ include getting_started.rst
 include LICENSE
 include MANIFEST.in
 include README.rst
+include RELEASE.rst
 include readthedocs.yml
 include setup.cfg
 include setup.py
 
 recursive-include doc Makefile make.bat *.rst *.py *.ipynb *.bib
-recursive-include doc/_static *.png *.svg *.css
+recursive-include doc/_static *.png *.svg *.css

RELEASE.rst

@@ -0,0 +1,29 @@
+How to make a new release of ``orix``
+=====================================
+
+Create a PR to the `master` branch and go through the following steps.
+
+Preparation
+-----------
+- Bump ``__version__`` in `orix/__init__.py`, for example "0.8.2".
+- Update the changelog `CHANGELOG.rst`.
+- Let the PR collect comments for a day to ensure that other maintainers are 
+  comfortable with releasing. Merge.
+
+Release (and tag)
+-----------------
+- Create a tagged, annotated (meaning with a release text) with the name 
+  v0.8.2" and title "orix 0.8.2". The tag target will be the ``master`` branch.
+  Draw inspiration from previous release texts. Publish the release.
+- Monitor the publish GitHub Action to ensure the release is successfully 
+  published to PyPI.
+
+Post-release action
+-------------------
+- Monitor the documentation build at
+  https://readthedocs.org/projects/orix/builds to make sure the new stable
+  documentation is successfully built from the release.
+- Make a post-release PR to ``master`` with ``__version__`` updated (or 
+  reverted), e.g. to "0.9.dev0", and any updates to this guide if necessary.
+- Tidy up and close corresponding milestone.
+- A PR to the conda-forge feedstock will be created by the conda-forge bot.

orix/__init__.py

@@ -1,5 +1,5 @@
 __name__ = "orix"
-__version__ = "0.8.1"
+__version__ = "0.9.dev0"
 __author__ = "orix developers"
 __author_email__ = "pyxem.team@gmail.com"
 __description__ = "orix is an open-source python library for handling crystal orientation mapping data."