tools: Add check-branch to run 'make check' on all branch commits #1214
Conversation
This file contains 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
zulipbot
added
size: S
Rohitth007
suggested changes
Apr 23, 2022
neiljp
force-pushed
the
2022-04-21-check-branch-script
branch
from
3cccce4
to
3a39312
Compare
This git command can be run manually, but is encoded here in a reproducible format via this script, supporting use by maintainers and new developers alike. The branch for comparison is defined by default as from the merge-base with upstream/main, though another comparison point can be specified as the first parameter, eg. HEAD~2 to check the last two commits, or main to specify the local main in case it differs from upstream/main. The `git --no-pager log -1` ensures it is clear which commit is being tested at each stage. Check taken from tools/fetch-pull-request to handle situation with uncommitted changes. Other tools updated to exclude testing this bash script.
neiljp
force-pushed
the
2022-04-21-check-branch-script
branch
from
3a39312
to
09accd4
Compare
If current branch has no differences from main, skip check. This would avoid checking a branch which simply makes changes and reverts them, but this should be a rare case, and otherwise avoids accidental extra testing of eg. main. By default the script uses upstream/main as the merge-base; in case the local main has differences, warn of this and require explicit specification of the merge-base as the first parameter in order to run the tool.
neiljp
force-pushed
the
2022-04-21-check-branch-script
branch
from
09accd4
to
6ac90a3
Compare
|
@Rohitth007 Thanks for the review and testing! Good to hear that this slightly revised version does work for you with the We can consider adding to the makefile, though by default this would limit being able to pass through an alternative merge-base. |
4 tasks
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 does this PR do?
This is a first pass at a script to ensure a branch has commits which individually pass
make check.Tested?
^ checked with this script!
Notes & Questions
This may become integrated into CI at some point, but an initial try at this turned out to be more complex than expected, so working with something we can easily run locally first.
I've not added documentation yet, since I'd like to let this get some simple testing first.
This script passes if it leaves you back at your branch; if it fails it leaves you at the failed commit, at which point you can
git rebase --abortand explore it more yourself, or use the rebase interactively.