You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-7
Original file line number
Diff line number
Diff line change
@@ -5,21 +5,21 @@
5
5
`Safe-settings`– an app to manage policy-as-code and apply repository settings to repositories across an organization.
6
6
7
7
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.
8
-
<br> :wave:`NOTE:` It is possible to overrride this behavior and specify a custom repo instead of the `admin` repo.
9
-
This could be done by setting an `env` variable called `ADMIN_REPO`.
8
+
> **Note** It is possible to overrride this behavior and specify a custom repo instead of the `admin` repo.<br>
9
+
> This could be done by setting an `env` variable called `ADMIN_REPO`.
10
10
11
11
1. There are 3 levels at which the settings could be managed:
12
12
1. Org-level settings are defined in `.github/settings.yml`
13
-
<br> :wave:`NOTE:` It is possible to overrride this behavior and specify a different filename for the `settings` yml repo.
14
-
This could be done by setting an `env` variable called `SETTINGS_FILE_PATH`.
13
+
> **Note** It is possible to overrride this behavior and specify a different filename for the `settings` yml repo.<br>
14
+
> This could be done by setting an `env` variable called `SETTINGS_FILE_PATH`.
15
15
16
16
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.
17
17
1.`Repo` level settings. They reside in a repo specific yaml in `.github/repos` folder
18
18
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.
19
19
20
-
:wave:`NOTE:``Suborg` and `Repo` level settings directory structure cannot be customized.
20
+
> **Note**`Suborg` and `Repo` level settings directory structure cannot be customized.
21
21
22
-
:wave:`NOTE:` The settings file must have a `.yml` extension only. `.yaml` extension is ignored, for now.
22
+
> **Note** The settings file must have a `.yml` extension only. `.yaml` extension is ignored, for now.
23
23
24
24
## How it works
25
25
@@ -45,7 +45,7 @@ To apply `safe-settings` __only__ to a specific list of repos, add them to the `
45
45
46
46
To ignore `safe-settings` for a specific list of repos, add them to the `restrictedRepos` section as `exclude` array.
47
47
48
-
**Note**: The `include` and `exclude` attributes support as well regular expressions.
48
+
> **Note** The `include` and `exclude` attributes support as well regular expressions.
0 commit comments