🚀 releasing version 2.8.0 @ 2021-08-26 14:54

[skip ci]

Author: monty-bot

CHANGELOG.md

@@ -17,6 +17,15 @@ This project was forked from version 1.7.4 of [mbed-tools-ci-scripts](https://gi
 
 [//]: # (begin_release_notes)
 
+"2.8.0" (2021-08-26)"2.8.0" (2021-08-26)
+====================
+
+Features
+--------
+
+- Made release tagging language configurable. (#202108251834)
+
+
 "2.7.2" (2021-08-25)"2.7.2" (2021-08-25)
 ====================
 

continuous_delivery_scripts/_version.py

@@ -10,8 +10,8 @@
 
 This file is autogenerated, do not modify by hand.
 """
-__version__ = "2.7.2"
-COMMIT = "ee8a4c3cd200ccf9c8e4d3c971a9a871c034a00d"
+__version__ = "2.8.0"
+COMMIT = "7ece838aa7a094c72cdeb256ed3101a91542d07a"
 MAJOR = 2
-MINOR = 7
-PATCH = 2
+MINOR = 8
+PATCH = 0

docs/plugins/docker.html

@@ -244,6 +244,7 @@ <h3>Inherited members</h3>
 <li><code><a title="continuous_delivery_scripts.utils.language_specifics_base.BaseLanguage.get_version_tag" href="../utils/language_specifics_base.html#continuous_delivery_scripts.utils.language_specifics_base.BaseLanguage.get_version_tag">get_version_tag</a></code></li>
 <li><code><a title="continuous_delivery_scripts.utils.language_specifics_base.BaseLanguage.should_clean_before_packaging" href="../utils/language_specifics_base.html#continuous_delivery_scripts.utils.language_specifics_base.BaseLanguage.should_clean_before_packaging">should_clean_before_packaging</a></code></li>
 <li><code><a title="continuous_delivery_scripts.utils.language_specifics_base.BaseLanguage.should_include_spdx_in_package" href="../utils/language_specifics_base.html#continuous_delivery_scripts.utils.language_specifics_base.BaseLanguage.should_include_spdx_in_package">should_include_spdx_in_package</a></code></li>
+<li><code><a title="continuous_delivery_scripts.utils.language_specifics_base.BaseLanguage.tag_release" href="../utils/language_specifics_base.html#continuous_delivery_scripts.utils.language_specifics_base.BaseLanguage.tag_release">tag_release</a></code></li>
 </ul>
 </li>
 </ul>

docs/plugins/golang.html

@@ -44,14 +44,16 @@ <h1 class="title">Module <code>continuous_delivery_scripts.plugins.golang</code>
 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
 from continuous_delivery_scripts.utils.configuration import configuration, ConfigurationVariable
-from continuous_delivery_scripts.utils.git_helpers import LocalProjectRepository
+from continuous_delivery_scripts.utils.git_helpers import LocalProjectRepository, GitWrapper
 
 logger = logging.getLogger(__name__)
 
-SRC_DIR = configuration.get_value(ConfigurationVariable.SOURCE_DIR)
-ROOT_DIR = configuration.get_value(ConfigurationVariable.PROJECT_ROOT)
+SRC_DIR = Path(str(configuration.get_value(ConfigurationVariable.SOURCE_DIR)))
+ROOT_DIR = Path(str(configuration.get_value(ConfigurationVariable.PROJECT_ROOT)))
 ENVVAR_GORELEASER_GIT_TOKEN = &#34;GITHUB_TOKEN&#34;
 ENVVAR_GORELEASER_CUSTOMISED_TAG = &#34;GORELEASER_CURRENT_TAG&#34;
+ENVVAR_GO_MOD = &#34;GO111MODULE&#34;
+GO_MOD_ON_VALUE = &#34;on&#34;
 
 
 def _generate_golds_command_list(output_directory: Path, module: str) -&gt; List[str]:
@@ -86,20 +88,43 @@ <h1 class="title">Module <code>continuous_delivery_scripts.plugins.golang</code>
 def _call_golds(output_directory: Path, module: str) -&gt; None:
     &#34;&#34;&#34;Calls Golds for generating the docs.&#34;&#34;&#34;
     logger.info(&#34;Installing Golds if missing.&#34;)
-    check_call(_install_golds_command_list())
+    env = os.environ
+    env[ENVVAR_GO_MOD] = GO_MOD_ON_VALUE
+    check_call(_install_golds_command_list(), env=env)
     logger.info(&#34;Creating Golds documentation.&#34;)
-    check_call(_generate_golds_command_list(output_directory, module), cwd=SRC_DIR)
+    check_call(_generate_golds_command_list(output_directory, module), cwd=SRC_DIR, env=env)
 
 
 def _call_goreleaser_check(version: str) -&gt; None:
     &#34;&#34;&#34;Calls go releaser check to verify configuration.&#34;&#34;&#34;
     logger.info(&#34;Installing GoReleaser if missing.&#34;)
-    check_call(_install_goreleaser_command_list())
-    logger.info(&#34;Checking GoReleaser configuration.&#34;)
     env = os.environ
+    env[ENVVAR_GO_MOD] = GO_MOD_ON_VALUE
+    check_call(_install_goreleaser_command_list(), env=env)
+    logger.info(&#34;Checking GoReleaser configuration.&#34;)
     env[ENVVAR_GORELEASER_CUSTOMISED_TAG] = version
     env[ENVVAR_GORELEASER_GIT_TOKEN] = configuration.get_value(ConfigurationVariable.GIT_TOKEN)
-    check_call(_generate_goreleaser_check_command_list(), cwd=ROOT_DIR)
+    check_call(_generate_goreleaser_check_command_list(), cwd=ROOT_DIR, env=env)
+
+
+def _determine_go_module_tag(version) -&gt; Optional[str]:
+    &#34;&#34;&#34;Determines go module for tagging.
+
+    See https://golang.org/ref/mod#vcs-version.
+    and https://github.com/golang/go/wiki/Modules#should-i-have-multiple-modules-in-a-single-repository.
+    &#34;&#34;&#34;
+    module = &#34;&#34;
+    try:
+        module = str(SRC_DIR.relative_to(ROOT_DIR))
+    except ValueError:
+        try:
+            module = str(ROOT_DIR.relative_to(SRC_DIR))
+        except ValueError as exception:
+            logger.warning(exception)
+    if module == &#34;.&#34; or len(module) == 0:
+        return None
+    module = module.rstrip(&#34;/&#34;)
+    return f&#34;{module}/{version}&#34;
 
 
 class Go(BaseLanguage):
@@ -151,10 +176,19 @@ <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:
+        &#34;&#34;&#34;Tags release commit.&#34;&#34;&#34;
+        super().tag_release(git, version)
+        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;)
+
     def _call_goreleaser_release(self, version: str) -&gt; None:
         &#34;&#34;&#34;Calls go releaser release to upload packages.&#34;&#34;&#34;
         logger.info(&#34;Installing GoReleaser if missing.&#34;)
-        check_call(_install_goreleaser_command_list())
+        env = os.environ
+        env[ENVVAR_GO_MOD] = GO_MOD_ON_VALUE
+        check_call(_install_goreleaser_command_list(), env=env)
         tag = self.get_version_tag(version)
         # The tag of the release must be retrieved
         # See https://github.com/goreleaser/goreleaser/discussions/1426
@@ -165,7 +199,6 @@ <h1 class="title">Module <code>continuous_delivery_scripts.plugins.golang</code>
             git.checkout(f&#34;tags/{tag}&#34;)
         logger.info(&#34;Release package.&#34;)
         changelogPath = configuration.get_value(ConfigurationVariable.CHANGELOG_FILE_PATH)
-        env = os.environ
         env[ENVVAR_GORELEASER_CUSTOMISED_TAG] = tag
         env[ENVVAR_GORELEASER_GIT_TOKEN] = configuration.get_value(ConfigurationVariable.GIT_TOKEN)
         check_call(_generate_goreleaser_release_command_list(changelogPath), cwd=ROOT_DIR, env=env)</code></pre>
@@ -238,10 +271,19 @@ <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:
+        &#34;&#34;&#34;Tags release commit.&#34;&#34;&#34;
+        super().tag_release(git, version)
+        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;)
+
     def _call_goreleaser_release(self, version: str) -&gt; None:
         &#34;&#34;&#34;Calls go releaser release to upload packages.&#34;&#34;&#34;
         logger.info(&#34;Installing GoReleaser if missing.&#34;)
-        check_call(_install_goreleaser_command_list())
+        env = os.environ
+        env[ENVVAR_GO_MOD] = GO_MOD_ON_VALUE
+        check_call(_install_goreleaser_command_list(), env=env)
         tag = self.get_version_tag(version)
         # The tag of the release must be retrieved
         # See https://github.com/goreleaser/goreleaser/discussions/1426
@@ -252,7 +294,6 @@ <h2 class="section-title" id="header-classes">Classes</h2>
             git.checkout(f&#34;tags/{tag}&#34;)
         logger.info(&#34;Release package.&#34;)
         changelogPath = configuration.get_value(ConfigurationVariable.CHANGELOG_FILE_PATH)
-        env = os.environ
         env[ENVVAR_GORELEASER_CUSTOMISED_TAG] = tag
         env[ENVVAR_GORELEASER_GIT_TOKEN] = configuration.get_value(ConfigurationVariable.GIT_TOKEN)
         check_call(_generate_goreleaser_release_command_list(changelogPath), cwd=ROOT_DIR, env=env)</code></pre>
@@ -377,6 +418,7 @@ <h3>Inherited members</h3>
 <li><code><a title="continuous_delivery_scripts.utils.language_specifics_base.BaseLanguage.generate_source_licence_header_template" href="../utils/language_specifics_base.html#continuous_delivery_scripts.utils.language_specifics_base.BaseLanguage.generate_source_licence_header_template">generate_source_licence_header_template</a></code></li>
 <li><code><a title="continuous_delivery_scripts.utils.language_specifics_base.BaseLanguage.should_clean_before_packaging" href="../utils/language_specifics_base.html#continuous_delivery_scripts.utils.language_specifics_base.BaseLanguage.should_clean_before_packaging">should_clean_before_packaging</a></code></li>
 <li><code><a title="continuous_delivery_scripts.utils.language_specifics_base.BaseLanguage.should_include_spdx_in_package" href="../utils/language_specifics_base.html#continuous_delivery_scripts.utils.language_specifics_base.BaseLanguage.should_include_spdx_in_package">should_include_spdx_in_package</a></code></li>
+<li><code><a title="continuous_delivery_scripts.utils.language_specifics_base.BaseLanguage.tag_release" href="../utils/language_specifics_base.html#continuous_delivery_scripts.utils.language_specifics_base.BaseLanguage.tag_release">tag_release</a></code></li>
 </ul>
 </li>
 </ul>

docs/plugins/noop.html

@@ -266,6 +266,7 @@ <h3>Inherited members</h3>
 <li><code><a title="continuous_delivery_scripts.utils.language_specifics_base.BaseLanguage.get_version_tag" href="../utils/language_specifics_base.html#continuous_delivery_scripts.utils.language_specifics_base.BaseLanguage.get_version_tag">get_version_tag</a></code></li>
 <li><code><a title="continuous_delivery_scripts.utils.language_specifics_base.BaseLanguage.should_clean_before_packaging" href="../utils/language_specifics_base.html#continuous_delivery_scripts.utils.language_specifics_base.BaseLanguage.should_clean_before_packaging">should_clean_before_packaging</a></code></li>
 <li><code><a title="continuous_delivery_scripts.utils.language_specifics_base.BaseLanguage.should_include_spdx_in_package" href="../utils/language_specifics_base.html#continuous_delivery_scripts.utils.language_specifics_base.BaseLanguage.should_include_spdx_in_package">should_include_spdx_in_package</a></code></li>
+<li><code><a title="continuous_delivery_scripts.utils.language_specifics_base.BaseLanguage.tag_release" href="../utils/language_specifics_base.html#continuous_delivery_scripts.utils.language_specifics_base.BaseLanguage.tag_release">tag_release</a></code></li>
 </ul>
 </li>
 </ul>

docs/plugins/python.html

@@ -393,6 +393,7 @@ <h3>Inherited members</h3>
 <li><code><a title="continuous_delivery_scripts.utils.language_specifics_base.BaseLanguage.get_version_tag" href="../utils/language_specifics_base.html#continuous_delivery_scripts.utils.language_specifics_base.BaseLanguage.get_version_tag">get_version_tag</a></code></li>
 <li><code><a title="continuous_delivery_scripts.utils.language_specifics_base.BaseLanguage.should_clean_before_packaging" href="../utils/language_specifics_base.html#continuous_delivery_scripts.utils.language_specifics_base.BaseLanguage.should_clean_before_packaging">should_clean_before_packaging</a></code></li>
 <li><code><a title="continuous_delivery_scripts.utils.language_specifics_base.BaseLanguage.should_include_spdx_in_package" href="../utils/language_specifics_base.html#continuous_delivery_scripts.utils.language_specifics_base.BaseLanguage.should_include_spdx_in_package">should_include_spdx_in_package</a></code></li>
+<li><code><a title="continuous_delivery_scripts.utils.language_specifics_base.BaseLanguage.tag_release" href="../utils/language_specifics_base.html#continuous_delivery_scripts.utils.language_specifics_base.BaseLanguage.tag_release">tag_release</a></code></li>
 </ul>
 </li>
 </ul>

docs/tag_and_release.html

@@ -125,8 +125,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:
-            logger.info(&#34;Tagging commit&#34;)
-            git.create_tag(get_language_specifics().get_version_tag(version), message=f&#34;release {version}&#34;)
+            get_language_specifics().tag_release(git, version)
             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>2021-08-25 02:02:30.640660</i></p>
+    <p><i>2021-08-26 14:54:11.586123</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
 
-                                         2021-08-25 02:02:30.640660
+                                         2021-08-26 14:54:11.586123
 
 # Summary:
     Licence compliance: Compliant

docs/utils/language_specifics_base.html

@@ -44,6 +44,7 @@ <h1 class="title">Module <code>continuous_delivery_scripts.utils.language_specif
 
 from continuous_delivery_scripts.spdx_report.spdx_project import SpdxProject
 from continuous_delivery_scripts.utils.configuration import configuration, ConfigurationVariable
+from continuous_delivery_scripts.utils.git_helpers import GitWrapper
 
 logger = logging.getLogger(__name__)
 
@@ -106,6 +107,11 @@ <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) -&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;)
+
     @abstractmethod
     def generate_code_documentation(self, output_directory: Path, module_to_document: str) -&gt; None:
         &#34;&#34;&#34;Generates the code documentation.&#34;&#34;&#34;
@@ -210,6 +216,11 @@ <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) -&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;)
+
     @abstractmethod
     def generate_code_documentation(self, output_directory: Path, module_to_document: str) -&gt; None:
         &#34;&#34;&#34;Generates the code documentation.&#34;&#34;&#34;
@@ -428,6 +439,21 @@ <h3>Methods</h3>
     return False</code></pre>
 </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) ‑> NoneType</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) -&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;)</code></pre>
+</details>
+</dd>
 </dl>
 </dd>
 </dl>
@@ -466,6 +492,7 @@ <h4><code><a title="continuous_delivery_scripts.utils.language_specifics_base.Ba
 <li><code><a title="continuous_delivery_scripts.utils.language_specifics_base.BaseLanguage.release_package_to_repository" href="#continuous_delivery_scripts.utils.language_specifics_base.BaseLanguage.release_package_to_repository">release_package_to_repository</a></code></li>
 <li><code><a title="continuous_delivery_scripts.utils.language_specifics_base.BaseLanguage.should_clean_before_packaging" href="#continuous_delivery_scripts.utils.language_specifics_base.BaseLanguage.should_clean_before_packaging">should_clean_before_packaging</a></code></li>
 <li><code><a title="continuous_delivery_scripts.utils.language_specifics_base.BaseLanguage.should_include_spdx_in_package" href="#continuous_delivery_scripts.utils.language_specifics_base.BaseLanguage.should_include_spdx_in_package">should_include_spdx_in_package</a></code></li>
+<li><code><a title="continuous_delivery_scripts.utils.language_specifics_base.BaseLanguage.tag_release" href="#continuous_delivery_scripts.utils.language_specifics_base.BaseLanguage.tag_release">tag_release</a></code></li>
 </ul>
 </li>
 </ul>