Skip to content

Commit 06e96ff

Browse files
authored
doc: rulesets for branch and tag naming (#501)
* doc: rulesets for branch and tag naming * fix: move content to the right section
1 parent 62078b9 commit 06e96ff

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

doc/source/how-to/repository-protection.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,20 @@ The PyAnsys core team recommends setting these rules for the ``main`` branch:
7070
go through and resolve all comments. This ensures that all comments are read and
7171
possibly applied.
7272

73+
For other branches, conventional commits can be enforced by creating a rule
74+
with the following parameters:
75+
76+
- Enforcement status: ``Active``
77+
- Target branches:
78+
- Include: ``All branches``
79+
- Exclude: ``main``, ``gh-pages``
80+
81+
- Restrict branch names:
82+
- Applies to: ``Branch name``
83+
- Requirement: ``Must match a given regex pattern``
84+
- Matching pattern: ``^(feat|fix|chore|docs|style|refactor|test|perf|ci|build|dependabot|release)\/.*``
85+
- Description: ``Branch name must match the conventional commits pattern``
86+
7387
Tag protection
7488
--------------
7589

0 commit comments

Comments
 (0)