From 2c7770a4041b768187c4efd65509c0f0b8ba036d Mon Sep 17 00:00:00 2001 From: dtzp555 Date: Sun, 8 Mar 2026 22:12:38 +1000 Subject: [PATCH] docs: simplify repo rule detector example --- README.md | 64 ++++++++++++------------------------------------------- 1 file changed, 14 insertions(+), 50 deletions(-) diff --git a/README.md b/README.md index ddefa0a..561d332 100644 --- a/README.md +++ b/README.md @@ -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 ``` -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 { "repo": "dtzp555-max/ocm", - "url": "https://github.com/dtzp555-max/ocm", - "defaultBranch": "main", "branch": "main", - "allowedMergeMethods": { - "mergeCommit": true, - "squash": true, - "rebase": true - }, - "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 - } - } - } - ] + "summary": { + "pullRequestRequired": true, + "linearHistoryRequired": true, + "nonFastForwardBlocked": true, + "allowedMergeMethods": ["merge", "squash", "rebase"] + } } ```