Skip to content

Commit

Permalink
new local scheme of dirty-tag for developer installation (#191)
Browse files Browse the repository at this point in the history
## 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).
  • Loading branch information
ericbuckley authored Feb 4, 2025
1 parent 5b5fe41 commit 8ea5fda
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ namespaces = false
[tool.setuptools_scm]
write_to = "src/recordlinker/_version.py"
version_scheme = "post-release"
local_scheme = "node-and-timestamp"
local_scheme = "dirty-tag"
fallback_version = "0.0.0"

[tool.ruff]
Expand Down

0 comments on commit 8ea5fda

Please sign in to comment.