Add main method in versioning.py

scripts/release/conftest.py

@@ -12,6 +12,7 @@ def git_repo(change_log_path: str = CHANGELOG_PATH) -> Repo:
  """
  Create a temporary git repository for testing.
  Visual representation of the repository structure is in test_git_repo.mmd (mermaid/gitgraph https://mermaid.js.org/syntax/gitgraph.html).
+ Whenever you modify or add new commits please update the git graph as well.
  """
 
  repo_dir = tempfile.mkdtemp()

scripts/release/release_notes.py

@@ -6,7 +6,8 @@
 from jinja2 import Template
 
 from scripts.release.changelog import CHANGELOG_PATH, get_changelog_entries, ChangeType
-from scripts.release.versioning import calculate_next_release_version, find_previous_version_tag
+from scripts.release.versioning import calculate_next_release_version, find_previous_version, \
+ calculate_next_version_with_changelog
 
 
 def generate_release_notes(
@@ -28,29 +29,11 @@ def generate_release_notes(
  """
  repo = Repo(repository_path)
 
- previous_version_tag = find_previous_version_tag(repo)
+ changelog, version = calculate_next_version_with_changelog(repo, changelog_sub_path, initial_commit_sha,
+ initial_version)
 
- # If there is no previous version tag, we start with the initial commit
- if not previous_version_tag:
- # If no initial commit SHA provided, use the first commit in the repository
- if not initial_commit_sha:
- initial_commit_sha = list(repo.iter_commits(reverse=True))[0].hexsha
-
- previous_version_commit = repo.commit(initial_commit_sha)
- else:
- previous_version_commit = previous_version_tag.commit
-
- changelog: list = get_changelog_entries(previous_version_commit, repo, changelog_sub_path)
- changelog_entries = list[ChangeType](map(lambda x: x[0], changelog))
-
- # If there is no previous version tag, we start with the initial version tag
- if not previous_version_tag:
- version = initial_version
- else:
- version = calculate_next_release_version(previous_version_tag.name, changelog_entries)
-
- with open('scripts/release/release_notes_tpl.md', "r") as f:
- template = Template(f.read())
+ with open('scripts/release/release_notes_tpl.md', "r") as file:
+ template = Template(file.read())
 
  parameters = {
  'version': version,

scripts/release/versioning.py

@@ -1,7 +1,46 @@
+import argparse
+import pathlib
+import sys
+
 import semver
-from git import Repo, TagReference
+from git import Repo, TagReference, Commit
+
+from scripts.release.changelog import ChangeType, get_changelog_entries
+
+
+def calculate_next_version_with_changelog(
+ repo: Repo,
+ changelog_sub_path: str,
+ initial_commit_sha: str | None,
+ initial_version: str) -> (str, list[tuple[ChangeType, str]]):
+ previous_version_tag, previous_version_commit = find_previous_version(repo, initial_commit_sha)
+
+ changelog: list[tuple[ChangeType, str]] = get_changelog_entries(previous_version_commit, repo, changelog_sub_path)
+ changelog_types = list[ChangeType](map(lambda x: x[0], changelog))
+
+ # If there is no previous version tag, we start with the initial version tag
+ if not previous_version_tag:
+ version = initial_version
+ else:
+ version = calculate_next_release_version(previous_version_tag.name, changelog_types)
+
+ return version, changelog
+
 
-from scripts.release.changelog import ChangeType
+def find_previous_version(repo: Repo, initial_commit_sha: str = None) -> (TagReference | None, Commit):
+ """Find the most recent version that is an ancestor of the current HEAD commit."""
+
+ previous_version_tag = find_previous_version_tag(repo)
+
+ # If there is no previous version tag, we start with the initial commit
+ if not previous_version_tag:
+ # If no initial commit SHA provided, use the first commit in the repository
+ if not initial_commit_sha:
+ initial_commit_sha = list(repo.iter_commits(reverse=True))[0].hexsha
+
+ return None, repo.commit(initial_commit_sha)
+
+ return previous_version_tag, previous_version_tag.commit
 
 
 def find_previous_version_tag(repo: Repo) -> TagReference | None:
@@ -32,3 +71,22 @@ def calculate_next_release_version(previous_version_str: str, changelog: list[Ch
  return str(previous_version.bump_minor())
 
  return str(previous_version.bump_patch())
+
+
+if __name__ == "__main__":
+ parser = argparse.ArgumentParser()
+ parser.add_argument("--path", action="store", default=".", type=pathlib.Path,
+ help="Path to the Git repository. Default is the current directory '.'")
+ parser.add_argument("--changelog_path", default="changelog/", action="store", type=str,
+ help="Path to the changelog directory relative to the repository root. Default is 'changelog/'")
+ parser.add_argument("--initial_commit_sha", action="store", type=str,
+ help="SHA of the initial commit to start from if no previous version tag is found.")
+ parser.add_argument("--initial_version", default="1.0.0", action="store", type=str,
+ help="Version to use if no previous version tag is found. Default is '1.0.0'")
+ parser.add_argument("--output", "-o", type=pathlib.Path)
+ args = parser.parse_args()
+
+ _, version = calculate_next_version_with_changelog(args.path, args.changelog_path, args.initial_commit_sha,
+ args.initial_version)
+
+ sys.stdout.write(version)