Compare commits
32 Commits
0.0.1.post
...
0.0.1.post
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
97612703b7 | ||
|
|
5bb8b35c73 | ||
|
|
a6c2513d9f | ||
|
|
70ef90a529 | ||
|
|
f728842a5a | ||
|
|
4837a99ac6 | ||
|
|
3e130e6bdf | ||
|
|
d7fbf52647 | ||
|
|
f5c97757b6 | ||
|
|
3c0e5bebc2 | ||
|
|
c5962d533b | ||
|
|
e9e25793d8 | ||
|
|
17f74d6675 | ||
|
|
264c51de2e | ||
|
|
ac942480cb | ||
|
|
be9ef684e4 | ||
|
|
792666c6ec | ||
|
|
2951e70c47 | ||
|
|
63b3f25b33 | ||
|
|
cefa964a3a | ||
|
|
38cde9d700 | ||
|
|
fff52596b1 | ||
|
|
3ce09a0194 | ||
|
|
961f92d9c6 | ||
|
|
a1cf4983ff | ||
|
|
c9e6f4f436 | ||
|
|
7d9f2a7792 | ||
|
|
a223500509 | ||
|
|
04578b3066 | ||
|
|
2598a41227 | ||
|
|
4e43629dfd | ||
|
|
05093566d6 |
75
Jenkinsfile
vendored
75
Jenkinsfile
vendored
@@ -126,11 +126,15 @@ pipeline {
|
||||
|
||||
sh("virtualenv --pip=embed --setuptools=embed --wheel=embed --no-periodic-update --activators bash,python BUILD_ENV")
|
||||
sh("virtualenv --pip=embed --setuptools=embed --wheel=embed --no-periodic-update --activators bash,python TEST_ENV")
|
||||
sh("virtualenv --pip=embed --setuptools=embed --wheel=embed --no-periodic-update --activators bash,python TOOLS_ENV")
|
||||
|
||||
sh(". ~/BUILD_ENV/bin/activate && pip install --upgrade setuptools build pip copier jinja2-slug toml \"setuptools-git-versioning<2\"")
|
||||
|
||||
sh(". ~/TOOLS_ENV/bin/activate && pip install simple_rest_client requests")
|
||||
sh(". ~/TOOLS_ENV/bin/activate && pip install git+https://chacha.ddns.net/gitea/chacha/pygitversionhelper.git@master")
|
||||
|
||||
|
||||
sh("git config --global user.email $_MaintainerEmail")
|
||||
sh("git config --global user.name $_MaintainerName")
|
||||
}
|
||||
}
|
||||
|
||||
@@ -148,23 +152,64 @@ pipeline {
|
||||
{
|
||||
if(sh(returnStdout: true, script: "git tag --points-at HEAD").trim().isEmpty())
|
||||
{
|
||||
error("master push/merge must have an explicit tag release number")
|
||||
BUMPED_VERSION = sh(script: """#!/bin/sh -
|
||||
|. ~/TOOLS_ENV/bin/activate
|
||||
|exec python - << '__EOWRAPPER__'
|
||||
|
|
||||
|from pygitversionhelper import gitversionhelper
|
||||
|import re
|
||||
|
|
||||
|lastcommit=gitversionhelper.commit.getLast(same_branch=True)
|
||||
|msg=gitversionhelper.commit.getMessage(lastcommit)
|
||||
|
|
||||
|_match=re.search(r"\\s*(?:#)?\\s*(?<=new-tag:)(?:\\s*)(?P<TAG>\\S*)",msg)
|
||||
|print(_match.group("TAG"),end="")
|
||||
|
|
||||
|__EOWRAPPER__
|
||||
""".stripMargin(),
|
||||
returnStdout: true).trim()
|
||||
if(BUMPED_VERSION.isEmpty())
|
||||
{
|
||||
echo "master push/merge must have an explicit tag release number, stopping pipeline"
|
||||
currentBuild.getRawBuild().getExecutor().doStop()
|
||||
}
|
||||
else
|
||||
{
|
||||
echo "new-tag requested in commit message: $BUMPED_VERSION"
|
||||
sh("git tag -a $BUMPED_VERSION")
|
||||
sh("git push origin master --tags")
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// using git to get the latest tag on this branch
|
||||
def latestTag = sh(returnStdout: true, script: "git tag --sort=-creatordate | head -n 1").trim()
|
||||
echo("latestTag:. . . . . . . . . . . . $latestTag ")
|
||||
|
||||
// using setuptools_git_versioning to get the generated version number based on Git tags and logs
|
||||
// TODO: read dev_template from toml
|
||||
|
||||
sh(script: """#!/bin/sh -
|
||||
|. ~/TOOLS_ENV/bin/activate
|
||||
|exec python - << '__EOWRAPPER__'
|
||||
|
|
||||
|from pygitversionhelper import gitversionhelper
|
||||
|
|
||||
|print(f"most recent repository tag: {gitversionhelper.tag.getLastTag()}")
|
||||
|print(f"most recent repository tag: {gitversionhelper.tag.getLastTag(same_branch=True)}")
|
||||
|print(f"number of commit since last tag: {gitversionhelper.tag.getDistanceFromTag()}")
|
||||
|print(f"number of commit since last tag: {gitversionhelper.tag.getDistanceFromTag(same_branch=True)}")
|
||||
|print(f"most recent repository version: {gitversionhelper.version.getLastVersion(formated_output=True)}")
|
||||
|print(f'current repository version: {gitversionhelper.version.getCurrentVersion(formated_output=True,version_std="PEP440",bump_type="dev",bump_dev_strategy="post")}')
|
||||
|
|
||||
|__EOWRAPPER__
|
||||
""".stripMargin())
|
||||
|
||||
// get current (or bumped) version number from git history
|
||||
PY_PROJECT_VERSION = sh(script: """#!/bin/sh -
|
||||
|. ~/BUILD_ENV/bin/activate
|
||||
|. ~/TOOLS_ENV/bin/activate
|
||||
|exec python - << '__EOWRAPPER__'
|
||||
|
|
||||
|from setuptools_git_versioning import version_from_git
|
||||
|from pygitversionhelper import gitversionhelper
|
||||
|
|
||||
|print(str(version_from_git(tag_filter="^\\d+\\.\\d+\\.\\d+\$",dev_template = "{tag}.post{ccount}")),end ="")
|
||||
|print(gitversionhelper.version.getCurrentVersion(formated_output=True,version_std="PEP440",bump_type="dev",bump_dev_strategy="post"),end ="")
|
||||
|
|
||||
|__EOWRAPPER__
|
||||
""".stripMargin(),
|
||||
@@ -176,12 +221,9 @@ pipeline {
|
||||
// => little hacky... creating a new git repo with a commit/tag corresponding to HEAD of the official one
|
||||
if(_PROJECT_NAME=="pyChaChaDummyProject") //specific case to test the template itself
|
||||
{
|
||||
sh("git config --global user.email $_MaintainerEmail")
|
||||
sh("git config --global user.name $_MaintainerName")
|
||||
|
||||
sh("rm -Rf ~/_gitrepo || true")
|
||||
|
||||
//sh(". ~/BUILD_ENV/bin/activate && python -m copier --vcs-ref HEAD --prereleases --defaults ./ ~/_gitrepo")
|
||||
sh(script: """#!/bin/sh -
|
||||
|. ~/BUILD_ENV/bin/activate
|
||||
|exec python - << '__EOWRAPPER__'
|
||||
@@ -388,13 +430,15 @@ pipeline {
|
||||
def GITEA_LOGIN_TOKEN=credentials("GiteaCHACHAPush")
|
||||
}
|
||||
steps {
|
||||
sh("python3 -m pip install simple_rest_client requests")
|
||||
dir("gitrepo") {
|
||||
script {
|
||||
def CurrentDateTime=java.time.LocalDateTime.now()
|
||||
withCredentials([string( credentialsId: _MkDocsWebCredentials,variable: 'MKDOCSTOKEN' )])
|
||||
{
|
||||
sh(script: """#!/usr/bin/env python3
|
||||
sh(script: """#!/bin/sh -
|
||||
|. ~/TOOLS_ENV/bin/activate
|
||||
|exec python - << '__EOWRAPPER__'
|
||||
|
|
||||
|from simple_rest_client.api import API
|
||||
|from simple_rest_client.resource import Resource
|
||||
|import json
|
||||
@@ -478,8 +522,9 @@ pipeline {
|
||||
|response=requests.post("http://${_MkDocsWebURL}/API.php?REQ=pushDoc",data=reqData,files=files)
|
||||
|if response.status_code != 200:
|
||||
| raise RuntimeError(f"Wrong server response: {response.status_code}")
|
||||
|
|
||||
""".stripMargin())
|
||||
|
|
||||
|__EOWRAPPER__
|
||||
""".stripMargin())
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
59
README.md
59
README.md
@@ -3,46 +3,33 @@
|
||||
|
||||

|
||||
|
||||
# Python project template
|
||||
# pyGitVersionHelper
|
||||
|
||||
A nice template to start a blank python projet.
|
||||
|
||||
This template automate a lot of handy things and allow CI/CD automatic releases generation.
|
||||
_A tiny library to help versioning management of git python projects_
|
||||
|
||||
It is also collectings data to feed Jenkins build.
|
||||
Because a good developer is a lazy developer and version management in CI/CD can be very time consuming.
|
||||
|
||||
Checkout [Latest Documentation](https://chacha.ddns.net/mkdocs-web/chacha/pychachadummyproject/{{branch}}/latest/).
|
||||
|
||||
Checkout [Latest Documentation](https://chacha.ddns.net/mkdocs-web/chacha/pygitversionhelper/{{branch}}/latest/).
|
||||
|
||||
## Features
|
||||
|
||||
### Generic pipeline skeleton:
|
||||
- Prepare
|
||||
- GetCode
|
||||
- BuildPackage
|
||||
- Install
|
||||
- CheckCode
|
||||
- PlotMetrics
|
||||
- RunUnitTests
|
||||
- GenDOC
|
||||
- PostRelease
|
||||
- list tags
|
||||
- get last tag
|
||||
- get last version
|
||||
- get current version (bumped)
|
||||
- convert / switch from SemVer to PEP440 (both ways)
|
||||
- automatic version format detection (SemVer by default)
|
||||
|
||||
### CI/CD Environment
|
||||
- Jenkins
|
||||
- Gitea (with patch for dynamic Readme variables: https://chacha.ddns.net/gitea/chacha/GiteaMarkupVariable)
|
||||
- Docker
|
||||
- MkDocsWeb
|
||||
|
||||
### CI/CD Helper libs
|
||||
- VirtualEnv
|
||||
- Changelog generation based on commits
|
||||
- copier
|
||||
- pylint + pylint_json2html
|
||||
- mypy
|
||||
- unittest + xmlrunner + junitparser + junit2htmlreport
|
||||
- mkdocs
|
||||
## Options
|
||||
- restrict to same branch
|
||||
- both SemVer and PEP440 support
|
||||
- custom output format
|
||||
- configurable default bump type major, minor, patch or dev
|
||||
- configurable default bump type: post, pre-patch, pre-minor, pre-major
|
||||
- ignore non-version tag
|
||||
- force version format
|
||||
|
||||
### Python project
|
||||
- Full .toml implementation
|
||||
- .whl automatic generation
|
||||
- dynamic versionning using git repository
|
||||
- embedded unit-test
|
||||
## Process
|
||||
- full CI/CD developpment: Gitea / Jenkins + few python libs (pytlint, coverage, unittest, mkdocs)
|
||||
- documentation generated mkdocs and self-hosted
|
||||
- CI/CD on Linux, manually tested in Windows environnement
|
||||
@@ -1,16 +1,128 @@
|
||||
# Usage
|
||||
|
||||
## Pulvinar dolor
|
||||
Donec dapibus est fermentum justo volutpat condimentum. Integer quis nunc neque. Donec dictum vehicula justo, in facilisis ex tincidunt in.
|
||||
Vivamus sollicitudin sem dui, id mollis orci facilisis ut. Proin sed pulvinar dolor. Donec volutpat commodo urna imperdiet pulvinar. Fusce eget aliquam risus.
|
||||
Vivamus viverra luctus ex, in finibus mi. Nullam elementum dapibus mollis. Ut suscipit volutpat ex, quis feugiat lacus consectetur eu.
|
||||
## Installation
|
||||
|
||||
## Condimentum faucibus
|
||||
Quisque auctor egestas sem, luctus suscipit ex maximus vitae. Duis facilisis augue et condimentum faucibus.
|
||||
Donec cursus, enim a sagittis egestas, lectus lorem eleifend libero, at tincidunt leo magna at libero.
|
||||
Nunc eros velit, suscipit luctus tempor vel, finibus et est. Curabitur efficitur pretium pulvinar.
|
||||
Donec urna lectus, vulputate quis turpis sed, placerat congue urna. Phasellus aliquet fermentum quam, non auctor elit porta nec. Morbi eu ligula at nisl ultricies condimentum vitae id ante.
|
||||
From master repository:
|
||||
|
||||
## Aliquam lacinia
|
||||
In volutpat lorem ex, et fringilla nibh faucibus quis. Mauris et arcu elementum, auctor dui vitae, egestas arcu. Duis sit amet aliquam quam.
|
||||
Phasellus a odio turpis. Etiam tristique mi eu enim varius, eget facilisis est vestibulum. Aliquam lacinia nec purus sed luctus. Cras at laoreet erat.
|
||||
python -m pip install git+https://chacha.ddns.net/gitea/chacha/pygitversionhelper.git@master
|
||||
|
||||
From local .whl file:
|
||||
|
||||
python -m pip install pygitversionhelper-<VERSION>-py3-none-any.whl
|
||||
|
||||
From public repository:
|
||||
|
||||
TBD
|
||||
|
||||
## Import in your project
|
||||
|
||||
Add this line on the top of your python script:
|
||||
|
||||
#from pygitversionhelper import gitversionhelper
|
||||
|
||||
[optionnal] If you need to catch exception from this module:
|
||||
|
||||
#from pygitversionhelper import gitversionhelperException
|
||||
|
||||
## Basic API
|
||||
|
||||
All the API commands are static so it is not needed to create instantiate any object.
|
||||
|
||||
They are all executed in the current active directory.
|
||||
|
||||
One easy way to change directory:
|
||||
|
||||
import os
|
||||
os.chdir("<YOUR DIRECTORY>")
|
||||
|
||||
### sublib: repository
|
||||
|
||||
To check if a repository is dirty:
|
||||
|
||||
if gitversionhelper.repository.isDirty():
|
||||
print("repository is dirty")
|
||||
|
||||
### sublib: tag
|
||||
|
||||
List all tags [default to taggerdate order]:
|
||||
|
||||
for tag in gitversionhelper.tag.getTags():
|
||||
print(f"found tag: {tag}")
|
||||
|
||||
List all tags [using git refname order]:
|
||||
|
||||
for tag in gitversionhelper.tag.getTags("v:refname"):
|
||||
print(f"found tag: {tag}")
|
||||
|
||||
Get the last tag:
|
||||
|
||||
print(f"most recent repository tag: {gitversionhelper.tag.getLastTag()}")
|
||||
|
||||
Get the last tag [only on same branch]:
|
||||
|
||||
print(f"most recent repository tag: {gitversionhelper.tag.getLastTag(same_branch=True)}")
|
||||
|
||||
|
||||
Get the distance from HEAD to last tag:
|
||||
|
||||
print(f"number of commit since last tag: {gitversionhelper.tag.getDistanceFromTag()}")
|
||||
|
||||
Get the distance from HEAD to last tag [only on same branch]:
|
||||
|
||||
print(f"number of commit since last tag: {gitversionhelper.tag.getDistanceFromTag(same_branch=True)}")
|
||||
|
||||
### sublib: version
|
||||
|
||||
Get the last found version in the repository [return MetaVersion object]:
|
||||
|
||||
print(f"most recent repository version: {gitversionhelper.version.getLastVersion()}")
|
||||
|
||||
Get the last found version in the repository [return formated string]:
|
||||
|
||||
print(f"most recent repository version: {gitversionhelper.version.getLastVersion(formated_output=True)}")
|
||||
|
||||
Others kwargs available to this function:
|
||||
|
||||
* version_std: string to force a version standard for rendering ["PEP440" or "SemVer"]
|
||||
* same_branch: boolean to force searching on same branch
|
||||
* ignore\_unknown\_tags: boolean to allow unknown tag to be ignored
|
||||
|
||||
Get the current version of the repository, automatically bump it if the last one is not tagged [returns MetaVersion object]:
|
||||
|
||||
print(f"current repository version: {gitversionhelper.version.getCurrentVersion()}")
|
||||
|
||||
Or with formated output:
|
||||
|
||||
print(f"current repository version: {gitversionhelper.version.getCurrentVersion(formated_output=True)}")
|
||||
|
||||
Typical usage in CI/CD env:
|
||||
|
||||
bumped_version = gitversionhelper.version.getCurrentVersion( formated_output=True, \
|
||||
version_std="PEP440", \
|
||||
bump_type="dev", \
|
||||
bump_dev_strategy="post")
|
||||
print(f"current repository version: {bumped_version}")
|
||||
|
||||
kwargs available to this function:
|
||||
|
||||
* All same args as getLastVersion()
|
||||
* bump_type: if version need to be pump, allow to configure next release update type: __major, minor, patch, dev__
|
||||
* bump\_dev\_strategy: if bump\_type is dev, allow to choose dev update strategy: __post, pre-patch, pre-minor, pre-major__
|
||||
|
||||
A version object can also be manually formated:
|
||||
|
||||
_version = gitversionhelper.tag.getCurrentVersion()
|
||||
_version.doFormatVersion()
|
||||
#or
|
||||
gitversionhelper.version.doFormatVersion(_version)
|
||||
|
||||
kwargs available to those function:
|
||||
- output_format: string to choose a rendering format ["Auto","PEP440" or "SemVer"]
|
||||
|
||||
## Limitations
|
||||
|
||||
There is unfortunately some technical limitation :
|
||||
|
||||
* MultiThreading and async behavior is not tested.
|
||||
* Multiple tag on the same commit is not supported.
|
||||
* Branch filter when searching for a version is only tested with -no-ff strategy
|
||||
@@ -36,6 +36,7 @@ classifiers = [
|
||||
]
|
||||
dependencies = [
|
||||
'importlib-metadata; python_version<"3.9"',
|
||||
'packaging'
|
||||
]
|
||||
dynamic = ["version"]
|
||||
|
||||
@@ -49,10 +50,6 @@ where = ["src"]
|
||||
[tool.setuptools.package-data]
|
||||
"pygitversionhelper.data" = ["*.*"]
|
||||
|
||||
#[tool.setuptools_scm]
|
||||
#write_to = "src/pygitversionhelper/_version.py"
|
||||
#version_scheme = "python-simplified-semver"
|
||||
|
||||
[project.urls]
|
||||
Homepage = "https://chacha.ddns.net/gitea/chacha/pygitversionhelper"
|
||||
Documentation = "https://chacha.ddns.net/gitea/chacha/pygitversionhelper/wiki"
|
||||
|
||||
@@ -5,15 +5,28 @@
|
||||
#
|
||||
# You should have received a copy of the license along with this
|
||||
# work. If not, see <https://creativecommons.org/licenses/by-nc-sa/4.0/>.
|
||||
|
||||
"""
|
||||
This module is the main gitversionhelper file, containing all the code.
|
||||
This project aim to be kept compact and focused on helping doing handy
|
||||
things with git when it deal with project versions/tags.
|
||||
This project try to help doing handy operations with git when
|
||||
dealing with project versioning and tags on python project -
|
||||
at leat for project using PEP440 or SemVer standards.
|
||||
|
||||
One requirement is to keep it compact and to not cover too much fancy features.
|
||||
This is the reason why it is one single file with nested classes.
|
||||
|
||||
=> Design is on-purpose poorly expandable to keep the scope light.
|
||||
|
||||
This library is maid for repository using tag as version.
|
||||
Support for non-version tags is optional and not well tested.
|
||||
|
||||
This module is the main project file, containing all the code.
|
||||
|
||||
Read the read me for more information.
|
||||
Check the unittest s for usage samples.
|
||||
|
||||
Note: _Other Parameters_ are **kwargs
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
import os
|
||||
import subprocess
|
||||
@@ -23,29 +36,26 @@ import logging
|
||||
|
||||
from packaging.version import VERSION_PATTERN as packaging_VERSION_PATTERN
|
||||
|
||||
# Only imports the below statements during type checking
|
||||
if TYPE_CHECKING:
|
||||
from typing import Union
|
||||
|
||||
def _exec(cmd: str, root: str | os.PathLike | None = None) -> list[str]:
|
||||
def _exec(cmd: str, root: str | os.PathLike | None = None, raw:bool = False) -> list[str]:
|
||||
"""
|
||||
helper function to handle system cmd execution
|
||||
Args:
|
||||
cmd: command line to be executed
|
||||
root: root directory where the command need to be executed
|
||||
Return:
|
||||
Returns:
|
||||
a list of command's return lines
|
||||
|
||||
"""
|
||||
|
||||
p = subprocess.run(cmd.split(), text=True, cwd=root, capture_output=True, check=False)
|
||||
p = subprocess.run(cmd, text=True, cwd=root, capture_output=True, check=False, timeout=2,shell=True)
|
||||
if re.search("not a git repository",p.stderr):
|
||||
raise gitversionhelper.repository.notAGitRepository()
|
||||
if re.search("fatal:",p.stderr):
|
||||
raise gitversionhelper.unknownGITFatalError()
|
||||
if int(p.returncode) < 0:
|
||||
raise gitversionhelper.unknownGITError
|
||||
if re.search("fatal:",p.stderr): #pragma: nocover
|
||||
raise gitversionhelper.unknownGITFatalError(p.stderr)
|
||||
if int(p.returncode) < 0: #pragma: nocover
|
||||
raise gitversionhelper.unknownGITError(p.stderr)
|
||||
|
||||
if raw:
|
||||
return p.stdout
|
||||
lines = p.stdout.splitlines()
|
||||
return [line.rstrip() for line in lines if line.rstrip()]
|
||||
|
||||
@@ -96,10 +106,107 @@ class gitversionhelper: # pylint: disable=too-few-public-methods
|
||||
def isDirty(cls) -> bool:
|
||||
"""
|
||||
check if the repository is in dirty state
|
||||
Return:
|
||||
Returns:
|
||||
True if it is dirty
|
||||
"""
|
||||
return bool(_exec("git status --short"))
|
||||
class commit:
|
||||
"""
|
||||
class containing methods focusing on commits
|
||||
"""
|
||||
__OptDict = {"same_branch": "same_branch",
|
||||
"merged_output":"merged_output"}
|
||||
|
||||
class commitException(gitversionhelperException):
|
||||
"""
|
||||
generic commit exception
|
||||
"""
|
||||
|
||||
class commitNotFound(commitException):
|
||||
"""
|
||||
tag not found exception
|
||||
"""
|
||||
|
||||
@classmethod
|
||||
def getMessagesSinceTag(cls,tag:str,**kwargs) -> str:
|
||||
"""
|
||||
retrieve a commits message history from repository
|
||||
from LastCommit to the given tag
|
||||
Keyword Arguments:
|
||||
merged_output: output one single merged string
|
||||
same_branch(bool): force searching only in the same branch
|
||||
Returns:
|
||||
the commit message
|
||||
"""
|
||||
current_commit_id=cls.getLast(**kwargs)
|
||||
tag_commit_id=cls.getFromTag(tag)
|
||||
|
||||
if ((cls.__OptDict["same_branch"] in kwargs) and (kwargs[cls.__OptDict["same_branch"]] is True)):
|
||||
commits = _exec(f"git rev-list --first-parent --ancestry-path {tag_commit_id}..{current_commit_id}")
|
||||
else:
|
||||
commits = _exec(f"git rev-list --ancestry-path {tag_commit_id}..{current_commit_id}")
|
||||
result=[]
|
||||
for commit in commits:
|
||||
result.append(cls.getMessage(commit))
|
||||
|
||||
if ((cls.__OptDict["merged_output"] in kwargs) and (kwargs[cls.__OptDict["merged_output"]] is True)):
|
||||
print("JOIN")
|
||||
return os.linesep.join(result)
|
||||
return result
|
||||
|
||||
@classmethod
|
||||
def getMessage(cls, commit_hash:str) -> str:
|
||||
"""
|
||||
retrieve a commit message from repository
|
||||
Args:
|
||||
commit_hash: id of the commit
|
||||
Returns:
|
||||
the commit message
|
||||
"""
|
||||
try:
|
||||
res=_exec(f"git log -z --pretty=\"tformat:%B%-C()\" -n 1 {commit_hash}",None,True).rstrip('\x00')
|
||||
except gitversionhelper.unknownGITFatalError as _e:
|
||||
raise cls.commitNotFound("no commit found in commit history") from _e
|
||||
|
||||
return res.replace('\r\n','\n').replace('\n','\r\n')
|
||||
|
||||
@classmethod
|
||||
def getFromTag(cls,tag:str) -> str:
|
||||
"""
|
||||
retrieve a commit from repository associated to a tag
|
||||
Args:
|
||||
tag: tag of the commit
|
||||
Returns:
|
||||
the commit Id
|
||||
"""
|
||||
try:
|
||||
res=_exec(f"git rev-list -n 1 {tag}")
|
||||
except gitversionhelper.unknownGITFatalError as _e:
|
||||
raise cls.commitNotFound("no commit found in commit history") from _e
|
||||
if len(res)==0:
|
||||
raise cls.commitNotFound("no commit found in commit history")
|
||||
return res[0]
|
||||
|
||||
@classmethod
|
||||
def getLast(cls,**kwargs) -> str:
|
||||
"""
|
||||
retrieve last commit from repository
|
||||
Keyword Arguments:
|
||||
same_branch(bool): force searching only in the same branch
|
||||
Returns:
|
||||
the commit Id
|
||||
"""
|
||||
if ((cls.__OptDict["same_branch"] in kwargs) and (kwargs[cls.__OptDict["same_branch"]] is True)):
|
||||
try:
|
||||
res = _exec("git rev-parse HEAD")
|
||||
except gitversionhelper.unknownGITFatalError as _e:
|
||||
raise cls.commitNotFound("no commit found in commit history") from _e
|
||||
else:
|
||||
res = _exec("git for-each-ref --sort=-committerdate refs/heads/ --count 1 --format=\"%(objectname)\"")
|
||||
|
||||
if len(res)==0:
|
||||
raise cls.commitNotFound("no commit found in commit history")
|
||||
return res[0]
|
||||
|
||||
class tag:
|
||||
"""
|
||||
@@ -124,49 +231,54 @@ class gitversionhelper: # pylint: disable=too-few-public-methods
|
||||
"""
|
||||
|
||||
@classmethod
|
||||
def getTags(cls,sort:str = "version:refname") -> list[str]:
|
||||
def getTags(cls,sort:str = "taggerdate",**kwargs) -> list[str|None]:
|
||||
"""
|
||||
retrieve all tags from a repository
|
||||
Args:
|
||||
sort: sorting constraints (git format)
|
||||
Return:
|
||||
Returns:
|
||||
the tags list
|
||||
"""
|
||||
|
||||
if sort not in cls.__validGitTagSort:
|
||||
raise gitversionhelper.wrongArguments("sort option not in allowed list")
|
||||
return _exec(f"git tag -l --sort={sort}")
|
||||
|
||||
if ((cls.__OptDict["same_branch"] in kwargs) and (kwargs[cls.__OptDict["same_branch"]] is True)):
|
||||
currentBranch = _exec("git rev-parse --abbrev-ref HEAD")
|
||||
return list(reversed(_exec(f"git tag --merged {currentBranch[0]} --sort={sort}")))
|
||||
return list(reversed(_exec(f"git tag -l --sort={sort}")))
|
||||
|
||||
@classmethod
|
||||
def getLastTag(cls,**kwargs) -> Union[str,None]:
|
||||
def getLastTag(cls,**kwargs) -> str | None:
|
||||
"""
|
||||
retrieve the last tag from a repository
|
||||
Kwargs:
|
||||
Keyword Arguments:
|
||||
same_branch(bool): force searching only in the same branch
|
||||
Return:
|
||||
Returns:
|
||||
the tag
|
||||
"""
|
||||
if ((cls.__OptDict["same_branch"] in kwargs) and (kwargs[cls.__OptDict["same_branch"]] is True)):
|
||||
res = _exec("git describe --tags --abbrev=0")
|
||||
res = _exec("git describe --tags --first-parent --abbrev=0")
|
||||
else:
|
||||
res = _exec("git rev-list --tags --max-count=1")
|
||||
res = _exec("git rev-list --tags --date-order --max-count=1")
|
||||
if len(res)==1:
|
||||
res = _exec(f"git describe --tags {res[0]}")
|
||||
|
||||
if len(res)==0:
|
||||
raise cls.tagNotFound("no tag found in commit history")
|
||||
if len(res)!=1:
|
||||
if len(res)!=1: #pragma: nocover
|
||||
raise cls.moreThanOneTag("multiple tags on same commit is unsupported")
|
||||
return res[0]
|
||||
|
||||
@classmethod
|
||||
def getDistanceFromTag(cls,tag=None,**kwargs) -> int:
|
||||
def getDistanceFromTag(cls,tag:str=None,**kwargs) -> int:
|
||||
"""
|
||||
retrieve the distance between HEAD and tag in the repository
|
||||
Arguments:
|
||||
tag: reference tag, if None the most recent one will be used
|
||||
Kwargs:
|
||||
Keyword Arguments:
|
||||
same_branch(bool): force searching only in the same branch
|
||||
Return:
|
||||
Returns:
|
||||
the tag
|
||||
"""
|
||||
if tag is None:
|
||||
@@ -179,15 +291,15 @@ class gitversionhelper: # pylint: disable=too-few-public-methods
|
||||
"""
|
||||
__OptDict = { "version_std": "version_std",
|
||||
"formated_output": "formated_output",
|
||||
"output_format": "output_format"}
|
||||
"output_format": "output_format",
|
||||
"ignore_unknown_tags": "ignore_unknown_tags"}
|
||||
DefaultInputFormat = "Auto"
|
||||
VersionStds = { "SemVer" : { "regex" : r"^(?P<major>0|[1-9]\d*)\.(?P<minor>0|[1-9]\d*)\.(?P<patch>0|[1-9]\d*)"\
|
||||
r"(?:-(?P<prerelease>(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)"\
|
||||
r"(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?"\
|
||||
r"(?:\+(?P<buildmetadata>[0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$",
|
||||
"regex_preversion_num": r"(?:\.)(?P<num>(?:\d+(?!\w))+)",
|
||||
"regex_build_num" : r"(?:\.)(?P<num>(?:\d+(?!\w))+)"
|
||||
|
||||
"regex_preversion_num": r"(?:\.)(?P<num>(?:\d+(?!\w))+)",
|
||||
"regex_build_num" : r"(?:\.)(?P<num>(?:\d+(?!\w))+)"
|
||||
},
|
||||
"PEP440" : { "regex" : packaging_VERSION_PATTERN,
|
||||
"Auto" : None
|
||||
@@ -204,24 +316,31 @@ class gitversionhelper: # pylint: disable=too-few-public-methods
|
||||
no valid version found exception
|
||||
"""
|
||||
|
||||
class PreAndPostVersionUnsupported(versionException):
|
||||
"""
|
||||
pre and post release can not be present at the same time
|
||||
"""
|
||||
|
||||
class MetaVersion:
|
||||
"""
|
||||
generic version object
|
||||
"""
|
||||
__OptDict = { "bump_type": "bump_type",
|
||||
"bump_dev_strategy": "bump_dev_strategy"}
|
||||
|
||||
__OptDict = { "bump_type": "bump_type",
|
||||
"bump_dev_strategy": "bump_dev_strategy",
|
||||
"formated_output": "formated_output"}
|
||||
DefaultBumpType = "patch"
|
||||
BumpTypes = ["major","minor","patch","dev"]
|
||||
DefaultBumpDevStrategy = "post"
|
||||
BumpDevStrategys = ["post","pre-patch","pre-minor","pre-major"]
|
||||
version_std = "None"
|
||||
|
||||
major: int = 0
|
||||
minor: int = 1
|
||||
patch: int = 0
|
||||
pre_count:int = 0
|
||||
post_count:int = 0
|
||||
raw:str = "0.1.0"
|
||||
version_std: str = "None"
|
||||
major: int = 0
|
||||
minor: int = 1
|
||||
patch: int = 0
|
||||
pre_count:int = 0
|
||||
post_count:int = 0
|
||||
raw:str = "0.1.0"
|
||||
|
||||
def __init__(self,version_std,major=0,minor=1,patch=0,pre_count=0,post_count=0,raw="0.1.0"): #pylint: disable=R0913
|
||||
self.version_std = version_std
|
||||
@@ -236,9 +355,9 @@ class gitversionhelper: # pylint: disable=too-few-public-methods
|
||||
def _getBumpDevStrategy(cls,**kwargs) -> str:
|
||||
"""
|
||||
get selected bump_dev_strategy
|
||||
Kwargs:
|
||||
Keyword Arguments:
|
||||
bump_dev_strategy(str): the given bump_dev_strategy (can be None)
|
||||
Return:
|
||||
Returns:
|
||||
Kwargs given bump_dev_strategy or the default one.
|
||||
"""
|
||||
BumpDevStrategy = cls.DefaultBumpDevStrategy
|
||||
@@ -253,9 +372,9 @@ class gitversionhelper: # pylint: disable=too-few-public-methods
|
||||
def _getBumpType(cls,**kwargs) -> str:
|
||||
"""
|
||||
get selected bump_type
|
||||
Kwargs:
|
||||
Keyword Arguments:
|
||||
bump_type(str): the given bump_type (can be None)
|
||||
Return:
|
||||
Returns:
|
||||
Kwargs given bump_type or the default one.
|
||||
"""
|
||||
BumpType = cls.DefaultBumpType
|
||||
@@ -266,13 +385,13 @@ class gitversionhelper: # pylint: disable=too-few-public-methods
|
||||
raise gitversionhelper.wrongArguments(f"invalid {cls.__OptDict['bump_type']} requested")
|
||||
return BumpType
|
||||
|
||||
def bump(self,amount:int=1,**kwargs): # pylint: disable=R0912
|
||||
def bump(self,amount:int=1,**kwargs) -> gitversionhelper.version.MetaVersion | str : # pylint: disable=R0912
|
||||
"""
|
||||
bump the version to the next one
|
||||
Kwargs:
|
||||
Keyword Arguments:
|
||||
bump_type(str): the given bump_type (can be None)
|
||||
bump_dev_strategy(str): the given bump_dev_strategy (can be None)
|
||||
Return:
|
||||
Returns:
|
||||
the bumped version
|
||||
"""
|
||||
BumpType = self._getBumpType(**kwargs)
|
||||
@@ -285,7 +404,8 @@ class gitversionhelper: # pylint: disable=too-few-public-methods
|
||||
_v.pre_count = _v.pre_count + amount
|
||||
else:
|
||||
_v.post_count = _v.post_count + amount
|
||||
elif BumpDevStrategy in ["pre-patch","pre-minor","pre-major"]:
|
||||
#elif BumpDevStrategy in ["pre-patch","pre-minor","pre-major"]:
|
||||
else:
|
||||
if _v.post_count > 0:
|
||||
_v.post_count = _v.post_count + amount
|
||||
else:
|
||||
@@ -295,7 +415,8 @@ class gitversionhelper: # pylint: disable=too-few-public-methods
|
||||
elif BumpDevStrategy == "pre-minor":
|
||||
_v.minor = _v.minor + 1
|
||||
_v.patch = 0
|
||||
elif BumpDevStrategy == "pre-major":
|
||||
#elif BumpDevStrategy == "pre-major":
|
||||
else:
|
||||
_v.major = _v.major + 1
|
||||
_v.minor = 0
|
||||
_v.patch = 0
|
||||
@@ -305,29 +426,34 @@ class gitversionhelper: # pylint: disable=too-few-public-methods
|
||||
_v.major = _v.major + amount
|
||||
elif BumpType == "minor":
|
||||
_v.minor = _v.minor + amount
|
||||
elif BumpType == "patch":
|
||||
#elif BumpType == "patch":
|
||||
else:
|
||||
_v.patch = _v.patch + amount
|
||||
_v.pre_count=0
|
||||
_v.post_count=0
|
||||
|
||||
_v.raw=_v.doFormatVersion(**kwargs)
|
||||
|
||||
if ((self.__OptDict["formated_output"] in kwargs) and (kwargs[self.__OptDict["formated_output"]] is True)):
|
||||
return _v.doFormatVersion(**kwargs)
|
||||
return _v
|
||||
|
||||
def doFormatVersion(self,**kwargs):
|
||||
def doFormatVersion(self,**kwargs) -> str:
|
||||
"""
|
||||
output a formated version string
|
||||
Return:
|
||||
Keyword Arguments:
|
||||
output_format: output format to render ("Auto" or "PEP440" or "SemVer")
|
||||
Returns:
|
||||
formated version string
|
||||
"""
|
||||
return gitversionhelper.version.doFormatVersion(self,**kwargs)
|
||||
|
||||
@classmethod
|
||||
def _getVersionStd(cls,**kwargs):
|
||||
def _getVersionStd(cls,**kwargs) -> str:
|
||||
"""
|
||||
get selected version_std
|
||||
Kwargs:
|
||||
Keyword Arguments:
|
||||
version_std(str): the given version_std (can be None)
|
||||
Return:
|
||||
Returns:
|
||||
Kwargs given version_std or the default one.
|
||||
"""
|
||||
VersionStd = cls.DefaultInputFormat
|
||||
@@ -339,14 +465,16 @@ class gitversionhelper: # pylint: disable=too-few-public-methods
|
||||
return VersionStd
|
||||
|
||||
@classmethod
|
||||
def getCurrentVersion(cls,**kwargs) -> Union[str,MetaVersion]:
|
||||
def getCurrentVersion(cls,**kwargs) -> MetaVersion | str :
|
||||
"""
|
||||
get the current version or bump depending of repository state
|
||||
Kwargs:
|
||||
Keyword Arguments:
|
||||
version_std(str): the given version_std (can be None)
|
||||
same_branch(bool): force searching only in the same branch
|
||||
formated_output(bool) : output a formated version string
|
||||
Return:
|
||||
bump_type(str): the given bump_type (can be None)
|
||||
bump_dev_strategy(str): the given bump_dev_strategy (can be None)
|
||||
Returns:
|
||||
the last version
|
||||
"""
|
||||
if gitversionhelper.repository.isDirty() is not False:
|
||||
@@ -360,42 +488,40 @@ class gitversionhelper: # pylint: disable=too-few-public-methods
|
||||
|
||||
if not cls.__versionReseted:
|
||||
amount = gitversionhelper.tag.getDistanceFromTag(_v.raw,**kwargs)
|
||||
_v = _v.bump(amount,**kwargs)
|
||||
_v = _v.bump(amount,**saved_kwargs)
|
||||
|
||||
if ((cls.__OptDict["formated_output"] in kwargs) and (kwargs[cls.__OptDict["formated_output"]] is True)):
|
||||
return _v.doFormatVersion(**kwargs)
|
||||
return _v
|
||||
|
||||
@classmethod
|
||||
def getLastVersion(cls,**kwargs) -> Union[str,MetaVersion]: # pylint: disable=R0914, R0912, R0915
|
||||
def getCurrentFormatedVersion(cls,**kwargs) -> str :
|
||||
"""
|
||||
get the last version from tags
|
||||
Kwargs:
|
||||
Same as getCurrentVersion() with formated_output kwarg activated
|
||||
"""
|
||||
kwargs["formated_output"]=True
|
||||
return cls.getCurrentVersion(kwargs)
|
||||
|
||||
@classmethod
|
||||
def _parseTag(cls,tag,**kwargs): # pylint: disable=R0914, R0912, R0915
|
||||
"""get the last version from tags
|
||||
Arguments:
|
||||
tag: the tag to be parsed
|
||||
Keyword Arguments:
|
||||
version_std(str): the given version_std (can be None)
|
||||
same_branch(bool): force searching only in the same branch
|
||||
formated_output(bool) : output a formated version string
|
||||
Return:
|
||||
ignore_unknown_tags(bool): skip tags with not decoded versions (default to False)
|
||||
Returns:
|
||||
the last version
|
||||
"""
|
||||
VersionStd = cls._getVersionStd(**kwargs)
|
||||
|
||||
bAutoVersionStd = False
|
||||
if VersionStd == "Auto":
|
||||
bAutoVersionStd = True
|
||||
|
||||
lastTag=cls.MetaVersion.raw
|
||||
cls.__versionReseted = False
|
||||
try:
|
||||
lastTag = gitversionhelper.tag.getLastTag(**kwargs)
|
||||
except gitversionhelper.tag.tagNotFound:
|
||||
logging.warning('tag not found, reseting versionning')
|
||||
cls.__versionReseted = True
|
||||
|
||||
bFound = False
|
||||
if VersionStd == "SemVer" or (bAutoVersionStd is True) :
|
||||
_r=re.compile(r"^\s*" + cls.VersionStds["SemVer"]["regex"] + r"\s*$", re.VERBOSE | \
|
||||
re.IGNORECASE)
|
||||
_m = re.match(_r,lastTag)
|
||||
_m = re.match(_r,tag)
|
||||
if not _m:
|
||||
pass
|
||||
else:
|
||||
@@ -422,7 +548,7 @@ class gitversionhelper: # pylint: disable=too-few-public-methods
|
||||
if VersionStd == "PEP440" or ( (bAutoVersionStd is True) and (bFound is not True)):
|
||||
_r=re.compile(r"^\s*" + cls.VersionStds["PEP440"]["regex"] + r"\s*$", re.VERBOSE | \
|
||||
re.IGNORECASE)
|
||||
_m = re.match(_r,lastTag)
|
||||
_m = re.match(_r,tag)
|
||||
if not _m:
|
||||
pass
|
||||
else:
|
||||
@@ -440,19 +566,59 @@ class gitversionhelper: # pylint: disable=too-few-public-methods
|
||||
if not bFound :
|
||||
raise gitversionhelper.version.noValidVersion("no valid version found in tags")
|
||||
|
||||
_v = cls.MetaVersion(VersionStd, major, minor, patch, pre_count, post_count, lastTag)
|
||||
if pre_count > 0 and post_count > 0:
|
||||
raise cls.PreAndPostVersionUnsupported("can not parse a version with both pre" \
|
||||
" and post release number.")
|
||||
return cls.MetaVersion(VersionStd, major, minor, patch, pre_count, post_count, tag)
|
||||
|
||||
@classmethod
|
||||
def getLastVersion(cls,**kwargs) -> MetaVersion | str : # pylint: disable=R0914, R0912, R0915
|
||||
"""get the last version from tags
|
||||
Keyword Arguments:
|
||||
version_std(str): the given version_std (can be None)
|
||||
same_branch(bool): force searching only in the same branch
|
||||
formated_output(bool) : output a formated version string
|
||||
ignore_unknown_tags(bool): skip tags with not decoded versions (default to False)
|
||||
Returns:
|
||||
the last version
|
||||
"""
|
||||
lastTag=cls.MetaVersion.raw
|
||||
cls.__versionReseted = False
|
||||
try:
|
||||
lastTag = gitversionhelper.tag.getLastTag(**kwargs)
|
||||
except gitversionhelper.tag.tagNotFound:
|
||||
logging.warning('tag not found, reseting versionning')
|
||||
cls.__versionReseted = True
|
||||
|
||||
_v=None
|
||||
try:
|
||||
_v=cls._parseTag(lastTag,**kwargs)
|
||||
except gitversionhelper.version.noValidVersion as _ex:
|
||||
if ((cls.__OptDict["ignore_unknown_tags"] in kwargs) and (kwargs[cls.__OptDict["ignore_unknown_tags"]] is True)):
|
||||
tags = gitversionhelper.tag.getTags(sort= "taggerdate",**kwargs)
|
||||
_v = None
|
||||
for _tag in tags:
|
||||
try:
|
||||
_v=cls._parseTag(_tag,**kwargs)
|
||||
break
|
||||
except gitversionhelper.version.noValidVersion:
|
||||
continue
|
||||
if _v is None:
|
||||
raise gitversionhelper.version.noValidVersion() from _ex
|
||||
|
||||
if ((cls.__OptDict["formated_output"] in kwargs) and (kwargs[cls.__OptDict["formated_output"]] is True)):
|
||||
return _v.doFormatVersion(**kwargs)
|
||||
return _v
|
||||
|
||||
@classmethod
|
||||
def doFormatVersion(cls,inputversion:MetaVersion,**kwargs):
|
||||
def doFormatVersion(cls,inputversion:MetaVersion,**kwargs) -> str:
|
||||
"""
|
||||
output a formated version string
|
||||
Keyword Arguments:
|
||||
output_format: output format to render ("Auto" or "PEP440" or "SemVer")
|
||||
Args:
|
||||
inputversion: version to be rendered
|
||||
Return:
|
||||
Returns:
|
||||
formated version string
|
||||
"""
|
||||
|
||||
@@ -473,7 +639,8 @@ class gitversionhelper: # pylint: disable=too-few-public-methods
|
||||
if OutputFormat is None:
|
||||
OutputFormat = "{major}.{minor}.{patch}{revpattern}{revcount}"
|
||||
if post_count > 0 and pre_count > 0:
|
||||
raise RuntimeError("pre and post release can not be present at the same time")
|
||||
raise gitversionhelper.version.PreAndPostVersionUnsupported("cannot output a version with both pre " \
|
||||
"and post release number.")
|
||||
if VersionStd == "PEP440":
|
||||
if post_count > 0:
|
||||
revpattern=".post"
|
||||
@@ -481,7 +648,8 @@ class gitversionhelper: # pylint: disable=too-few-public-methods
|
||||
elif pre_count > 0:
|
||||
revpattern=".pre"
|
||||
revcount=f"{pre_count}"
|
||||
elif VersionStd == "SemVer":
|
||||
#elif VersionStd == "SemVer":
|
||||
else:
|
||||
if post_count > 0:
|
||||
revpattern="+post"
|
||||
revcount=f".{post_count}"
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user