Document how to run the CI checks locally - #38
Merged
Merged
Conversation
Contributors had no way to reproduce the new CI gate without reading the workflow YAML. Spell out the metadata validation, the init-script lint, and the build + smoke test, plus the rule that config.yaml version must match the newest CHANGELOG heading.
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
1 participant
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.
Contributors had no way to reproduce the CI gate without reading the workflow YAML.
Adds a Running the checks locally subsection to Contributing covering the metadata validation, the init-script lint, and the build + smoke test, plus the rule that
cups/config.yamlversionmust match the newestCHANGELOG.mdheading.This PR is also the end-to-end verification of the auto-merge setup: it is owner-authored and non-draft, so
auto-merge.ymlshould enable squash auto-merge on its own, and the PR should merge and delete its branch oncecipasses — with no manual merge.