🚀 releasing version 2.10.1 @ 2022-12-21 12:47

[skip ci]

Author: monty-bot

CHANGELOG.md

@@ -17,6 +17,16 @@ This project was forked from version 1.7.4 of [mbed-tools-ci-scripts](https://gi
 
 [//]: # (begin_release_notes)
 
+"2.10.1" (2022-12-21)
+=====================
+
+Bugfixes
+--------
+
+- Dependency upgrade: scorecard-action-2.1.1 (#20221221071258)
+- Fixed shortcut tag rendering (#20221221110243)
+
+
 "2.10.0" (2022-12-20)
 =====================
 

continuous_delivery_scripts/_version.py

@@ -10,8 +10,8 @@
 
 This file is autogenerated, do not modify by hand.
 """
-__version__ = "2.10.0"
-COMMIT = "81da18232dcce84409b0fd8202f2f2d099503153"
+__version__ = "2.10.1"
+COMMIT = "bc2aa3a40ad89787d7851800c67521e32b031f3b"
 MAJOR = 2
 MINOR = 10
-PATCH = 0
+PATCH = 1

docs/plugins/ci.html

@@ -38,7 +38,7 @@ <h1 class="title">Module <code>continuous_delivery_scripts.plugins.ci</code></h1
 &#34;&#34;&#34;Plugin for CI projects.&#34;&#34;&#34;
 import logging
 from pathlib import Path
-from typing import Optional, List
+from typing import Optional, Dict
 
 from continuous_delivery_scripts.spdx_report.spdx_project import SpdxProject
 from continuous_delivery_scripts.utils.configuration import configuration, ConfigurationVariable
@@ -96,7 +96,7 @@ <h1 class="title">Module <code>continuous_delivery_scripts.plugins.ci</code></h1
         &#34;&#34;&#34;States whether the repository must be cleaned before packaging happens.&#34;&#34;&#34;
         return True
 
-    def tag_release(self, git: GitWrapper, version: str, shortcuts: List[str]) -&gt; None:
+    def tag_release(self, git: GitWrapper, version: str, shortcuts: Dict[str, bool]) -&gt; None:
         &#34;&#34;&#34;Tags release commit.&#34;&#34;&#34;
         super().tag_release(git, version, shortcuts)</code></pre>
 </details>
@@ -167,7 +167,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
         &#34;&#34;&#34;States whether the repository must be cleaned before packaging happens.&#34;&#34;&#34;
         return True
 
-    def tag_release(self, git: GitWrapper, version: str, shortcuts: List[str]) -&gt; None:
+    def tag_release(self, git: GitWrapper, version: str, shortcuts: Dict[str, bool]) -&gt; None:
         &#34;&#34;&#34;Tags release commit.&#34;&#34;&#34;
         super().tag_release(git, version, shortcuts)</code></pre>
 </details>

docs/plugins/golang.html

@@ -39,7 +39,7 @@ <h1 class="title">Module <code>continuous_delivery_scripts.plugins.golang</code>
 import logging
 import os
 from pathlib import Path
-from typing import Optional, List
+from typing import Optional, List, Dict
 from subprocess import check_call
 from continuous_delivery_scripts.utils.language_specifics_base import BaseLanguage, get_language_from_file_name
 from continuous_delivery_scripts.spdx_report.spdx_project import SpdxProject
@@ -194,7 +194,7 @@ <h1 class="title">Module <code>continuous_delivery_scripts.plugins.golang</code>
         &#34;&#34;&#34;States whether the repository must be cleaned before packaging happens.&#34;&#34;&#34;
         return True
 
-    def tag_release(self, git: GitWrapper, version: str, shortcuts: List[str]) -&gt; None:
+    def tag_release(self, git: GitWrapper, version: str, shortcuts: Dict[str, bool]) -&gt; None:
         &#34;&#34;&#34;Tags release commit.&#34;&#34;&#34;
         super().tag_release(git, version, shortcuts)
         go_tag = _determine_go_module_tag(self.get_version_tag(version))
@@ -289,7 +289,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
         &#34;&#34;&#34;States whether the repository must be cleaned before packaging happens.&#34;&#34;&#34;
         return True
 
-    def tag_release(self, git: GitWrapper, version: str, shortcuts: List[str]) -&gt; None:
+    def tag_release(self, git: GitWrapper, version: str, shortcuts: Dict[str, bool]) -&gt; None:
         &#34;&#34;&#34;Tags release commit.&#34;&#34;&#34;
         super().tag_release(git, version, shortcuts)
         go_tag = _determine_go_module_tag(self.get_version_tag(version))

docs/tag_and_release.html

@@ -132,7 +132,16 @@ <h1 class="title">Module <code>continuous_delivery_scripts.tag_and_release</code
         if mode == CommitType.RELEASE:
             _commit_release_changes(git, version, commit_message)
         if is_new_version:
-            get_language_specifics().tag_release(git, version, determine_version_shortcuts(mode, version_elements))
+            get_language_specifics().tag_release(
+                git,
+                version,
+                determine_version_shortcuts(
+                    mode,
+                    configuration.get_value(ConfigurationVariable.TAG_LATEST),
+                    configuration.get_value(ConfigurationVariable.TAG_VERSION_SHORTCUTS),
+                    version_elements,
+                ),
+            )
             git.force_push_tag()
 
 

docs/third_party_IP_report.html

@@ -65,7 +65,7 @@
   </head>
   <body>
     <h1>Project's 3rd party IP report</h1>
-    <p><i>2022-12-20 20:30:52.617239</i></p>
+    <p><i>2022-12-21 12:47:01.943188</i></p>
     <h2>Summary</h2>
     <table>
       <thead>

docs/third_party_IP_report.txt

@@ -1,6 +1,6 @@
                                 3rd party IP report for continuous-delivery-scripts
 
-                                         2022-12-20 20:30:52.617239
+                                         2022-12-21 12:47:01.943188
 
 # Summary:
     Licence compliance: Not compliant

docs/utils/language_specifics_base.html

@@ -40,7 +40,7 @@ <h1 class="title">Module <code>continuous_delivery_scripts.utils.language_specif
 import logging
 from abc import ABC, abstractmethod
 from pathlib import Path
-from typing import Optional, List
+from typing import Optional, Dict
 
 from continuous_delivery_scripts.spdx_report.spdx_project import SpdxProject
 from continuous_delivery_scripts.utils.configuration import configuration, ConfigurationVariable
@@ -107,15 +107,15 @@ <h1 class="title">Module <code>continuous_delivery_scripts.utils.language_specif
         &#34;&#34;&#34;States whether the repository must be cleaned before packaging happens.&#34;&#34;&#34;
         return False
 
-    def tag_release(self, git: GitWrapper, version: str, shortcuts: List[str]) -&gt; None:
+    def tag_release(self, git: GitWrapper, version: str, shortcuts: Dict[str, bool]) -&gt; None:
         &#34;&#34;&#34;Tags release commit.&#34;&#34;&#34;
         logger.info(f&#34;Tagging commit as release {version}&#34;)
         git.create_tag(self.get_version_tag(version), message=f&#34;release {version}&#34;)
-        if configuration.get_value(ConfigurationVariable.TAG_LATEST):
-            git.create_tag(&#34;latest&#34;, message=&#34;latest release&#34;)
-        if configuration.get_value(ConfigurationVariable.TAG_VERSION_SHORTCUTS):
-            for shortcut in shortcuts:
+        for shortcut, version in shortcuts.items():
+            if version:
                 git.create_tag(self.get_version_tag(shortcut), message=f&#34;{shortcut} release&#34;)
+            else:
+                git.create_tag(shortcut, message=shortcut)
 
     @abstractmethod
     def generate_code_documentation(self, output_directory: Path, module_to_document: str) -&gt; None:
@@ -221,15 +221,15 @@ <h2 class="section-title" id="header-classes">Classes</h2>
         &#34;&#34;&#34;States whether the repository must be cleaned before packaging happens.&#34;&#34;&#34;
         return False
 
-    def tag_release(self, git: GitWrapper, version: str, shortcuts: List[str]) -&gt; None:
+    def tag_release(self, git: GitWrapper, version: str, shortcuts: Dict[str, bool]) -&gt; None:
         &#34;&#34;&#34;Tags release commit.&#34;&#34;&#34;
         logger.info(f&#34;Tagging commit as release {version}&#34;)
         git.create_tag(self.get_version_tag(version), message=f&#34;release {version}&#34;)
-        if configuration.get_value(ConfigurationVariable.TAG_LATEST):
-            git.create_tag(&#34;latest&#34;, message=&#34;latest release&#34;)
-        if configuration.get_value(ConfigurationVariable.TAG_VERSION_SHORTCUTS):
-            for shortcut in shortcuts:
+        for shortcut, version in shortcuts.items():
+            if version:
                 git.create_tag(self.get_version_tag(shortcut), message=f&#34;{shortcut} release&#34;)
+            else:
+                git.create_tag(shortcut, message=shortcut)
 
     @abstractmethod
     def generate_code_documentation(self, output_directory: Path, module_to_document: str) -&gt; None:
@@ -451,23 +451,23 @@ <h3>Methods</h3>
 </details>
 </dd>
 <dt id="continuous_delivery_scripts.utils.language_specifics_base.BaseLanguage.tag_release"><code class="name flex">
-<span>def <span class="ident">tag_release</span></span>(<span>self, git: <a title="continuous_delivery_scripts.utils.git_helpers.GitWrapper" href="git_helpers.html#continuous_delivery_scripts.utils.git_helpers.GitWrapper">GitWrapper</a>, version: str, shortcuts: List[str]) ‑> None</span>
+<span>def <span class="ident">tag_release</span></span>(<span>self, git: <a title="continuous_delivery_scripts.utils.git_helpers.GitWrapper" href="git_helpers.html#continuous_delivery_scripts.utils.git_helpers.GitWrapper">GitWrapper</a>, version: str, shortcuts: Dict[str, bool]) ‑> None</span>
 </code></dt>
 <dd>
 <div class="desc"><p>Tags release commit.</p></div>
 <details class="source">
 <summary>
 <span>Expand source code</span>
 </summary>
-<pre><code class="python">def tag_release(self, git: GitWrapper, version: str, shortcuts: List[str]) -&gt; None:
+<pre><code class="python">def tag_release(self, git: GitWrapper, version: str, shortcuts: Dict[str, bool]) -&gt; None:
     &#34;&#34;&#34;Tags release commit.&#34;&#34;&#34;
     logger.info(f&#34;Tagging commit as release {version}&#34;)
     git.create_tag(self.get_version_tag(version), message=f&#34;release {version}&#34;)
-    if configuration.get_value(ConfigurationVariable.TAG_LATEST):
-        git.create_tag(&#34;latest&#34;, message=&#34;latest release&#34;)
-    if configuration.get_value(ConfigurationVariable.TAG_VERSION_SHORTCUTS):
-        for shortcut in shortcuts:
-            git.create_tag(self.get_version_tag(shortcut), message=f&#34;{shortcut} release&#34;)</code></pre>
+    for shortcut, version in shortcuts.items():
+        if version:
+            git.create_tag(self.get_version_tag(shortcut), message=f&#34;{shortcut} release&#34;)
+        else:
+            git.create_tag(shortcut, message=shortcut)</code></pre>
 </details>
 </dd>
 </dl>

docs/utils/versioning.html

@@ -40,7 +40,7 @@ <h1 class="title">Module <code>continuous_delivery_scripts.utils.versioning</cod
 import logging
 import os
 from auto_version import auto_version_tool
-from typing import Optional, Tuple, Dict, List
+from typing import Optional, Tuple, Dict
 
 from continuous_delivery_scripts.utils.configuration import configuration, ConfigurationVariable
 from continuous_delivery_scripts.utils.definitions import CommitType
@@ -120,23 +120,36 @@ <h1 class="title">Module <code>continuous_delivery_scripts.utils.versioning</cod
     return new_version
 
 
-def determine_version_shortcuts(commit_type: CommitType, version_elements: Dict[str, str]) -&gt; List[str]:
+def determine_version_shortcuts(
+    commit_type: CommitType, tag_latest: bool, tag_shortcut: bool, version_elements: Dict[str, str]
+) -&gt; Dict[str, bool]:
     &#34;&#34;&#34;Determine the different version shortcuts i.e. major, major.minor, pre depending on the release type.
 
     Args:
         commit_type: commit type
+        tag_latest: whether to tag release with `Latest`
+        tag_shortcut: whether to set additional shortcuts
         version_elements: version elements
+
+    Returns:
+        dict: A dictionary of shortcuts and a flag specifying
+        whether it is a version string or bespoke shortcut such as latest
     &#34;&#34;&#34;
-    shortcuts = []
+    shortcuts = {}
+    if commit_type == CommitType.RELEASE and tag_latest:
+        shortcuts[&#34;latest&#34;] = False
+    if not tag_shortcut:
+        return shortcuts
     major_version = version_elements.get(auto_version_tool.definitions.SemVerSigFig.major, None)
     if major_version:
-        shortcuts.append(major_version)
+        shortcuts[major_version] = True
     minor_version = version_elements.get(auto_version_tool.definitions.SemVerSigFig.minor, None)
     if minor_version and major_version:
-        shortcuts.append(f&#34;{major_version}.{minor_version}&#34;)
+        shortcuts[f&#34;{major_version}.{minor_version}&#34;] = True
     if commit_type == CommitType.BETA:
-        shortcuts.append(auto_version_tool.config.PRERELEASE_TOKEN)
+        shortcuts[auto_version_tool.config.PRERELEASE_TOKEN] = False
     if commit_type == CommitType.DEVELOPMENT:
+        shortcuts[auto_version_tool.config.BUILD_TOKEN] = False
         commit_count = version_elements.get(auto_version_tool.Constants.COMMIT_COUNT_FIELD, None)
         if not commit_count:
             with LocalProjectRepository() as git:
@@ -145,7 +158,7 @@ <h1 class="title">Module <code>continuous_delivery_scripts.utils.versioning</cod
         if not commit_hash:
             with LocalProjectRepository() as git:
                 commit_hash = git.get_commit_hash()
-        shortcuts.append(f&#34;{auto_version_tool.config.BUILD_TOKEN}.{commit_count}+{commit_hash}&#34;)
+        shortcuts[f&#34;{auto_version_tool.config.BUILD_TOKEN}.{commit_count}+{commit_hash}&#34;] = False
 
     return shortcuts
 
@@ -234,38 +247,61 @@ <h2 id="returns">Returns</h2>
 </details>
 </dd>
 <dt id="continuous_delivery_scripts.utils.versioning.determine_version_shortcuts"><code class="name flex">
-<span>def <span class="ident">determine_version_shortcuts</span></span>(<span>commit_type: <a title="continuous_delivery_scripts.utils.definitions.CommitType" href="definitions.html#continuous_delivery_scripts.utils.definitions.CommitType">CommitType</a>, version_elements: Dict[str, str]) ‑> List[str]</span>
+<span>def <span class="ident">determine_version_shortcuts</span></span>(<span>commit_type: <a title="continuous_delivery_scripts.utils.definitions.CommitType" href="definitions.html#continuous_delivery_scripts.utils.definitions.CommitType">CommitType</a>, tag_latest: bool, tag_shortcut: bool, version_elements: Dict[str, str]) ‑> Dict[str, bool]</span>
 </code></dt>
 <dd>
 <div class="desc"><p>Determine the different version shortcuts i.e. major, major.minor, pre depending on the release type.</p>
 <h2 id="args">Args</h2>
 <dl>
 <dt><strong><code>commit_type</code></strong></dt>
 <dd>commit type</dd>
+<dt><strong><code>tag_latest</code></strong></dt>
+<dd>whether to tag release with <code>Latest</code></dd>
+<dt><strong><code>tag_shortcut</code></strong></dt>
+<dd>whether to set additional shortcuts</dd>
 <dt><strong><code>version_elements</code></strong></dt>
 <dd>version elements</dd>
-</dl></div>
+</dl>
+<h2 id="returns">Returns</h2>
+<dl>
+<dt><code>dict</code></dt>
+<dd>A dictionary of shortcuts and a flag specifying</dd>
+</dl>
+<p>whether it is a version string or bespoke shortcut such as latest</p></div>
 <details class="source">
 <summary>
 <span>Expand source code</span>
 </summary>
-<pre><code class="python">def determine_version_shortcuts(commit_type: CommitType, version_elements: Dict[str, str]) -&gt; List[str]:
+<pre><code class="python">def determine_version_shortcuts(
+    commit_type: CommitType, tag_latest: bool, tag_shortcut: bool, version_elements: Dict[str, str]
+) -&gt; Dict[str, bool]:
     &#34;&#34;&#34;Determine the different version shortcuts i.e. major, major.minor, pre depending on the release type.
 
     Args:
         commit_type: commit type
+        tag_latest: whether to tag release with `Latest`
+        tag_shortcut: whether to set additional shortcuts
         version_elements: version elements
+
+    Returns:
+        dict: A dictionary of shortcuts and a flag specifying
+        whether it is a version string or bespoke shortcut such as latest
     &#34;&#34;&#34;
-    shortcuts = []
+    shortcuts = {}
+    if commit_type == CommitType.RELEASE and tag_latest:
+        shortcuts[&#34;latest&#34;] = False
+    if not tag_shortcut:
+        return shortcuts
     major_version = version_elements.get(auto_version_tool.definitions.SemVerSigFig.major, None)
     if major_version:
-        shortcuts.append(major_version)
+        shortcuts[major_version] = True
     minor_version = version_elements.get(auto_version_tool.definitions.SemVerSigFig.minor, None)
     if minor_version and major_version:
-        shortcuts.append(f&#34;{major_version}.{minor_version}&#34;)
+        shortcuts[f&#34;{major_version}.{minor_version}&#34;] = True
     if commit_type == CommitType.BETA:
-        shortcuts.append(auto_version_tool.config.PRERELEASE_TOKEN)
+        shortcuts[auto_version_tool.config.PRERELEASE_TOKEN] = False
     if commit_type == CommitType.DEVELOPMENT:
+        shortcuts[auto_version_tool.config.BUILD_TOKEN] = False
         commit_count = version_elements.get(auto_version_tool.Constants.COMMIT_COUNT_FIELD, None)
         if not commit_count:
             with LocalProjectRepository() as git:
@@ -274,7 +310,7 @@ <h2 id="args">Args</h2>
         if not commit_hash:
             with LocalProjectRepository() as git:
                 commit_hash = git.get_commit_hash()
-        shortcuts.append(f&#34;{auto_version_tool.config.BUILD_TOKEN}.{commit_count}+{commit_hash}&#34;)
+        shortcuts[f&#34;{auto_version_tool.config.BUILD_TOKEN}.{commit_count}+{commit_hash}&#34;] = False
 
     return shortcuts</code></pre>
 </details>