Skip to content

docs: clarify ruleset pass-through and supported target types #205

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
joshjohanning merged 1 commit into from
May 20, 2026
Merged

docs: clarify ruleset pass-through and supported target types #205

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -331,6 +331,8 @@ repos:
- Updates the ruleset if a ruleset with the same name already exists
- Rulesets are identified by the `name` field in each JSON configuration
- Each JSON file should contain a valid ruleset configuration matching the [GitHub Rulesets API schema](https://docs.github.com/en/rest/repos/rules)
- Ruleset JSON is passed through to the GitHub API as-is (read-only fields like `id`, `source`, `source_type`, `created_at`, `updated_at`, `_links`, and `current_user_can_bypass` are stripped automatically), so any rule type or parameter supported by the API will sync — no action update required when GitHub adds new ones
- All `target` values supported by the API work: `branch` (default), `tag`, and `push`. It's recommended to set `target` explicitly in each ruleset JSON file to avoid ambiguity

**Example Ruleset JSON (`ci-ruleset.json`):**

Expand Down
Loading