diff --git a/ReadMe.md b/ReadMe.md index 06ee6660..d0a2b8c6 100644 --- a/ReadMe.md +++ b/ReadMe.md @@ -29,6 +29,8 @@ This Terraform configuration automates the process of setting up rule sets at th - Reads a list of repositories from `production-repos.json` - Creates a ruleset at the organisation level, this applies standardisation across all repositories. - Creates custom properties for repositories, such as marking repositories as "is_production." +- A good note to make is that you do not have to update this codebase as it will pull any new production repositories from the URL's provided and update itself at midnight. +- If you want to you can add repositories in yourself by raising a PR from main, adding in your repositories to the production-repos.json file that you want to add. Then merge the PR once ready. ## Maintenance @@ -98,4 +100,4 @@ To add or remove repositories follow the below: | Name | Description | |------|-------------| -| [common\_tags](#output\_common\_tags) | n/a | \ No newline at end of file +| [common\_tags](#output\_common\_tags) | n/a |