GitHub Safe Settings PR Reviewer

Reviews pull requests that modify GitHub Safe Settings YAML configuration files to ensure proper formatting, value validation, and conflict detection.

What This Skill Does

Automatically reviews PRs that change `.github/suborgs/*.yml`, `.github/repos/*.yml`, or `.github/settings.yml` files in repositories using the GitHub Safe Settings framework. Validates YAML formatting, checks for numeric actor_id values, and detects suborgrepos pattern conflicts.

Instructions

When a pull request modifies YAML configuration files in `.github/suborgs/`, `.github/repos/`, or `.github/settings.yml`:

Step 1: Check YAML Formatting

Verify all modified YAML files follow these rules:

Flag any lines that violate these rules with specific line numbers.

Step 2: Validate Actor IDs

Search for any `actor_id` fields in the configuration (commonly found in `bypass_actors`, branch protection rules, or ruleset configurations).

For each `actor_id` found:

**Valid actor_id examples:**

```yaml

bypass_actors:

- actor_type: RepositoryRole

actor_id: 5 # Repository admin role

- actor_type: Team

actor_id: 7737774 # Numeric team ID

- actor_type: OrganizationAdmin

actor_id: 1

```

**Common repository role IDs:**

Step 3: Detect Suborgrepos Conflicts

When files contain `suborgrepos:` lists with repository patterns:

1. Read ALL `.github/suborgs/*.yml` and `.github/repos/*.yml` files

2. Extract all `suborgrepos:` patterns from each file

3. Check if any patterns could match the same repositories

4. Report conflicts with file paths and example matching repositories

**Example conflict scenario:**

Step 4: Generate PR Comment

#### If Issues Found

Post a structured comment listing all issues:

```markdown

⚠️ Configuration Issues Found

YAML Formatting Issues

Value Issues

- Found: `actor_id: "admin"`

- Expected: `actor_id: 5` (for repository admin role)

Suborgrepos Conflicts

- Both could match repositories like `platform.api`, `platform.web`

**Please fix these issues before merging.**

```

#### If All Checks Pass

Post a success comment:

```markdown

✅ Configuration Looks Great!

Nice work! All checks passed:

Ready to merge! 🎉

```

Helpful Commands for Users

When suggesting fixes, include these commands:

```bash

Find numeric team ID

gh api /orgs/<org-name>/teams/<team-slug> --jq '.id'

Find user or GitHub App numeric ID

gh api /users/<username> --jq '.id'

Validate YAML formatting locally

yamllint .github/suborgs/*.yml .github/repos/*.yml

```

Constraints

References