Added CMD function to create release_info.json

Author: MaciejKaras

scripts/release/release_info.py

@@ -1,4 +1,6 @@
+import argparse
 import json
+import pathlib
 from typing import Dict
 
 from scripts.release.version import (
@@ -93,3 +95,34 @@ def create_release_info_json(version: str) -> str:
     build_info = load_build_info(Environment.PROD, version)
 
     return json.dumps(build_info.to_json(), indent=2)
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(
+        description="Create relevant release artifacts information in JSON format.",
+        formatter_class=argparse.RawTextHelpFormatter,
+    )
+    parser.add_argument(
+        "-v",
+        "--version",
+        metavar="",
+        action="store",
+        type=str,
+        help=f"Version to use for this release.",
+    )
+    parser.add_argument(
+        "--output",
+        "-o",
+        metavar="",
+        type=pathlib.Path,
+        help="Path to save the release information file. If not provided, prints to stdout.",
+    )
+    args = parser.parse_args()
+
+    release_info = create_release_info_json(args.version)
+
+    if args.output is not None:
+        with open(args.output, "w") as file:
+            file.write(release_info)
+    else:
+        print(release_info)

scripts/release/version.py

@@ -11,6 +11,7 @@
     get_changelog_entries,
 )
 
+COMMIT_SHA_LENGTH = 8
 
 class Environment(StrEnum):
     DEV = "dev"
@@ -30,7 +31,7 @@ def get_version_for_environment(env: Environment, initial_commit_sha: str | None
                 raise ValueError(f"BUILD_ID environment variable is not set for {env} environment")
             return build_id
         case Environment.STAGING:
-            return repo.head.object.hexsha
+            return repo.head.object.hexsha[:COMMIT_SHA_LENGTH]
         case Environment.PROD:
             return calculate_next_version(repo, changelog_sub_path, initial_commit_sha, initial_version)
 

scripts/release/version_test.py

@@ -1,7 +1,56 @@
+import os
 import unittest
 
-from scripts.release.changelog import ChangeKind
-from scripts.release.version import increment_previous_version
+from git import Repo
+
+from scripts.release.changelog import DEFAULT_INITIAL_GIT_TAG_VERSION, ChangeKind
+from scripts.release.version import (
+    Environment,
+    get_version_for_environment,
+    increment_previous_version,
+)
+
+
+class TestGetVersionForEnvironment:
+
+    def test_dev_environment(self, git_repo: Repo):
+        os.environ["BUILD_ID"] = "688364423f9b6c00072b3556"
+        expected_version = os.environ["BUILD_ID"]
+
+        version = get_version_for_environment(
+            env=Environment.DEV,
+            initial_commit_sha=None,
+            initial_version=DEFAULT_INITIAL_GIT_TAG_VERSION,
+            repository_path=git_repo.working_dir,
+        )
+
+        assert version == expected_version
+
+    def test_staging_environment(self, git_repo: Repo):
+        initial_commit = list(git_repo.iter_commits(reverse=True))[4]
+        git_repo.git.checkout(initial_commit)
+        expected_version = initial_commit.hexsha[:8]
+
+        version = get_version_for_environment(
+            env=Environment.STAGING,
+            initial_commit_sha=None,
+            initial_version=DEFAULT_INITIAL_GIT_TAG_VERSION,
+            repository_path=git_repo.working_dir,
+        )
+
+        assert version == expected_version
+
+    def test_prod_environment(self, git_repo: Repo):
+        git_repo.git.checkout("1.2.0")
+
+        version = get_version_for_environment(
+            env=Environment.PROD,
+            initial_commit_sha=None,
+            initial_version=DEFAULT_INITIAL_GIT_TAG_VERSION,
+            repository_path=git_repo.working_dir,
+        )
+
+        assert version == "1.2.0"
 
 
 class TestCalculateNextReleaseVersion(unittest.TestCase):