publicdata/j40-cejst-2
1
0
Fork 0
mirror of https://github.com/DOI-DO/j40-cejst-2.git synced 2025-02-23 10:04:18 -08:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add some docs about the github actions

Browse source
This commit is contained in:
Shaun Verch 2021-12-08 12:29:13 -05:00
parent 0bb4236aa1
commit fbef8d3432
2 changed files with 10 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
.github/workflows/README.md vendored Normal file
View file

@ -0,0 +1,9 @@
# Justice40 Github Actions Workflows
This directory has the github actions workflows for the Justice40 Project.
This project is deployed on an AWS account managed by [GeoPlatform.gov](https://www.geoplatform.gov/), and github actions is used to automate the data pipeline and all deployment steps.
The names of the Github Actions stages in the yaml files should describe what each step does, so it is best to refer there to understand the latest of what everything is doing.
To mitigate the risk of having this README quickly become outdated as the project evolves, avoid documenting anything application or data pipeline specific here. Instead, go back up to the [top level project README](/README.md) and refer to the documentation on those components directly.

1
INSTALLATION.md
View file

@ -7,6 +7,7 @@ This page documents the installation steps for some of the software needed to wo
- If you want to quickly run everything locally, see [`QUICKSTART.md`](QUICKSTART.md).
- If you are working with the frontend, see [`client/README.md`](client/README.md) for installation steps specific to that part of the project.
- If you are working with the data pipeline, see [`data/data-pipeline/README.md`](data/data-pipeline/README.md) for installation steps specific to that part of the project.
- If you want to understand the current deployment process, see [`.github/workflows/README.md`](.github/workflows/README.md).
## Install Homebrew (MacOS only)