No project description provided
Project description
autocalver
Tired of "bumping versions"? Sick of commits, pull requests, tags, and a lot of manual work just to release the code that is already in the main branch?
The
autocalver
package is here to automatically generate
"calendar versions",
and chew gum,
and it's all out of gum.
It automatically produces a calver based on a commit log.
The version depends on the
time of the commit,
not the time of the build.
The version format is
<year>.<month>.<day>.<seconds from beginning of day>
.
The time is always converted to UTC first.
Configuration
The right way to make sure
autocalver
is installed is to require it in
pyproject.toml
:
[build-system]
requires = ["setuptools>=45", "wheel", "autocalver"]
Note that
autocalver
will
not
run any version-control commands.
Before using
autocalver
,
run a command to pull a prefix of the commit log,
and save it to a file.
For example,
with
git
,
you can use
git log -n 1 --date=iso > git-log-head
One advantage of separating the stages like that is that it is possible to have the package builder itself running in an environent that does not have access to the version control metadata, only the source files and the prefix of the commit log. Failing to produce the log will cause the package build to fail.
The tool overrides the version in the
setup.cfg
.
Configuration is done via
pyproject.toml
.
For example,
a configuration appropriate to
pipeline CI might be:
[tool.autocalver]
use = true
log = "git-log-head"
is_main_var = "BUILD_BRANCH_REF"
is_main_match = ".*/main$"
Note that if you use the
[project]
entry in
pyproject.toml
,
it must:
- Not have
version
- Explicitly declare
dynamic = ["version"]
Building packages
Based on the given environment variable and its value the version is produced as development, rc, or a full-release. This allows checking against a release-system's environment variables for the branch, pull request, or workflow name.
With this configuration, the following versions will be produced (asssuming the time of the latest commit is October 10, 2021, 8:39:44 in Pacific time).
Local build:
$ python -m build -n --wheel 2>& 1| tail -1
Successfully built fake_package-2021.10.10.56384.dev1-py3-none-any.whl
Note that the version has a
dev1
in its name.
Simulate tagged build:
$ GITHUB_REF=refs/tags/test-fix-PROJ-121 python -m build -n --wheel 2>& 1| tail -1
Successfully built fake_package-2021.10.10.56384rc1-py3-none-any.whl
This version has an
rc1
in the name,
marking it as a pre-release.
This allows pushing tags to produce packages
and test fixes.
However,
since tag pushes are not reviewed,
these do not produce releases.
Simulate merge to main:
$ GITHUB_REF=refs/heads/main python -m build -n --wheel 2>& 1| tail -1
Successfully built fake_package-2021.10.10.56384-py3-none-any.whl
Note that without
use = true
,
the tool will not replace the version.
If
use = true
is there,
missing any of the other variables
will cause an
error
during the build,
as a non-existing build
is better than a broken when.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for autocalver-2023.4.26.74472rc1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f09812d98d4f2ee881ea5dffacdf591d6c604c7e5b6759e1329989fd8e5637c5 |
|
MD5 | 51c0426e25cbd08f14e375516d31e4d0 |
|
BLAKE2b-256 | 7a002f2350f8a49396a56c8327bdfbc810772a55a7201d12d84f9f00204078c4 |
Hashes for autocalver-2023.4.26.74472rc1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a3efefaf60421bce8e3b72faf9d28d69c0d58ae400695df5e81cebf05185a5e0 |
|
MD5 | a027e4459f4cdfc25777edcc3c4f0e24 |
|
BLAKE2b-256 | e0cbb27fc40c99a2d1204e5180fdc3b765deb5ad1fc082a2aa4647eb80997d7b |