docs: simplify repo rule detector example

This commit is contained in:
2026-03-08 22:12:52 +10:00
parent 28b0c22a3f
commit 2c7770a404
+14 -50
View File
@@ -74,61 +74,25 @@ If you need to quickly see what GitHub repo rules might block merges (repo rules
node scripts/repo-rule-detector.mjs dtzp555-max/ocm --branch main node scripts/repo-rule-detector.mjs dtzp555-max/ocm --branch main
``` ```
Example output (dtzp555-max/ocm): Example summary (dtzp555-max/ocm):
- PRs required before merging: yes
- Linear history required: yes
- Non-fast-forward pushes blocked: yes
- Allowed merge methods: merge, squash, rebase
Minimal JSON view:
```json ```json
{ {
"repo": "dtzp555-max/ocm", "repo": "dtzp555-max/ocm",
"url": "https://github.com/dtzp555-max/ocm",
"defaultBranch": "main",
"branch": "main", "branch": "main",
"allowedMergeMethods": { "summary": {
"mergeCommit": true, "pullRequestRequired": true,
"squash": true, "linearHistoryRequired": true,
"rebase": true "nonFastForwardBlocked": true,
}, "allowedMergeMethods": ["merge", "squash", "rebase"]
"rulesetsRulePresence": { }
"required_linear_history": true,
"non_fast_forward": true,
"deletion": true
},
"branchProtection": {
"enabled": false
},
"rulesets": [
{
"id": 13362557,
"name": "ocm",
"enforcement": "active",
"target": null,
"rules": {
"pull_request": {
"present": true,
"parameters": {
"required_review_thread_resolution": true,
"allowed_merge_methods": [
"merge",
"squash",
"rebase"
],
"required_approving_review_count": 0,
"require_code_owner_review": false,
"dismiss_stale_reviews_on_push": false,
"require_last_push_approval": false
}
},
"required_linear_history": {
"present": true
},
"non_fast_forward": {
"present": true
},
"deletion": {
"present": true
}
}
}
]
} }
``` ```