[enhancement] change versioning format for local builds #2413
Conversation
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
13 tasks
| return os.environ["SKLEARNEX_VERSION"] | ||
| output = time.strftime("%Y.%#m.%#d+" if IS_WIN else "%Y.%-m.%-d+") | ||
| try: | ||
| return output + subprocess.check_output(["git", "rev-parse", "--short", "HEAD"]).decode("ascii").strip() |
There was a problem hiding this comment.
Why decode specifically as ascii? What happens if the system has a different encoding (such as UTF8) and the commit contains a non-ascii character?
|
@icfaust Could this perhaps try to detect if it is being built from a release branch? |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
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
Follow-on to #2409 which will switch how we write the version for local/prototype builds (which will solve this code comment): #2409 (comment)
It will use subprocess to call git to yield the short form of the commit. If sklearnex is not built in a repo (which users can download the source code without git via a .zip file), then it must still function, so a try catch is added on the case of failure when the subprocess fails, and will revert to the hour time second format.
A
+is used instead of a.upon request.Please see public CI for verification.
PR should start as a draft, then move to ready for review state after CI is passed and all applicable checkboxes are closed.
This approach ensures that reviewers don't spend extra time asking for regular requirements.
You can remove a checkbox as not applicable only if it doesn't relate to this PR in any way.
For example, PR with docs update doesn't require checkboxes for performance while PR with any change in actual code should have checkboxes and justify how this code change is expected to affect performance (or justification should be self-evident).
Checklist to comply with before moving PR from draft:
PR completeness and readability
Testing
Performance