Skip to content

doc: rulesets for branch and tag naming #501

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

Merged
merged 3 commits into from
Sep 24, 2024
Merged

doc: rulesets for branch and tag naming #501

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
49e0be7
doc: rulesets for branch and tag naming
jorgepiloto Sep 19, 2024
5e61f02
fix: move content to the right section
jorgepiloto Sep 19, 2024
6f95b4b
Merge branch 'main' into doc/rulesets
jorgepiloto Sep 24, 2024
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
14 changes: 14 additions & 0 deletions doc/source/how-to/repository-protection.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,20 @@ The PyAnsys core team recommends setting these rules for the ``main`` branch:
go through and resolve all comments. This ensures that all comments are read and
possibly applied.

For other branches, conventional commits can be enforced by creating a rule
with the following parameters:

- Enforcement status: ``Active``
- Target branches:
- Include: ``All branches``
- Exclude: ``main``, ``gh-pages``

- Restrict branch names:
- Applies to: ``Branch name``
- Requirement: ``Must match a given regex pattern``
- Matching pattern: ``^(feat|fix|chore|docs|style|refactor|test|perf|ci|build|dependabot|release)\/.*``
- Description: ``Branch name must match the conventional commits pattern``

Tag protection
--------------

Expand Down
Loading