Skip to content

Commit 25b5db9

Browse files
Add version_release.rst and add to toctree
1 parent 72c3997 commit 25b5db9

File tree

2 files changed

+38
-0
lines changed

2 files changed

+38
-0
lines changed

docs/source/dev/version_release.rst

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
Version Releases
2+
================
3+
4+
This project follows the `Semantic Versioning 2.0.0 <https://semver.org/>`_ style for code releases.
5+
This page aims to describe the release process for a new code version on the `Project Github <https://github.com/CITCOM-project/CausalTestingFramework>`_
6+
7+
When to release
8+
---------------
9+
10+
A new release should follow each successful PR merge, or group of related PR merges.
11+
12+
How to release
13+
--------------
14+
15+
#. Once your PR(s) are merged, navigate to https://github.com/CITCOM-project/CausalTestingFramework/releases, which can be
16+
found on the right hand side of the projects Github main page by clicking on 'Releases'
17+
18+
#. Press the **Draft a new release** button in the top right of the releases page
19+
20+
#. 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**
21+
22+
#. Enter the same tag name into the **Release Title** box
23+
24+
#. Press **Generate Release Notes** button
25+
26+
#. Add any additional information that may be helpful to the release notes. If there are breaking changes for example, which modules will they affect?
27+
28+
#. Ensure the **Set as the latest release** checkbox is selected
29+
30+
#. Press publish release
31+
32+
From here, a `Github action <https://github.com/CITCOM-project/CausalTestingFramework/blob/main/.github/workflows/publish-to-pypi.yaml>`_ will then push this release to PyPI where it can be installed using the usual pip version commands. e.g. ``pip install causal-testing-framework==0.0.0``

docs/source/index.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,12 @@ system-under-test that is expected to cause a change to some output(s).
4949

5050
glossary
5151

52+
.. toctree::
53+
:maxdepth: 1
54+
:caption: Development Documentation
55+
56+
/dev/version_release
57+
5258
Indices and tables
5359
==================
5460

0 commit comments

Comments
 (0)