Poetry plugin to get package version from git
Project description
Poetry Git Version Plugin
Poetry plugin to set package version based on git tag.
Functionality
- Git tag parsing
- Alpha version making
- Setting found or generated version as package poetry.version
- Maintenance of PEP 440
- Command to output a new version
Quick start
poetry self add poetry-git-version-plugin
poetry git-version # Write package version based on git tag
poetry build # Build package with version based on git tag
Dependencies
Installed Git
and:
[tool.poetry.dependencies]
python = ">=3.8"
poetry = ">=1.2.2"
Configs
MAKE ALPHA VERSION
If the tag is not found on the HEAD, then the version is built based on the last found tag and the HEAD.
- type: bool
- Default = true
- Result: 1.3.2a5
# Environment
export PACKAGE_VERSION_MAKE_ALPHA_VERSION=true
# pyproject.toml
[tool.poetry-git-version-plugin]
make_alpha_version = true
ALPHA VERSION FORMAT
Format for alpha version
- Type: str
- Default =
'{version}a{distance}'
- Example:
- alpha_version_format = '{version}a{distance}' ->
1.3.2a5
- alpha_version_format = '{version}a{distance}+{commit_hash}' ->
1.3.2a5+5babef6
- alpha_version_format = '{version}a{distance}' ->
- Available variables:
- version: Last found tag
- distance: Distance from last found tag to HEAD
- commit_hash: Commit hash
# Environment
export PACKAGE_VERSION_ALPHA_VERSION_FORMAT='{version}a{distance}'
# pyproject.toml
[tool.poetry-git-version-plugin]
alpha_version_format = '{version}a{distance}'
Ignore errors
Three variables to ignore errors
- Type: bool
- Default = true
# Ignore mismatch error PEP 440 version format
## Environment
export PACKAGE_VERSION_IGNORE_PEP440=true
## pyproject.toml
[tool.poetry-git-version-plugin]
ignore_pep440 = true
# Ignore mismatch error PEP 440 public version format
## Environment
export PACKAGE_VERSION_IGNORE_PUBLIC_PEP440=true
## pyproject.toml
[tool.poetry-git-version-plugin]
ignore_public_pep440 = true
# Ignore all errors
# including version not found errors
## Environment
export PACKAGE_VERSION_IGNORE_ERRORS=true
## pyproject.toml
[tool.poetry-git-version-plugin]
ignore_errors = true
Use cases
Publishing python package to pypi via poetry with version equal to git tag
.gitlab-ci.yml:
pypi:
stage: publishing
image: python:3.10
tags:
- docker
script:
- poetry self add poetry-git-version-plugin
- poetry config repositories.pypi https://upload.pypi.org/legacy/
- poetry config pypi-token.pypi ${PYPI_TOKEN}
- poetry publish -r pypi --build
rules:
- if: $CI_COMMIT_TAG
- if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
- When creating a git tag: new package with version == {TAG}
- When pushing to CI_DEFAULT_BRANCH: new package with version == {TAG}a{N}
Publishing python package to private pypi via poetry with version equal to git tag and commit hash
.gitlab-ci.yml:
pypi:
stage: publishing
image: python:3.10
tags:
- docker
script:
- export PACKAGE_VERSION_ALPHA_VERSION_FORMAT='{version}a{distance}+{commit_hash}'
- poetry self add poetry-git-version-plugin
- poetry config repositories.gitlab "https://gitlab.com/api/v4/projects/$CI_PROJECT_ID/packages/pypi"
- poetry config http-basic.gitlab gitlab-ci-token "$CI_JOB_TOKEN"
- poetry publish -r gitlab --build
rules:
- if: $CI_COMMIT_TAG
- if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
- When creating a git tag: new package with version == {TAG}
- When pushing to CI_DEFAULT_BRANCH: new package with version == {TAG}a{N}+{COMMIT_HASH}
Contribute
Issue Tracker: https://gitlab.com/rocshers/python/poetry-git-version-plugin/-/issues
Source Code: https://gitlab.com/rocshers/python/poetry-git-version-plugin
Before adding changes:
make install-dev
After changes:
make format test
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
Close
Hashes for poetry_git_version_plugin-1.0.0a1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a26f1d204aaf4616869c1b39f62a64dbeca0aed72e2c7b4ae5593ca610bd1398 |
|
MD5 | f080025767dd8cc7a2a1a3802ffd1911 |
|
BLAKE2b-256 | 7f9eaef75cf7d805203ce7bf49640c2247b20f58b284755df842fb1131ffbcda |
Close
Hashes for poetry_git_version_plugin-1.0.0a1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 86fc3f21726c5f25192cb94355c1529560012c8e9241102d33b339bbecf89d5b |
|
MD5 | 03af7b80f4d3c315c79b41f1514b0533 |
|
BLAKE2b-256 | 24ba37433e54fcb4ba180cf2165d04e98edf162e08fbceb7c5910ab6349bdfb0 |