Skip to content

Commit

Permalink
Merge pull request #462 from bdsoha/feature/update-readme
Browse files Browse the repository at this point in the history
Use markdown `note` tag in `README.md`
  • Loading branch information
robandpdx authored Apr 24, 2023
2 parents 39e57a4 + 65013fb commit ef55548
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,21 @@
`Safe-settings`– an app to manage policy-as-code and apply repository settings to repositories across an organization.

1. In `safe-settings` all the settings are stored centrally in an `admin` repo within the organization. This is important. Unlike [Settings Probot](https://github.com/probot/settings), the settings files cannot be in individual repositories.
<br> :wave:`NOTE:` It is possible to overrride this behavior and specify a custom repo instead of the `admin` repo.
This could be done by setting an `env` variable called `ADMIN_REPO`.
> **Note** It is possible to overrride this behavior and specify a custom repo instead of the `admin` repo.<br>
> This could be done by setting an `env` variable called `ADMIN_REPO`.
1. There are 3 levels at which the settings could be managed:
1. Org-level settings are defined in `.github/settings.yml`
<br> :wave:`NOTE:` It is possible to overrride this behavior and specify a different filename for the `settings` yml repo.
This could be done by setting an `env` variable called `SETTINGS_FILE_PATH`.
> **Note** It is possible to overrride this behavior and specify a different filename for the `settings` yml repo.<br>
> This could be done by setting an `env` variable called `SETTINGS_FILE_PATH`.
1. `Suborg` level settings. A `suborg` is an arbitrary collection of repos belonging to projects, business units, or teams. The `suborg` settings reside in a yaml file for each `suborg` in the `.github/suborgs` folder.
1. `Repo` level settings. They reside in a repo specific yaml in `.github/repos` folder
1. It is recommended to break the settings into org-level, suborg-level, and repo-level units. This will allow different teams to define and manage policies for their specific projects or business units. With `CODEOWNERS`, this will allow different people to be responsible for approving changes in different projects.

:wave:`NOTE:` `Suborg` and `Repo` level settings directory structure cannot be customized.
> **Note** `Suborg` and `Repo` level settings directory structure cannot be customized.
:wave:`NOTE:` The settings file must have a `.yml` extension only. `.yaml` extension is ignored, for now.
> **Note** The settings file must have a `.yml` extension only. `.yaml` extension is ignored, for now.
## How it works

Expand All @@ -45,7 +45,7 @@ To apply `safe-settings` __only__ to a specific list of repos, add them to the `

To ignore `safe-settings` for a specific list of repos, add them to the `restrictedRepos` section as `exclude` array.

**Note**: The `include` and `exclude` attributes support as well regular expressions.
> **Note** The `include` and `exclude` attributes support as well regular expressions.
### Custom rules

Expand Down

0 comments on commit ef55548

Please sign in to comment.