Repository navigation
Store Required Checks within the repo - #1871
Merged
Merged
Conversation
exercism/maintainers-admin-tools reads .github/required-checks.yml and applies it to this repo's "Default branch" ruleset. The required-checks workflow fails a PR when a listed check didn't run on it, so a wrong name can't block every PR. The Ruby version matrix jobs aren't listed, because their names change when a version is bumped. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
iHiD
commented
Nov 7, 2026
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
iHiD
changed the title
The workflow now runs on every PR and passes straight away when the PR changes neither required-checks.yml nor a workflow. That lets it be listed as a required check, so a PR that breaks the list can't be merged past a red X. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This reverts commit 6c2443a. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
It lists itself in required-checks.yml, but it leaves itself out of the checks it waits for, so it reported its own name as missing. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.
Currently, "required checks" on PRs are hidden from maintainers, and can get out of sync with the reality of a repo. To fix this, we're adding a
.github/required-checks.ymlfile, which lists the checks that must pass before a PR can merge into main.When this file is changed, the ruleset that manages branch protection automatically gets synced up. The new
Required checksworkflow checks that all the checks listed inrequired-checks.ymlexist.(Sidenote: I'm increasingly wary of agents that have access to GitHub mistakenly (or potentially nefariously) doing things that could do us damage or cause us to have unexpected or high costs. That's why I'm using CODEOWNERS on a more frequent basis for files that are always worth just getting a second pair of eyes on. It's not a reflection on trust for maintainers 🙂)
The file adds the following Required Checks:
configlet / configleti18n / completenessCheck Generator TemplatesTest GeneratorValidate required checks(rather recursively, I admit!)For many repos (including Ruby), the exercise tests are named with version (e.g.
Ruby 3.3 - ubuntu-24.04 - pull_requestandRuby 3.4 - ubuntu-24.04 - pull_request). Those names change whenever a version is bumped, which is quite unstable, and then the required checks break. I'm going to fix that separately by adding a check with a more standard name (e.g. "tests"), which can rely on the unstably named tests, and add that to this file. That'll be a separate PR.