| Anthonios Partheniou | aff037a | 2021-04-21 11:00:09 -0400 | [diff] [blame] | 1 | # Discovery Artifact Automation |
| 2 | Discovery Artifacts are automatically updated using a Github Action script. This |
| 3 | documentation is intended for users that need to maintain the repository. |
| 4 | |
| 5 | ## Updating discovery artifacts locally |
| 6 | |
| 7 | To update discovery artifacts locally: |
| 8 | 1. Create a virtual environment using `pyenv virtualenv updateartifacts` |
| 9 | 2. Activate the virtual environment using `pyenv activate updateartifacts` |
| 10 | 3. Clone the repository, and `cd` into the `scripts` directory |
| 11 | 4. Run `pip install -r requirements.txt` |
| 12 | 5. Run `pip install -e ../` |
| 13 | 6. Run `git checkout -b update-discovery-artifacts-manual` |
| 14 | 7. Run `python3 updatediscoveryartifacts.py` |
| 15 | 8. Run `./createcommits.sh` |
| 16 | 9. Run `python3 buildprbody.py` |
| 17 | 10. Create a pull request with the changes. |
| 18 | 11. Copy the contents of `temp/allapis.summary` into the PR Body. |
| 19 | |
| 20 | ## Questions |
| 21 | Feel free to submit an issue! |