Catch untracked files (and make version.sh work on shallow checkouts) #1324
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
Use "git describe --always" to silence "No names found, cannot describe anything." messages on shallow checkouts where the last tagged release may not be available. Where this is the case, git describe --always returns the short commit hash. This is appended to the hard-coded version number to make something similar to the normal git describe output. As we don't know how many commits there are from the last tag in this case, that part is set to 1 for want of anything better.
|
An example of an untracked file being caught can be seen in https://github.com/daviesrob/htslib/runs/3403088881 |
|
Perhaps add something to the untracked message along the lines of “Please either clean up, or add to .gitignore, or for test output files consider naming them to match |
Adds a check for untracked files after the tests have run. This is enabled for two builds - one with configure, and one without. The others skip the new test so that it's still possible to see that a proposed change works irrespective of issues with untracked files.
daviesrob
force-pushed
the
catch-untracked
branch
from
ba589fb
to
5d9c568
Compare
|
The updated text is a bit long, but it's a useful hint so I've added it, thanks. |
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.
This PR contains two commits. The first fixes
version.shso that it works on--depth=1clones of the repository. This both gets rid of the annoying "No names found, cannot describe anything." messages that were printed becausegit describecouldn't find a tag; and it also makes theversion.shreport a correct-ish version string on such clones.The second commit adds CI test support to catch any untracked files that make be present after build and test. Finding such files usually means they need to be added to
.gitignore.