Print actionable error message when --check finds stale files#3487
Open
immanuwell wants to merge 1 commit into
Open
Print actionable error message when --check finds stale files#3487immanuwell wants to merge 1 commit into
immanuwell wants to merge 1 commit into
Conversation
immanuwell
requested review from
a team,
alolita,
austinlparker,
jpkrohling,
maryliag,
mtwo,
mx-psi,
svrnm,
tedsuo and
trask
as code owners
|
|
immanuwell
force-pushed
the
check-mode-error-message
branch
from
44b4a04 to
b62598d
Compare
Previously both update-sig-tables.py and update-community-members.py
silently exited with code 1 when run in --check mode and the generated
file was out of date, making CI failures hard to diagnose. Now they
print a clear message to stderr naming the file and the remediation
command ('make generate').
Signed-off-by: immanuwell <pchpr.00@list.ru>
immanuwell
force-pushed
the
check-mode-error-message
branch
from
b62598d to
268e5ab
Compare
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.
Summary
update-sig-tables.pyandupdate-community-members.pysupport--checkmode (used bymake check-generatein CI).When generated file is out of date, they currently exit with code 1 but print no output - leaving developers with only a bare exit-code failure in CI logs and no indication of which file is stale or how to fix it.
This PR adds a one-line
stderrmessage in both scripts so failure is self-explanatory:The success path (exit 0, no output) is unchanged
Test plan
python3 scripts/update-sig-tables.py --check-> exit 0, no output (files are up to date)python3 scripts/update-community-members.py --check-> exit 0, no outputREADME.md-> exit 1 + message on stderrcommunity-members.md-> exit 1 + message on stderrpython3 scripts/validate-workstreams.pystill passes