CI: validate that new GAP metadata id matches PR number - #57
Open
magicmark wants to merge 6 commits into
Open
Conversation
Per CONTRIBUTING.md, each GAP's `id` field in metadata.yml must match the PR number that introduces it. This adds a CI check that enforces this rule for PRs that add a new metadata.yml file. This would have caught the issue in #4 where the id was set to 2 instead of 4. Co-Authored-By: Claude <[email protected]>
Adds a dedicated workflow and script that enforces new GAP metadata.yml files have their `id` field set to the PR number, per CONTRIBUTING.md. Only runs on pull requests that add a new metadata.yml. Would have caught the issue in #4 where id was set to 2 instead of 4. Co-Authored-By: Claude <[email protected]>
Co-Authored-By: Claude <[email protected]>
Co-Authored-By: Claude <[email protected]>
Co-Authored-By: Claude <[email protected]>
Co-Authored-By: Claude <[email protected]>
magicmark
marked this pull request as ready for review
July 1, 2026 21:37
benjie
approved these changes
Sep 9, 2026
benjie
left a comment
benjie
left a comment
Member
There was a problem hiding this comment.
Looks good to me; only change I'd make is to make it a .ts file rather than a .js file so we can benefit from types - but I wouldn't hold it up on that.
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
2 participants
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.
Adds a dedicated workflow (
validate-new-gap-number.yml) to that new GAPmetadata.ymlfiles have theiridfield set to the PR number, per CONTRIBUTING.md.Only runs on pull requests that add a new GAP.
cc @martinbonnin