🚀 releasing version 2.10.0 @ 2022-12-20 20:30

[skip ci]

Author: monty-bot

CHANGELOG.md

@@ -17,6 +17,22 @@ This project was forked from version 1.7.4 of [mbed-tools-ci-scripts](https://gi
 
 [//]: # (begin_release_notes)
 
+"2.10.0" (2022-12-20)
+=====================
+
+Features
+--------
+
+- Added a way to tag releases with version shortcuts such as 1.0 (#20221220194939)
+
+
+Bugfixes
+--------
+
+- Dependency upgrade: scorecard-action-2.1.0 (#20221215071255)
+- Dependency upgrade: coverage-7.0.0 (#20221219070757)
+
+
 "2.9.1" (2022-12-06)
 ====================
 

continuous_delivery_scripts/_version.py

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

docs/get_version.html

@@ -66,7 +66,7 @@ <h1 class="title">Module <code>continuous_delivery_scripts.get_version</code></h
 
 def main() -&gt; None:
     &#34;&#34;&#34;Handle command line arguments to determine version string.&#34;&#34;&#34;
-    parser = argparse.ArgumentParser(description=&#34;Determine project&#39;s version.&#34;)
+    parser = argparse.ArgumentParser(description=&#34;Determine project&#39;s new version.&#34;)
     parser.add_argument(
         &#34;-t&#34;, &#34;--release-type&#34;, help=&#34;type of release to perform&#34;, required=True, type=str, choices=CommitType.choices()
     )
@@ -137,7 +137,7 @@ <h2 id="returns">Returns</h2>
 </summary>
 <pre><code class="python">def main() -&gt; None:
     &#34;&#34;&#34;Handle command line arguments to determine version string.&#34;&#34;&#34;
-    parser = argparse.ArgumentParser(description=&#34;Determine project&#39;s version.&#34;)
+    parser = argparse.ArgumentParser(description=&#34;Determine project&#39;s new version.&#34;)
     parser.add_argument(
         &#34;-t&#34;, &#34;--release-type&#34;, help=&#34;type of release to perform&#34;, required=True, type=str, choices=CommitType.choices()
     )

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
+from typing import Optional, List
 
 from continuous_delivery_scripts.spdx_report.spdx_project import SpdxProject
 from continuous_delivery_scripts.utils.configuration import configuration, ConfigurationVariable
@@ -96,9 +96,9 @@ <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) -&gt; None:
+    def tag_release(self, git: GitWrapper, version: str, shortcuts: List[str]) -&gt; None:
         &#34;&#34;&#34;Tags release commit.&#34;&#34;&#34;
-        super().tag_release(git, version)</code></pre>
+        super().tag_release(git, version, shortcuts)</code></pre>
 </details>
 </section>
 <section>
@@ -167,9 +167,9 @@ <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) -&gt; None:
+    def tag_release(self, git: GitWrapper, version: str, shortcuts: List[str]) -&gt; None:
         &#34;&#34;&#34;Tags release commit.&#34;&#34;&#34;
-        super().tag_release(git, version)</code></pre>
+        super().tag_release(git, version, shortcuts)</code></pre>
 </details>
 <h3>Ancestors</h3>
 <ul class="hlist">

docs/plugins/golang.html

@@ -194,9 +194,9 @@ <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) -&gt; None:
+    def tag_release(self, git: GitWrapper, version: str, shortcuts: List[str]) -&gt; None:
         &#34;&#34;&#34;Tags release commit.&#34;&#34;&#34;
-        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&#34;Golang module release: {go_tag}&#34;)
@@ -289,9 +289,9 @@ <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) -&gt; None:
+    def tag_release(self, git: GitWrapper, version: str, shortcuts: List[str]) -&gt; None:
         &#34;&#34;&#34;Tags release commit.&#34;&#34;&#34;
-        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&#34;Golang module release: {go_tag}&#34;)

docs/tag_and_release.html

@@ -41,7 +41,7 @@ <h1 class="title">Module <code>continuous_delivery_scripts.tag_and_release</code
 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
@@ -52,6 +52,7 @@ <h1 class="title">Module <code>continuous_delivery_scripts.tag_and_release</code
 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 = &#34;licensing&#34;
 
@@ -70,7 +71,7 @@ <h1 class="title">Module <code>continuous_delivery_scripts.tag_and_release</code
 
     &#34;&#34;&#34;
     get_language_specifics().check_credentials()
-    is_new_version, version, _ = version_project(mode)
+    is_new_version, version, version_elements = version_project(mode)
     logger.info(f&#34;Current version: {version}&#34;)
     if not version:
         raise ValueError(&#34;Undefined version.&#34;)
@@ -81,7 +82,7 @@ <h1 class="title">Module <code>continuous_delivery_scripts.tag_and_release</code
     # 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()
@@ -116,7 +117,13 @@ <h1 class="title">Module <code>continuous_delivery_scripts.tag_and_release</code
     return project
 
 
-def _update_repository(mode: CommitType, is_new_version: bool, version: str, current_branch: Optional[str]) -&gt; None:
+def _update_repository(
+    mode: CommitType,
+    is_new_version: bool,
+    version: str,
+    current_branch: Optional[str],
+    version_elements: Dict[str, str],
+) -&gt; None:
     &#34;&#34;&#34;Update repository with changes that happened.&#34;&#34;&#34;
     with ProjectTempClone(desired_branch_name=current_branch) as git:
         git.configure_for_github()
@@ -125,7 +132,7 @@ <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)
+            get_language_specifics().tag_release(git, version, determine_version_shortcuts(mode, version_elements))
             git.force_push_tag()
 
 
@@ -261,7 +268,7 @@ <h2 id="args">Args</h2>
 
     &#34;&#34;&#34;
     get_language_specifics().check_credentials()
-    is_new_version, version, _ = version_project(mode)
+    is_new_version, version, version_elements = version_project(mode)
     logger.info(f&#34;Current version: {version}&#34;)
     if not version:
         raise ValueError(&#34;Undefined version.&#34;)
@@ -272,7 +279,7 @@ <h2 id="args">Args</h2>
     # 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()

docs/third_party_IP_report.csv

@@ -31,7 +31,7 @@ True,Mako,True,https://www.makotemplates.org/,MIT,Licence is compliant.
 True,Markdown,True,https://Python-Markdown.github.io/,0BSD,Licence is compliant.
 True,MarkupSafe,True,https://palletsprojects.com/p/markupsafe/,BSD-3-Clause,Licence is compliant.
 True,more-itertools,True,None,Unknown,Package's licence manually checked: MIT
-True,packaging,True,https://github.com/pypa/packaging,Apache-2.0 OR BSD-2-Clause,Licence is compliant.
+True,packaging,True,None,Unknown,Package's licence manually checked: either Apache-2.0 or BSD-2-Clause
 True,pdoc3,True,https://pdoc3.github.io/pdoc/,AGPL-3.0,Package's licence manually checked: Accepted for this project since not distributed
 True,pkginfo,True,https://code.launchpad.net/~tseaver/pkginfo/trunk,MIT,Licence is compliant.
 True,ply,True,http://www.dabeaz.com/ply/,0BSD,Licence is compliant.

docs/third_party_IP_report.html

@@ -65,7 +65,7 @@
   </head>
   <body>
     <h1>Project's 3rd party IP report</h1>
-    <p><i>2022-12-06 07:55:33.832677</i></p>
+    <p><i>2022-12-20 20:30:52.617239</i></p>
     <h2>Summary</h2>
     <table>
       <thead>
@@ -642,14 +642,14 @@ <h2>Package licences</h2>
         </td>
         <td style="text-align:center">Y</td>
         <td style="text-align:center">
-           https://github.com/pypa/packaging
+           None
         </td>
         <td style="text-align:center">
-            <span style="color: ;">Apache-2.0 OR BSD-2-Clause</span>
+            <span style="color: #ffdf28;">Unknown</span>
 
         </td>
         <td style="text-align:center">
-           Licence is compliant.
+           Package's licence manually checked: either Apache-2.0 or BSD-2-Clause
         </td>
       </tr>
         <tr>

docs/third_party_IP_report.txt

@@ -1,6 +1,6 @@
                                 3rd party IP report for continuous-delivery-scripts
 
-                                         2022-12-06 07:55:33.832677
+                                         2022-12-20 20:30:52.617239
 
 # Summary:
     Licence compliance: Not compliant
@@ -235,9 +235,9 @@
 - packaging:
     [X] Compliant?
     [X] Dependency?
-    URL: https://github.com/pypa/packaging
-    Licence: Apache-2.0 OR BSD-2-Clause
-    Licence compliance: Licence is compliant.
+    URL: None
+    Licence: Unknown
+    Licence compliance: Package's licence manually checked: either Apache-2.0 or BSD-2-Clause
 
 - pdoc3:
     [X] Compliant?

docs/utils/configuration.html

@@ -121,6 +121,8 @@ <h1 class="title">Module <code>continuous_delivery_scripts.utils.configuration</
     &#34;&#34;&#34;News file type for dependency update.&#34;&#34;&#34;
     TAG_LATEST = 35
     &#34;&#34;&#34;States whether the release should be tagged with `latest`&#34;&#34;&#34;
+    TAG_VERSION_SHORTCUTS = 36
+    &#34;&#34;&#34;States whether the release should be tagged with shortcuts i.e. major, major+minor&#34;&#34;&#34;
 
     @staticmethod
     def choices() -&gt; List[str]:
@@ -225,6 +227,7 @@ <h1 class="title">Module <code>continuous_delivery_scripts.utils.configuration</
     AWS_BUCKET = &#34;Unknown&#34;
     AUTOGENERATE_NEWS_FILE_ON_DEPENDENCY_UPDATE = True
     TAG_LATEST = False
+    TAG_VERSION_SHORTCUTS = False
     DEPENDENCY_UPDATE_NEWS_MESSAGE = &#34;Dependency upgrade: {message}&#34;
     DEPENDENCY_UPDATE_NEWS_TYPE = NewsType.bugfix
     DEPENDENCY_UPDATE_BRANCH_PATTERN = r&#34;^\s*[Dd]ependabot\/.+\/(?P&lt;DEPENDENCY&gt;.+)&#34;
@@ -455,6 +458,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
     &#34;&#34;&#34;News file type for dependency update.&#34;&#34;&#34;
     TAG_LATEST = 35
     &#34;&#34;&#34;States whether the release should be tagged with `latest`&#34;&#34;&#34;
+    TAG_VERSION_SHORTCUTS = 36
+    &#34;&#34;&#34;States whether the release should be tagged with shortcuts i.e. major, major+minor&#34;&#34;&#34;
 
     @staticmethod
     def choices() -&gt; List[str]:
@@ -618,6 +623,10 @@ <h3>Class variables</h3>
 <dd>
 <div class="desc"><p>States whether the release should be tagged with <code>latest</code></p></div>
 </dd>
+<dt id="continuous_delivery_scripts.utils.configuration.ConfigurationVariable.TAG_VERSION_SHORTCUTS"><code class="name">var <span class="ident">TAG_VERSION_SHORTCUTS</span></code></dt>
+<dd>
+<div class="desc"><p>States whether the release should be tagged with shortcuts i.e. major, major+minor</p></div>
+</dd>
 <dt id="continuous_delivery_scripts.utils.configuration.ConfigurationVariable.VERSION_FILE_PATH"><code class="name">var <span class="ident">VERSION_FILE_PATH</span></code></dt>
 <dd>
 <div class="desc"><p>Relative path to the file comprising project's version.</p></div>
@@ -1115,6 +1124,7 @@ <h3>Inherited members</h3>
     AWS_BUCKET = &#34;Unknown&#34;
     AUTOGENERATE_NEWS_FILE_ON_DEPENDENCY_UPDATE = True
     TAG_LATEST = False
+    TAG_VERSION_SHORTCUTS = False
     DEPENDENCY_UPDATE_NEWS_MESSAGE = &#34;Dependency upgrade: {message}&#34;
     DEPENDENCY_UPDATE_NEWS_TYPE = NewsType.bugfix
     DEPENDENCY_UPDATE_BRANCH_PATTERN = r&#34;^\s*[Dd]ependabot\/.+\/(?P&lt;DEPENDENCY&gt;.+)&#34;
@@ -1214,6 +1224,10 @@ <h3>Class variables</h3>
 <dd>
 <div class="desc"></div>
 </dd>
+<dt id="continuous_delivery_scripts.utils.configuration.StaticConfig.TAG_VERSION_SHORTCUTS"><code class="name">var <span class="ident">TAG_VERSION_SHORTCUTS</span></code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
 </dl>
 <h3>Inherited members</h3>
 <ul class="hlist">
@@ -1298,6 +1312,7 @@ <h4><code><a title="continuous_delivery_scripts.utils.configuration.Configuratio
 <li><code><a title="continuous_delivery_scripts.utils.configuration.ConfigurationVariable.REMOTE_ALIAS" href="#continuous_delivery_scripts.utils.configuration.ConfigurationVariable.REMOTE_ALIAS">REMOTE_ALIAS</a></code></li>
 <li><code><a title="continuous_delivery_scripts.utils.configuration.ConfigurationVariable.SOURCE_DIR" href="#continuous_delivery_scripts.utils.configuration.ConfigurationVariable.SOURCE_DIR">SOURCE_DIR</a></code></li>
 <li><code><a title="continuous_delivery_scripts.utils.configuration.ConfigurationVariable.TAG_LATEST" href="#continuous_delivery_scripts.utils.configuration.ConfigurationVariable.TAG_LATEST">TAG_LATEST</a></code></li>
+<li><code><a title="continuous_delivery_scripts.utils.configuration.ConfigurationVariable.TAG_VERSION_SHORTCUTS" href="#continuous_delivery_scripts.utils.configuration.ConfigurationVariable.TAG_VERSION_SHORTCUTS">TAG_VERSION_SHORTCUTS</a></code></li>
 <li><code><a title="continuous_delivery_scripts.utils.configuration.ConfigurationVariable.VERSION_FILE_PATH" href="#continuous_delivery_scripts.utils.configuration.ConfigurationVariable.VERSION_FILE_PATH">VERSION_FILE_PATH</a></code></li>
 <li><code><a title="continuous_delivery_scripts.utils.configuration.ConfigurationVariable.choices" href="#continuous_delivery_scripts.utils.configuration.ConfigurationVariable.choices">choices</a></code></li>
 <li><code><a title="continuous_delivery_scripts.utils.configuration.ConfigurationVariable.parse" href="#continuous_delivery_scripts.utils.configuration.ConfigurationVariable.parse">parse</a></code></li>
@@ -1348,6 +1363,7 @@ <h4><code><a title="continuous_delivery_scripts.utils.configuration.StaticConfig
 <li><code><a title="continuous_delivery_scripts.utils.configuration.StaticConfig.RELEASE_BRANCH_PATTERN" href="#continuous_delivery_scripts.utils.configuration.StaticConfig.RELEASE_BRANCH_PATTERN">RELEASE_BRANCH_PATTERN</a></code></li>
 <li><code><a title="continuous_delivery_scripts.utils.configuration.StaticConfig.REMOTE_ALIAS" href="#continuous_delivery_scripts.utils.configuration.StaticConfig.REMOTE_ALIAS">REMOTE_ALIAS</a></code></li>
 <li><code><a title="continuous_delivery_scripts.utils.configuration.StaticConfig.TAG_LATEST" href="#continuous_delivery_scripts.utils.configuration.StaticConfig.TAG_LATEST">TAG_LATEST</a></code></li>
+<li><code><a title="continuous_delivery_scripts.utils.configuration.StaticConfig.TAG_VERSION_SHORTCUTS" href="#continuous_delivery_scripts.utils.configuration.StaticConfig.TAG_VERSION_SHORTCUTS">TAG_VERSION_SHORTCUTS</a></code></li>
 </ul>
 </li>
 <li>