mirror of
https://github.com/slsdetectorgroup/slsDetectorPackage.git
synced 2026-03-04 17:02:42 +01:00
AliceMazzoleni99
f4658ab094
* some test about building docs * indendation error * typo - * forgot to get package hdf5 * had to add shinx and doxygen as well * oke created environmnet file * typo * dont use conda * dont use conda * cannot upload artefact commit to gh-pages * correct copy * mmh * try with tokem * set write permisison * script to update main_index for versioned documentation * rename main_index to index * use absolute path in python script * update main_index upon a release * extract release type from version * copy release notes * updated links from devdoc to slsDetectorPackage, handling .md for new versions * changed page source * updated documentation link in README * add guideline for Package Versioning to documentation also used as a test * typo in workflow * why didnt it copy? * copied from build instead of docs * change back - trigger for push * only trigger for pull_requests and releases * removed conda environment file * automatically update documentation paths in release notes * only keep templated README.md * added README and updated links * update Release notes template manually * generate release notes script not needed anymore * modified readme to reflect dependencies insides build from source * subheadings in dependencies --------- Co-authored-by: Dhanya Thattil <dhanya.thattil@psi.ch>
91 lines
3.2 KiB
Python
91 lines
3.2 KiB
Python
# SPDX-License-Identifier: LGPL-3.0-or-other
|
|
# Copyright (C) 2021 Contributors to the SLS Detector Package
|
|
"""
|
|
Script to update VERSION file with semantic versioning if provided as an argument, or with 0.0.0 if no argument is provided.
|
|
"""
|
|
|
|
import sys
|
|
from pathlib import Path
|
|
from datetime import datetime
|
|
from tempfile import template
|
|
import yaml
|
|
import argparse
|
|
|
|
from packaging.version import Version, InvalidVersion
|
|
|
|
ROOT_DIR = Path(__file__).resolve().parent.parent
|
|
|
|
SCRIPT_DIR = Path(__file__).resolve().parent.parent
|
|
|
|
def get_version(version : str) -> str:
|
|
|
|
try:
|
|
v = Version(version) # normalizcheck if version follows PEP 440 specification
|
|
#replace -
|
|
return version.replace("-", ".")
|
|
except InvalidVersion as e:
|
|
print(f"Invalid version {version}. Version format must follow semantic versioning format of python PEP 440 version identification specification.")
|
|
sys.exit(1)
|
|
|
|
|
|
def write_version_to_file(version):
|
|
version_file_path = Path(SCRIPT_DIR / "VERSION")
|
|
with open(version_file_path, "w") as version_file:
|
|
version_file.write(version)
|
|
print(f"Version {version} written to VERSION file.")
|
|
|
|
|
|
def extract_release_type(version: str) -> str:
|
|
"""Extract release type from version string."""
|
|
parts = version.split('.')
|
|
if len(parts) != 3:
|
|
raise ValueError(f"Version {version} does not follow semantic versioning format of major.minor.patch")
|
|
major, minor, patch = map(int, parts)
|
|
if minor == 0 and patch == 0:
|
|
return "Major"
|
|
elif patch == 0:
|
|
return "Minor"
|
|
else:
|
|
return "Bug Fix"
|
|
|
|
def get_previous_version(data_path: Path, version : str) -> str:
|
|
"""Get the previous version from the versions YAML file."""
|
|
with open(data_path, 'r') as f:
|
|
data = yaml.safe_load(f)
|
|
|
|
prev_version = data['versions'][0]["version"]
|
|
if prev_version == version: #already updated to new version
|
|
prev_version = data['versions'][1]["version"]
|
|
|
|
return prev_version
|
|
|
|
def main():
|
|
parser = argparse.ArgumentParser(description='Update version release notes')
|
|
parser.add_argument('--version', required=True, type=str, help='version to write to VERSION file')
|
|
parser.add_argument('--update_version_only', action="store_true", help='Only update version in VERSION file, do not generate release notes')
|
|
args = parser.parse_args()
|
|
|
|
version = get_version(args.version)
|
|
write_version_to_file(version)
|
|
|
|
if not args.update_version_only:
|
|
release_type = extract_release_type(version)
|
|
prev_version = get_previous_version(ROOT_DIR / "docs/main_index/versions.yaml", version)
|
|
|
|
# Read template
|
|
template = Path(ROOT_DIR / "RELEASE.md").read_text()
|
|
|
|
# Substitute version and date
|
|
output = template.replace("{{VERSION}}", version)
|
|
output = output.replace("{{DATE}}", datetime.now().strftime("%Y-%m-%d"))
|
|
output = output.replace("{{RELEASE_TYPE}}", release_type)
|
|
output = output.replace("{{PREVIOUS_VERSION}}", prev_version)
|
|
|
|
# Write output
|
|
Path(ROOT_DIR / "RELEASE.md").write_text(output)
|
|
print(f"Generated RELEASE.md for version {version}")
|
|
|
|
# Main script
|
|
if __name__ == "__main__":
|
|
main()
|