Skip to content

Commit f22498d

Browse files
authored
Document process for deploying new scripts
1 parent 04b3dd7 commit f22498d

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,14 @@ Builds a set of CSVs and stores them into the collection data bucket under repor
1515

1616
Each Python script in `src/` can be run individually with `python src/script_name.py --output-dir <directory>` (or `python3` depending on your system setup). Note: if `make all` fails with "python: No such file or directory", your system requires `python3` - edit the Makefile locally to replace `python` with `python3`.
1717

18+
## Deploying New Scripts
19+
20+
To deploy a new reporting script:
21+
22+
1. Create a pull request with your script and documentation
23+
2. Get code review approval from a team member
24+
3. Once merged, an **infrastructure-deployer** team member must approve the GitHub Actions workflow to deploy the changes
25+
1826
## Licence
1927

2028
The software in this project is open source and covered by the [LICENSE](LICENSE) file.

0 commit comments

Comments
 (0)