new local scheme of dirty-tag for developer installation#191
Merged
Conversation
When we install RecordLinker into an environment, a version number is automatically calculated from git data using setuptools scm. If the HEAD is a version tag, then the version is automatcailly calculated to be that. In development environments though, we take the last version and add a "post.0" to it, showing its a new release post the last named one. Additionally, we were previouslly calculating a timestamp to add to that "post.0" value based on when HEAD was committed. This worked most of the time, however if the developer has a dirty index, the wheel wouldn't build correctly. We don't need that, and its fine if a developer tries to install / reinstall RecordLinker in an environment with a dirty index. So to get around that, we'll stop adding the timestamp to the end of "post.0" and instead just call it "post.0+dirty" (if the index is indeed dirty).
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #191 +/- ##
=======================================
Coverage 97.51% 97.51%
=======================================
Files 31 31
Lines 1486 1486
=======================================
Hits 1449 1449
Misses 37 37 ☔ View full report in Codecov by Sentry. |
m-goggins
approved these changes
Feb 4, 2025
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.
Description
When we install RecordLinker into an environment, a version number is automatically calculated from git data using setuptools scm. If the HEAD is a version tag, then the version is automatically calculated to be that. In development environments, though, we take the last version and add a "post.0" to it, showing it's a new release post the last named one.
Additionally, we were previously calculating a timestamp to add to that "post.0" value based on when HEAD was committed. This worked most of the time, however if the developer has a dirty index, the wheel wouldn't build correctly. We don't need that, and it's fine if a developer tries to install / reinstall RecordLinker in an environment with a dirty index. So to get around that, we'll stop adding the timestamp to the end of "post.0" and instead just call it "post.0+dirty" (if the index is indeed dirty).
<--------------------- REMOVE THE LINES BELOW BEFORE MERGING --------------------->
Checklist
Please review and complete the following checklist before submitting your pull request:
Checklist for Reviewers
Please review and complete the following checklist during the review process: