Merge pull request #186 from CITCOM-project/dev_docs

Version Release Docs

Author: christopher-wild

docs/source/dev/version_release.rst

@@ -0,0 +1,30 @@
+Version Releases
+================
+
+This project follows the `Semantic Versioning 2.0.0 <https://semver.org/>`_ style for code releases.
+This page aims to describe the release process for a new code version on the `Project Github <https://github.com/CITCOM-project/CausalTestingFramework>`_
+
+How to release
+--------------
+
+#. Once your PR(s) are merged, navigate to https://github.com/CITCOM-project/CausalTestingFramework/releases, which can be found on the right hand side of the projects Github main page by clicking on 'Releases'
+
+#. Press the **Draft a new release** button in the top right of the releases page
+
+#. Press the **Choose a tag** button and add the new version following the Semantic Version guidelines. Please include the 'v' before the tag, e.g. **v0.0.0**
+
+#. Enter the same tag name into the **Release Title** box
+
+#. Press **Generate Release Notes** button
+
+#. Add any additional information that may be helpful to the release notes. If there are breaking changes for example, which modules will they affect?
+
+#. Ensure the **Set as the latest release** checkbox is selected
+
+#. Press publish release
+
+#. Check that the Github Action worker, found in the `Actions tab <https://github.com/CITCOM-project/CausalTestingFramework/actions>`_ on the github, has successfully completed. Typical time to publish to PyPI is around 2 minutes.
+
+#. Check on the projects `PyPI page <https://pypi.org/project/causal-testing-framework/>`_ that the latest release is ready!
+
+From here the latest version can be installed using the common pip version commands. e.g. ``pip install causal-testing-framework==0.0.0``

docs/source/index.rst

@@ -49,6 +49,12 @@ system-under-test that is expected to cause a change to some output(s).
 
    glossary
 
+.. toctree::
+   :maxdepth: 1
+   :caption: Development Documentation
+
+   /dev/version_release
+
 Indices and tables
 ==================
 

pyproject.toml

@@ -19,7 +19,7 @@ dependencies = [
     "fitter~=1.4",
     "lhsmdu~=1.1",
     "networkx~=2.6",
-    "numpy~=1.22",
+    "numpy~=1.22.0",
     "pandas~=1.3",
     "scikit_learn~=1.1",
     "scipy~=1.7",