Skip to content

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

Merged
joshjohanning merged 1 commit into
mainfrom
joshjohanning/docs-ruleset-target-types
May 20, 2026
Merged

docs: clarify ruleset pass-through and supported target types#205
joshjohanning merged 1 commit into
mainfrom
joshjohanning/docs-ruleset-target-types

Conversation

@joshjohanning

Copy link
Copy Markdown
Owner

Clarifies two things about ruleset syncing that weren't obvious from the existing docs:

  • The action passes ruleset JSON through to the GitHub Rulesets API as-is (with read-only fields like id, source, source_type, created_at, etc. stripped automatically). That means new rule types and parameters GitHub adds, such as copilot_code_review.parameters.review_draft_pull_requests, sync without needing an action update.
  • All target values the API supports work, not just branch. Calls out branch (default), tag, and push, and recommends setting target explicitly in each ruleset JSON file.

README-only change; existing examples already include "target": "branch" so no example edits were needed.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings May 20, 2026 14:32

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the README documentation for the action’s repository ruleset syncing feature, clarifying how ruleset JSON is handled and what target values are supported.

Changes:

  • Document that ruleset JSON is effectively passed through to the Rulesets API, with known read-only API fields stripped automatically.
  • Clarify that all API-supported ruleset target types are supported (including branch, tag, and push) and recommend setting target explicitly.
Show a summary per file
File Description
README.md Clarifies ruleset pass-through behavior and supported target values for ruleset sync.

Copilot's findings

  • Files reviewed: 1/1 changed files
  • Comments generated: 0

@joshjohanning joshjohanning merged commit 03c17c1 into main May 20, 2026
5 checks passed
@joshjohanning joshjohanning deleted the joshjohanning/docs-ruleset-target-types branch May 20, 2026 14:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants