Skip to content

Required check "check-drift" is path-filtered, so doc-only PRs can never merge #339

Open

Description

@sanity

The ruleset requires a status check that is produced by a path-filtered workflow. A PR touching only documentation never triggers it, so the check sits in the "expected" state forever and the PR is permanently unmergeable.

--admin does not help; the ruleset rejects the merge with:

GraphQL: Repository rule violations found
Required status check "<name>" is expected.

Hit while trying to land an AGENTS.md-only cleanup. The same shape exists in at least one sibling repo, so it is worth fixing consistently.

Why it matters beyond the inconvenience: a required check that cannot run is not a gate, it is a deadlock. The usual workaround is to fold the doc change into an unrelated code PR so the check fires, which is worse for review quality than either change on its own.

Standard fixes (pick one):

  • Add a companion job with the same check name in a workflow without path filters that short-circuits to success when the filtered paths are untouched (the "skip job" / dorny/paths-filter pattern), so the required context is always reported.
  • Drop the check from the required set and let it fire only on the paths it actually guards.
  • Remove the path filter and have the job exit early when nothing relevant changed.

The first keeps the guarantee you actually want: required whenever it is meaningful, green when it is not applicable.

[AI-assisted - Claude]

https://claude.ai/code/session_013Z1d56AdCUrCvWauK5kGTL

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions