Repository navigation
LZ-197: document how required check-run names are derived - #13
Merged
Merged
Conversation
A ruleset matches a check run by exact name, and that name depends on how the job is wired: a caller stub yields "<caller job id> / <called job name>" while an inline job yields the bare job name. Nothing said so, so anyone writing a ruleset had to derive it from a live PR first. Records the convention (job id `build`, display name `Build and Test`), the gh incantation to resolve a repo's real check names, the three kinds of check that must never be marked required -- codecov, anything path-filtered, and out-of-band deploy checks -- and why a consumer needing job-level `services:`, a pre-build step or extra env keeps its build inline rather than this workflow growing knobs for one caller. No repo names here on purpose: this repo is public. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
RobFaustLZ
approved these changes
Sep 17, 2026
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.
Groundwork for putting the org's first merge gate on a product repo.
A branch ruleset matches a check run by exact name, and that name depends on how the job is wired — a caller stub yields
<caller job id> / <called job name>, an inline job yields the bare job name. Nothing in this repo said so, so anyone writing a ruleset had to rediscover it against a live PR first.Adds a
## Required checks: what the gate is calledsection covering:build, display nameBuild and Test)gh api .../check-runsincantation to resolve a repo's real names rather than reading YAMLcodecov/patch, anything path-filtered (the deadlock: a path-filtered required check never reports on a PR touching no matching paths, and that PR can never merge), and out-of-band deploy checksservices:, a pre-build step, or extra env beyondPACKAGES_*keeps its build inline instead of this workflow growing knobs for one callerDocs only — no workflow behaviour changes, and no release needed since
@v1isn't involved.No repo names appear in the added text, deliberately: this repo is public. The per-repo inventory lives in the ticket.
🤖 Generated with Claude Code