Skip to content

Update per CODE-4066 #11328

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Update per CODE-4066 #11328

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f1c398b
Update per CODE-4066
dewan-ahmed Aug 20, 2025
2aa6356
Add the same info to tag rules section.
dewan-ahmed Aug 20, 2025
2950ae4
Changes per Karan's feedback.
dewan-ahmed Aug 29, 2025
29cdd05
Merge branch 'main' into dewan-code4066
dewan-ahmed Aug 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 24 additions & 2 deletions docs/code-repository/config-repos/rules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,21 @@ If you configure branch rules at multiple levels they are combined with an `AND`
2. Select the **Rules** tab.
3. Select **New Branch Rule**.
4. Enter the rule **Name** and optional **Description**.
5. In **Target Patterns**, specify branches covered by this rule according to branch name globstar patterns, such as `string`, `feature-*`, or `releases/**`. You can also select whether the rule should apply to the default branch (such as `main`). Patterns can be inclusive or exclusive.
6. In **Bypass List**, you can specify users, user groups, and service accounts who can bypass this rule.
5. In **Target Patterns**, specify branches covered by this rule according to branch name globstar patterns, such as `string`, `feature-*`, or `releases/**`. You can also select whether the rule should apply to the default branch (such as `main`).

You have the option to include or exclude repositories when setting rules at the account, org, or project level. This allows you to fine-tune which repositories the rule applies to without forcing the rule across every repo. You can do this in two ways:

- **By selecting specific repositories** (for example, `billing-api`, `web-frontend`).
- **By using name patterns** (for example, `service-*`, `exp-*`).

Includes and excludes can be mixed, and excludes take precedence when there’s overlap.
Examples:
- Include by pattern: `service-*`
- Include specific repos: `billing-api`, `web-frontend`
- Exclude by pattern: `exp-*`
- Exclude a specific repo: `playground`

6. In **Bypass List**, you can specify users, user groups, or service accounts who can bypass this rule.
7. For each of the [**Rules**](#available-rules), select the rule you want to enable and provide additional specifications, if necessary. For example, if you select **Require a minimum number of reviewers**, you must specify the minimum number of reviewers.
8. Select **Create Rule**.

Expand Down Expand Up @@ -96,6 +109,15 @@ Check this box to activate the rule.

* `v*` for all version tags,
* `release/**` for nested release tags).
* You can include or exclude repositories when creating tag rules at the account, org, or project level. This makes it possible to scope rules precisely without forcing the rule across every repo. You can do this in two ways:
- **By selecting specific repositories** (for example, `billing-api`, `ui`).
- **By using name patterns** (for example, `prod-*`, `exp-*`).
* Includes and excludes can be mixed, and excludes take precedence when they overlap.
Examples:
- Include by pattern: `prod-*`
- Include specific repos: `billing-api`, `ui`
- Exclude by pattern: `exp-*`
- Exclude a specific repo: `playground`

#### Rules: Select all that apply

Expand Down