Enforce the house style and script the release tag - #7
Merged
Merged
Conversation
Signed-off-by: Alexander Wang <87671725+alexander-wang03@users.noreply.github.com>
Signed-off-by: Alexander Wang <87671725+alexander-wang03@users.noreply.github.com>
Signed-off-by: Alexander Wang <87671725+alexander-wang03@users.noreply.github.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.
What this changes
Turns three lessons from the 0.3 cycle into checks:
tools/check_style.pyfails CI on em-dashes and the six banned words,tools/release_check.pyfails when emet-hal's README does not name every entry point the package registers, andtools/tag_release.pymakes the signed release tag after refusing a dirty tree, the wrong branch, a version the packages do not declare, or a missing signing key. CONTRIBUTING.md and RELEASING.md describe them.Why
Each check replaces a rule a person kept missing: 178 em-dashes passed review over three releases, the HAL README shipped 0.3 naming four of eleven plugins, and v0.3 first went up as an unsigned tag. A rule a person applies gets skipped; a check does not.
Checklist
git commit -s). See CONTRIBUTING.md.python tools/check_layering.py .andpython tools/release_check.py .pass.pytestpasses inemet-sdk,emet-halandemet-engine.If this touches the contract layer
Leave blank: it does not.
P0,RSV, orV1in DESIGN.md.Design rules
emet_sdkimports nothing internal;emet_halandemet_engineimportemet_sdkonly.