docs: clarify ruleset pass-through and supported target types#205
Merged
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
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
targettypes are supported (includingbranch,tag, andpush) and recommend settingtargetexplicitly.
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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Clarifies two things about ruleset syncing that weren't obvious from the existing docs:
id,source,source_type,created_at, etc. stripped automatically). That means new rule types and parameters GitHub adds, such ascopilot_code_review.parameters.review_draft_pull_requests, sync without needing an action update.targetvalues the API supports work, not justbranch. Calls outbranch(default),tag, andpush, and recommends settingtargetexplicitly in each ruleset JSON file.README-only change; existing examples already include
"target": "branch"so no example edits were needed.