Executable.generate_git_version Namespace Reference

Functions
None	generate_git_version_file (str s_workpath)
	Generate git version file.

Variables
str	FILE_HEADER
str	GIT_VERSION_FILE_NAME = "git_version.py"
	log = logging.getLogger("GenerateGitVersion")
	workpath = sys.argv[1]

Detailed Description

---

Function Documentation

generate_git_version_file()

None generate_git_version_file

(

str

s_workpath

)

Generate git version file.

Parameters

s_workpath

: workpath

Definition at line 29 of file generate_git_version.py.

def generate_git_version_file(s_workpath: str) -> None:
    """!
    @brief Generate git version file
    @param s_workpath : workpath
    """
    s_git_version_file = os.path.join(s_workpath, GIT_VERSION_FILE_NAME)
 
    log.info("Generating git version file %s", s_git_version_file)
    if not os.path.exists(s_workpath):
        os.mkdir(s_workpath)
    else:
        log.info("Directory %s already exists", s_workpath)
    repo = git.Repo(search_parent_directories=True)
    sha = repo.head.commit.hexsha
    short_sha = repo.git.rev_parse(sha, short=8)
    with open(s_git_version_file, mode="w", encoding="utf-8") as f:
        code_content = FILE_HEADER
        code_content += f"GIT_SHORT_SHA = '{short_sha}'\n"
        f.write(code_content)
 
 

Variable Documentation

FILE_HEADER

str FILE_HEADER

Initial value:

=  f'''"""!
********************************************************************************
@file   {GIT_VERSION_FILE_NAME}
@brief  Defines Git version
********************************************************************************
"""
 
'''

Definition at line 19 of file generate_git_version.py.

GIT_VERSION_FILE_NAME

str GIT_VERSION_FILE_NAME = "git_version.py"

Definition at line 17 of file generate_git_version.py.

log

log = logging.getLogger("GenerateGitVersion")

Definition at line 15 of file generate_git_version.py.

workpath

workpath = sys.argv[1]

Definition at line 51 of file generate_git_version.py.