Skip to content

Commit

Permalink
Merge pull request #584 from cghyzel/branch-reviewers-docs
Browse files Browse the repository at this point in the history
Fix Branched-Based Review Policies Doc
  • Loading branch information
vim-zz committed Sep 12, 2024
2 parents d255571 + ebd7d50 commit 61023f0
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 10 deletions.
7 changes: 6 additions & 1 deletion docs/automations/standard/branch-management/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,19 @@ Use gitStream to enforce branch naming conventions, review assignment, and other

[Enforce Branch Naming Conventions](#enforce-branch-name) - Automatically enforce prefixes or keywords in PR branch names.

[Assign Reviewers Based on Target Branch](#review-target-branch) - Automatically assign PR reviewers for target branches that include a specified keyword.
[Branch-Based Review Policies](#review-branch) - Automatically assign PR reviewers for target branches that include a specified keyword.


<a name="enforce-branch-name"></a>
## Enforce Branch Naming Conventions

--8<-- "docs/automations/standard/branch-management/enforce-branch-name/README.md:example"

<a name="review-branch"></a>
## Branch-Based Review Policies

--8<-- "docs/automations/standard/review-assignment/review-branch/README.md:example"

## Additional Resources

--8<-- "docs/snippets/general.md"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ automations:
{% endfor %}

branches:
- prefix: r/^ABC/
- name: ABC
prefix: r/^ABC/
reviewers: org/a-team
name: ABC
- prefix: r/^XYZ-/
- name: XYZ
prefix: r/^XYZ-/
reviewers: org/x-team
name: XYZ
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,11 @@ automations:
{% endfor %}

branches:
- prefix: r/^release/
- name: Release
prefix: r/^release/
reviewers: org/release-team
reviews: 4
name: Release
- prefix: r/^experimental-/
reviews: 1
name: Experimental
- name: Experimental
prefix: r/^experimental-/
reviewers: org/experiment-team
reviews: 1

0 comments on commit 61023f0

Please sign in to comment.