Skip to content

Commit 5583247

Browse files
authored
Add rule template. (#256)
* Add rule template. * Download nicely.
1 parent fc406dc commit 5583247

4 files changed

Lines changed: 68 additions & 3 deletions

File tree

blog/2026/04-kamaji/index.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,7 @@ authors: [mac641, ma-hartma]
88
type: "blog"
99
tags:
1010
- architecture
11-
- kamaji
12-
- mini-lab
1311
- cluster-api
14-
- cluster-api-provider-metal-stack
1512
---
1613

1714
We are happy to announce that

community/05-release-flow.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ Before adding a repository in the metal-stack org to the releases repository, it
5959
- When a repository is created, the metal-robot automatically creates a <repository-name>-maintainers team in our GitHub org.
6060
- The CODEOWNERS file should reference this team.
6161
- The team should contain at least two maintainers.
62+
- It can also make sense to define sub-maintainer teams for specific parts of the repository. For this, teams need to be created manually by the org admin.
6263
- `LICENSE`
6364
- This usually should be MIT with "metal-stack" as authors.
6465
- `README.md`
@@ -70,6 +71,7 @@ Before adding a repository in the metal-stack org to the releases repository, it
7071
- A pull request should be required before merging (required by at least one code owner).
7172
- Status checks should be required to pass.
7273
- Force push should not be allowed on this branch.
74+
- You can import <a href="/files/ruleset-template.json" target="_blank" download="ruleset-template.json">this rule template</a> to set the rules
7375
- One person from the releases maintainers has to add the repository to the metal-robot in order to pick up the releases, add them to the release vector and generate release notes.
7476

7577
### How-To Release a Project

docusaurus.config.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ const config: Config = {
1010
"Bring the cloud to your data center. metal-stack is an open source software that provides an API for provisioning and managing physical servers in the data center.",
1111
favicon: "img/favicon.ico",
1212

13+
staticDirectories: ['static'],
14+
1315
// Set the production url of your site here
1416
url: "https://metal-stack.io",
1517
// Set the /<baseUrl>/ pathname under which your site is served

static/files/ruleset-template.json

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
{
2+
"name": "main",
3+
"target": "branch",
4+
"source_type": "Repository",
5+
"enforcement": "active",
6+
"conditions": {
7+
"ref_name": {
8+
"exclude": [],
9+
"include": [
10+
"~DEFAULT_BRANCH"
11+
]
12+
}
13+
},
14+
"rules": [
15+
{
16+
"type": "deletion"
17+
},
18+
{
19+
"type": "non_fast_forward"
20+
},
21+
{
22+
"type": "required_status_checks",
23+
"parameters": {
24+
"strict_required_status_checks_policy": false,
25+
"do_not_enforce_on_create": false,
26+
"required_status_checks": [
27+
{
28+
"context": "go-build / Go Build",
29+
"integration_id": 15368
30+
},
31+
{
32+
"context": "go-build / Go Test",
33+
"integration_id": 15368
34+
},
35+
{
36+
"context": "go-build / Go Lint",
37+
"integration_id": 15368
38+
}
39+
]
40+
}
41+
},
42+
{
43+
"type": "pull_request",
44+
"parameters": {
45+
"required_approving_review_count": 1,
46+
"dismiss_stale_reviews_on_push": false,
47+
"required_reviewers": [],
48+
"require_code_owner_review": true,
49+
"require_last_push_approval": false,
50+
"required_review_thread_resolution": false,
51+
"allowed_merge_methods": [
52+
"squash"
53+
]
54+
}
55+
}
56+
],
57+
"bypass_actors": [
58+
{
59+
"actor_id": 2,
60+
"actor_type": "RepositoryRole",
61+
"bypass_mode": "always"
62+
}
63+
]
64+
}

0 commit comments

Comments
 (0)