Skip to content

Commit 6e335f4

Browse files
authored
Merge pull request #553 from linear-b/admin-restrictions
Admin restrictions
2 parents 4c93e9e + f672e43 commit 6e335f4

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

docs/cm-file.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,9 @@ The `config` section in the `.cm` file is optional and specifies settings that a
120120

121121
##### `config.admin.users`
122122

123-
When specified in `gitstream.cm` the `config.admin.users` allows adding admin rights, when a PR changes the `*.cm` files only, if the user is listed in `config.admin.users` the PR will be then approved by gitStream. For example, setting `popeye` as admin:
123+
When specified in `gitstream.cm`, the `config.admin.users` allows adding admin rights. When a PR changes the `*.cm` files only, if the user is listed in `config.admin.users`, the PR will be approved by gitStream. Furthermore, if an admin is defined, they will automatically be requested to review changes in PRs that change rules files and will also be set as a required reviewer, meaning gitStream will block the merge until the admin approves the PR.
124+
125+
For example, setting `popeye` as admin:
124126

125127
```yaml title="example"
126128
config:
@@ -132,6 +134,8 @@ This configuration is valid only when used in `.cm/gitstream.cm`, when defined i
132134

133135
When you add a user to `config.admin.users` in your organization's `cm` repository, they are granted administrative privileges to CM changes across **every repository** in the organization. gitStream evaluates CM rules in the individual repository **and** your organization's `cm` repository to determine admin users.
134136

137+
When you add a user to `config.admin.users` in your repository's `.cm/gitstream.cm` file, they are granted administrative privileges to CM changes within that specific repository. However, if an organization-level admin is already defined in your organization's `cm` repository, then the organization-level admin approval is required for that change to take effect.
138+
135139
##### `config.ignore_files`
136140

137141
The `config.ignore_files` supports glob pattern matching that contains a list of files to ignore.

0 commit comments

Comments
 (0)