Skip to content

Commit 89b7fda

Browse files
committed
docs(tests): update README and nhs_rap.md following implementation of CI for tests
1 parent 205045f commit 89b7fda

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
![python](https://img.shields.io/badge/-Python_3.13-306998?logo=python&logoColor=white)
66
![licence](https://img.shields.io/badge/Licence-MIT-green.svg?labelColor=gray)
77
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.14622466.svg)](https://doi.org/10.5281/zenodo.14622466)
8+
![Tests](https://github.com/pythonhealthdatascience/rap_template_python_des/actions/workflows/tests.yaml/badge.svg)
89

910
A simple template for creating DES models in Python, within a **reproducible analytical pipeline (RAP)** <br>
1011
Click on <kbd>Use this template</kbd> to initialise new repository.<br>
@@ -136,6 +137,8 @@ To run tests, ensure environment is active and located in main directory (i.e. p
136137
pytest
137138
```
138139

140+
The repository contains a GitHub action `tests.yaml` which will automatically run tests with new commits to GitHub. This is continuous integration, helping to catch bugs early and keep the code stable.
141+
139142
You can lint the `.py` files by running either of this commands from the terminal:
140143

141144
```
@@ -182,6 +185,7 @@ This section describes the purposes of each class in the simulation.
182185

183186
```
184187
repo/
188+
├── .github/workflows/ # GitHub actions
185189
├── docs/ # Documentation
186190
├── scripts/ # Code for DES model and analysis
187191
├── tests/ # Unit tests

docs/nhs_rap.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Meeting all of the above requirements, plus:
4444

4545
| Criteria | Completion | Further details |
4646
| - | - | - |
47-
| Code is fully [packaged](https://packaging.python.org/en/latest/). ||
48-
| Repository automatically runs tests etc. via CI/CD or a different integration/deployment tool e.g. [GitHub Actions](https://docs.github.com/en/actions). | | **TODO: Set up tests to run with GitHub actions** |
47+
| Code is fully [packaged](https://packaging.python.org/en/latest/). || `__init__.py` (shows directory should be treated like package) and `pyproject.toml` (specifies package details) |
48+
| Repository automatically runs tests etc. via CI/CD or a different integration/deployment tool e.g. [GitHub Actions](https://docs.github.com/en/actions). | | `.github/workflows/tests.yaml` |
4949
| Process runs based on event-based triggers (e.g., new data in database) or on a schedule. | N/A | - |
5050
| Changes to the RAP are clearly signposted. E.g. a changelog in the package, releases etc. (See gov.uk info on [Semantic Versioning](https://github.com/alphagov/govuk-frontend/blob/main/docs/contributing/versioning.md)). || `CHANGELOG.md` and GitHub releases |

0 commit comments

Comments
 (0)