Skip to content

Commit 60f921e

Browse files
committed
ci: document branch and tag protections
1 parent b5a54d5 commit 60f921e

1 file changed

Lines changed: 35 additions & 0 deletions

File tree

docs/ci-cd/branch-and-tag-rules.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Branch and Tag Rules
2+
3+
This repository should protect the public operating model through rulesets.
4+
5+
## Recommended `main` rules
6+
7+
- require pull request before merge
8+
- require status checks
9+
- require CODEOWNERS review when available
10+
- block force pushes
11+
- block deletion
12+
- keep history linear if desired
13+
14+
## Recommended tag rules
15+
16+
- protect `v*` release tags
17+
- block tag deletion
18+
- block tag force updates
19+
- require release workflow for public releases
20+
21+
## Approval flow
22+
23+
```mermaid
24+
flowchart TD
25+
PR[Pull Request] --> Checks[Required checks]
26+
Checks --> Review[Review]
27+
Review --> Merge{Merge allowed?}
28+
Merge -- No --> Rework[Rework]
29+
Rework --> Checks
30+
Merge -- Yes --> Main[main]
31+
Main --> Tag{Release?}
32+
Tag -- Yes --> Approval[Release approval]
33+
Tag -- No --> Done[Done]
34+
Approval --> Release[Release]
35+
```

0 commit comments

Comments
 (0)