Skip to content

Commit

Permalink
Update ReadMe.md to include some info about how the repo is managed (#50
Browse files Browse the repository at this point in the history
)

* Update ReadMe.md

Small note added to the readme file as suggested by FE.
  • Loading branch information
ConnorOKane-Kainos authored Oct 3, 2024
1 parent 7c80dc2 commit 6976b25
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion ReadMe.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -98,4 +100,4 @@ To add or remove repositories follow the below:

| Name | Description |
|------|-------------|
| <a name="output_common_tags"></a> [common\_tags](#output\_common\_tags) | n/a |
| <a name="output_common_tags"></a> [common\_tags](#output\_common\_tags) | n/a |

0 comments on commit 6976b25

Please sign in to comment.