docs: add release documentation (#12)

Closes #7
openscm · Apr 21, 2023 · 927e3e4 · 927e3e4
1 parent dcfb9b9
commit 927e3e4
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/docs/source/development.rst b/docs/source/development.rst
@@ -0,0 +1,18 @@
+.. _development-reference:
+
+Development
+-----------
+
+Notes for developers. If you want to get involved, please do!
+
+Releasing
++++++++++
+
+Releasing is semi-automated. The steps required are the following:
+
+#. Bump the version. This is done via the "Bump version" action, which must be triggered manually.
+#. Once this action has completed, it will then create a draft release on GitHub (which will appear at `<https://github.com/openscm/OpenSCM-Calibration/releases>`_)
+#. Review this release, update any announcements and check the changes, then publish
+#. Upon publication, the release is automatically uploaded to PyPI via the "Release" action
+#. That's it, release done, make noise on social media of choice, do whatever else
+#. Enjoy the newly available version
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -29,6 +29,7 @@ For more usage examples, checkout :ref:`the notebooks <notebooks-reference>`.
    :caption: Contents:
 
    notebooks
+   development
 
 .. toctree::
     :maxdepth: 1