Print hash with --version when installed as development - Githubissues

DataBiosphere / toil

A scalable, efficient, cross-platform (Linux/macOS) and easy-to-use workflow engine in pure Python.

http://toil.ucsc-cgl.org/.

Apache License 2.0

894 stars 241 forks source link

Print hash with --version when installed as development #4954

Closed stxue1 closed 3 months ago

stxue1 commented 4 months ago

It got annoying trying to figure out whether my installed Toil on the cluster was up to date with my commits, so this makes development builds print the hash.

Changelog Entry

To be copied to the draft changelog by merger:

--version with development builds will now also output the commit hash
- Ex, before: 7.1.0a1, After: 7.1.0a1-ccf57e6071e32675daabdcbacb91988e871745a9

Reviewer Checklist

[ ] Make sure it is coming from issues/XXXX-fix-the-thing in the Toil repo, or from an external repo.
- [ ] If it is coming from an external repo, make sure to pull it in for CI with:
```
contrib/admin/test-pr otheruser theirbranchname issues/XXXX-fix-the-thing
```
- [ ] If there is no associated issue, create one.
- [ ] Read through the code changes. Make sure that it doesn't have:
- [ ] Addition of trailing whitespace.
- [ ] New variable or member names in camelCase that want to be in snake_case.
- [ ] New functions without type hints.
- [ ] New functions or classes without informative docstrings.
- [ ] Changes to semantics not reflected in the relevant docstrings.
- [ ] New or changed command line options for Toil workflows that are not reflected in docs/running/{cliOptions,cwl,wdl}.rst
- [ ] New features without tests.
- [ ] Comment on the lines of code where problems exist with a review comment. You can shift-click the line numbers in the diff to select multiple lines.
- [ ] Finish the review with an overall description of your opinion.

Merger Checklist

[ ] Make sure the PR passes tests.
[ ] Make sure the PR has been reviewed since its last modification. If not, review it.
[ ] Merge with the Github "Squash and merge" feature.
- [ ] If there are multiple authors' commits, add Co-authored-by to give credit to all contributing authors.
[ ] Copy its recommended changelog entry to the Draft Changelog.
[ ] Append the issue number in parentheses to the changelog entry.

stxue1 commented 4 months ago

It would be good to post what the version strings actually look like before and after.

Before:

toil --version
7.1.0a1

After:

toil --version
7.1.0a1-ccf57e6071e32675daabdcbacb91988e871745a9

I can add it to the changelog note too