✨ Tag with version shortcuts (#55)

<!--
Copyright (C) 2020-2022 Arm Limited or its affiliates and Contributors.
All rights reserved.
SPDX-License-Identifier: Apache-2.0
-->
### Description

Add the ability to tag a release with moving shortcuts such as what is
done on DockerHub e.g. for `v1.2.3`, also add `v1`, `v1.2`, `latest`
tags



### Test Coverage

<!--
Please put an `x` in the correct box e.g. `[x]` to indicate the testing
coverage of this change.
-->

- [x]  This change is covered by existing or additional automated tests.
- [ ] Manual testing has been performed (and evidence provided) as
automated testing was not feasible.
- [ ] Additional tests are not required for this change (e.g.
documentation update).

Author: acabarbaye

continuous_delivery_scripts/get_version.py

@@ -33,7 +33,7 @@ def get_project_version_string(commit_type: CommitType) -> str:
 
 def main() -> None:
     """Handle command line arguments to determine version string."""
-    parser = argparse.ArgumentParser(description="Determine project's version.")
+    parser = argparse.ArgumentParser(description="Determine project's new version.")
     parser.add_argument(
         "-t", "--release-type", help="type of release to perform", required=True, type=str, choices=CommitType.choices()
     )

continuous_delivery_scripts/plugins/ci.py

@@ -5,7 +5,7 @@
 """Plugin for CI projects."""
 import logging
 from pathlib import Path
-from typing import Optional
+from typing import Optional, List
 
 from continuous_delivery_scripts.spdx_report.spdx_project import SpdxProject
 from continuous_delivery_scripts.utils.configuration import configuration, ConfigurationVariable
@@ -63,6 +63,6 @@ def should_clean_before_packaging(self) -> bool:
         """States whether the repository must be cleaned before packaging happens."""
         return True
 
-    def tag_release(self, git: GitWrapper, version: str) -> None:
+    def tag_release(self, git: GitWrapper, version: str, shortcuts: List[str]) -> None:
         """Tags release commit."""
-        super().tag_release(git, version)
+        super().tag_release(git, version, shortcuts)

continuous_delivery_scripts/plugins/golang.py

@@ -161,9 +161,9 @@ def should_clean_before_packaging(self) -> bool:
         """States whether the repository must be cleaned before packaging happens."""
         return True
 
-    def tag_release(self, git: GitWrapper, version: str) -> None:
+    def tag_release(self, git: GitWrapper, version: str, shortcuts: List[str]) -> None:
         """Tags release commit."""
-        super().tag_release(git, version)
+        super().tag_release(git, version, shortcuts)
         go_tag = _determine_go_module_tag(self.get_version_tag(version))
         if go_tag:
             git.create_tag(go_tag, message=f"Golang module release: {go_tag}")

continuous_delivery_scripts/tag_and_release.py

@@ -8,7 +8,7 @@
 import logging
 import sys
 from pathlib import Path
-from typing import Optional, Tuple
+from typing import Optional, Tuple, Dict
 
 from continuous_delivery_scripts.generate_docs import generate_documentation
 from continuous_delivery_scripts.generate_news import version_project
@@ -19,6 +19,7 @@
 from continuous_delivery_scripts.utils.definitions import CommitType
 from continuous_delivery_scripts.utils.git_helpers import ProjectTempClone, LocalProjectRepository, GitWrapper
 from continuous_delivery_scripts.utils.logging import log_exception, set_log_level
+from continuous_delivery_scripts.utils.versioning import determine_version_shortcuts
 
 SPDX_REPORTS_DIRECTORY = "licensing"
 
@@ -37,7 +38,7 @@ def tag_and_release(mode: CommitType, current_branch: Optional[str] = None) -> N
 
     """
     get_language_specifics().check_credentials()
-    is_new_version, version, _ = version_project(mode)
+    is_new_version, version, version_elements = version_project(mode)
     logger.info(f"Current version: {version}")
     if not version:
         raise ValueError("Undefined version.")
@@ -48,7 +49,7 @@ def tag_and_release(mode: CommitType, current_branch: Optional[str] = None) -> N
     # Adding the licensing summaries in /docs after folder has been cleared and regenerated.
     spdx_project = _update_licensing_summary()
     insert_licence_header(0)
-    _update_repository(mode, is_new_version, version, current_branch)
+    _update_repository(mode, is_new_version, version, current_branch, version_elements)
     if is_new_version:
         if get_language_specifics().should_clean_before_packaging():
             _clean_repository()
@@ -83,7 +84,13 @@ def _update_licensing_summary() -> Optional[SpdxProject]:
     return project
 
 
-def _update_repository(mode: CommitType, is_new_version: bool, version: str, current_branch: Optional[str]) -> None:
+def _update_repository(
+    mode: CommitType,
+    is_new_version: bool,
+    version: str,
+    current_branch: Optional[str],
+    version_elements: Dict[str, str],
+) -> None:
     """Update repository with changes that happened."""
     with ProjectTempClone(desired_branch_name=current_branch) as git:
         git.configure_for_github()
@@ -92,7 +99,7 @@ def _update_repository(mode: CommitType, is_new_version: bool, version: str, cur
         if mode == CommitType.RELEASE:
             _commit_release_changes(git, version, commit_message)
         if is_new_version:
-            get_language_specifics().tag_release(git, version)
+            get_language_specifics().tag_release(git, version, determine_version_shortcuts(mode, version_elements))
             git.force_push_tag()
 
 

continuous_delivery_scripts/utils/configuration.py

@@ -88,6 +88,8 @@ class ConfigurationVariable(enum.Enum):
     """News file type for dependency update."""
     TAG_LATEST = 35
     """States whether the release should be tagged with `latest`"""
+    TAG_VERSION_SHORTCUTS = 36
+    """States whether the release should be tagged with shortcuts i.e. major, major+minor"""
 
     @staticmethod
     def choices() -> List[str]:
@@ -192,6 +194,7 @@ class StaticConfig(GenericConfig):
     AWS_BUCKET = "Unknown"
     AUTOGENERATE_NEWS_FILE_ON_DEPENDENCY_UPDATE = True
     TAG_LATEST = False
+    TAG_VERSION_SHORTCUTS = False
     DEPENDENCY_UPDATE_NEWS_MESSAGE = "Dependency upgrade: {message}"
     DEPENDENCY_UPDATE_NEWS_TYPE = NewsType.bugfix
     DEPENDENCY_UPDATE_BRANCH_PATTERN = r"^\s*[Dd]ependabot\/.+\/(?P<DEPENDENCY>.+)"

continuous_delivery_scripts/utils/language_specifics_base.py

@@ -7,7 +7,7 @@
 import logging
 from abc import ABC, abstractmethod
 from pathlib import Path
-from typing import Optional
+from typing import Optional, List
 
 from continuous_delivery_scripts.spdx_report.spdx_project import SpdxProject
 from continuous_delivery_scripts.utils.configuration import configuration, ConfigurationVariable
@@ -74,12 +74,15 @@ def should_clean_before_packaging(self) -> bool:
         """States whether the repository must be cleaned before packaging happens."""
         return False
 
-    def tag_release(self, git: GitWrapper, version: str) -> None:
+    def tag_release(self, git: GitWrapper, version: str, shortcuts: List[str]) -> None:
         """Tags release commit."""
         logger.info(f"Tagging commit as release {version}")
         git.create_tag(self.get_version_tag(version), message=f"release {version}")
         if configuration.get_value(ConfigurationVariable.TAG_LATEST):
             git.create_tag("latest", message="latest release")
+        if configuration.get_value(ConfigurationVariable.TAG_VERSION_SHORTCUTS):
+            for shortcut in shortcuts:
+                git.create_tag(self.get_version_tag(shortcut), message=f"{shortcut} release")
 
     @abstractmethod
     def generate_code_documentation(self, output_directory: Path, module_to_document: str) -> None:

continuous_delivery_scripts/utils/versioning.py

@@ -7,7 +7,7 @@
 import logging
 import os
 from auto_version import auto_version_tool
-from typing import Optional, Tuple, Dict
+from typing import Optional, Tuple, Dict, List
 
 from continuous_delivery_scripts.utils.configuration import configuration, ConfigurationVariable
 from continuous_delivery_scripts.utils.definitions import CommitType
@@ -87,6 +87,36 @@ def determine_version_string(
     return new_version
 
 
+def determine_version_shortcuts(commit_type: CommitType, version_elements: Dict[str, str]) -> List[str]:
+    """Determine the different version shortcuts i.e. major, major.minor, pre depending on the release type.
+
+    Args:
+        commit_type: commit type
+        version_elements: version elements
+    """
+    shortcuts = []
+    major_version = version_elements.get(auto_version_tool.definitions.SemVerSigFig.major, None)
+    if major_version:
+        shortcuts.append(major_version)
+    minor_version = version_elements.get(auto_version_tool.definitions.SemVerSigFig.minor, None)
+    if minor_version and major_version:
+        shortcuts.append(f"{major_version}.{minor_version}")
+    if commit_type == CommitType.BETA:
+        shortcuts.append(auto_version_tool.config.PRERELEASE_TOKEN)
+    if commit_type == CommitType.DEVELOPMENT:
+        commit_count = version_elements.get(auto_version_tool.Constants.COMMIT_COUNT_FIELD, None)
+        if not commit_count:
+            with LocalProjectRepository() as git:
+                commit_count = git.get_commit_count()
+        commit_hash = version_elements.get(auto_version_tool.Constants.COMMIT_FIELD, None)
+        if not commit_hash:
+            with LocalProjectRepository() as git:
+                commit_hash = git.get_commit_hash()
+        shortcuts.append(f"{auto_version_tool.config.BUILD_TOKEN}.{commit_count}+{commit_hash}")
+
+    return shortcuts
+
+
 def _get_version_elements(native_version_elements: Dict[str, str]) -> Dict[str, str]:
     """Determines the different version elements.
 

news/20221220194939.feature

@@ -0,0 +1 @@
+Added a way to tag releases with version shortcuts such as 1.0

setup.py

@@ -58,6 +58,7 @@
         # FIXME change when https://github.com/pdoc3/pdoc/issues/299 is fixed
         "pdoc3==0.10.0",
         "toml",
+        "semver~=2.13.0",
         "python-dotenv",
         "twine",
         "boto3",

tests/versioning/test_versioning.py

@@ -3,8 +3,13 @@
 # SPDX-License-Identifier: Apache-2.0
 #
 import unittest
-from continuous_delivery_scripts.utils.versioning import calculate_version, determine_version_string
+from continuous_delivery_scripts.utils.versioning import (
+    calculate_version,
+    determine_version_string,
+    determine_version_shortcuts,
+)
 from continuous_delivery_scripts.utils.definitions import CommitType
+from auto_version.auto_version_tool import definitions, config
 
 
 class TestVersioning(unittest.TestCase):
@@ -26,3 +31,41 @@ def test_determine_version_string(self):
         self.assertEqual("1.1.1", determine_version_string(CommitType.BETA, "1.1.1", {}))
         self.assertTrue("1.1.1" in determine_version_string(CommitType.DEVELOPMENT, "1.1.1", {}))
         self.assertGreaterEqual(len(determine_version_string(CommitType.DEVELOPMENT, "1.1.1", {})), len("1.1.1"))
+
+    def test_determine_version_shortcuts(self):
+        self.assertListEqual(
+            ["1", "1.1"],
+            determine_version_shortcuts(
+                CommitType.RELEASE, {definitions.SemVerSigFig.major: "1", definitions.SemVerSigFig.minor: "1"}
+            ),
+        )
+        self.assertListEqual(
+            ["1"], determine_version_shortcuts(CommitType.RELEASE, {definitions.SemVerSigFig.major: "1"})
+        )
+        self.assertListEqual([], determine_version_shortcuts(CommitType.RELEASE, {definitions.SemVerSigFig.minor: "1"}))
+        self.assertListEqual(
+            ["1", "1.1", config.PRERELEASE_TOKEN],
+            determine_version_shortcuts(
+                CommitType.BETA, {definitions.SemVerSigFig.major: "1", definitions.SemVerSigFig.minor: "1"}
+            ),
+        )
+        self.assertTrue(
+            "1.1"
+            in determine_version_shortcuts(
+                CommitType.DEVELOPMENT, {definitions.SemVerSigFig.major: "1", definitions.SemVerSigFig.minor: "1"}
+            )
+        )
+        self.assertTrue(
+            "1"
+            in determine_version_shortcuts(
+                CommitType.DEVELOPMENT, {definitions.SemVerSigFig.major: "1", definitions.SemVerSigFig.minor: "1"}
+            )
+        )
+        self.assertGreaterEqual(
+            len(
+                determine_version_shortcuts(
+                    CommitType.DEVELOPMENT, {definitions.SemVerSigFig.major: "1", definitions.SemVerSigFig.minor: "1"}
+                )
+            ),
+            2,
+        )