🚀 releasing version 2.11.0 @ 2022-12-21 21:31

[skip ci]

Author: monty-bot

CHANGELOG.md

@@ -17,6 +17,21 @@ This project was forked from version 1.7.4 of [mbed-tools-ci-scripts](https://gi
 
 [//]: # (begin_release_notes)
 
+"2.11.0" (2022-12-21)
+=====================
+
+Features
+--------
+
+- :sparkles: Added a `github_actions` plugin to manage actions or workflow projects (#20221221204057)
+
+
+Bugfixes
+--------
+
+- `[git]` :bug: make sure any staged changes are also applied to repository clones (#20221221183120)
+
+
 "2.10.2" (2022-12-21)
 =====================
 

continuous_delivery_scripts/_version.py

@@ -10,8 +10,8 @@
 
 This file is autogenerated, do not modify by hand.
 """
-__version__ = "2.10.2"
-COMMIT = "5fb7db2cc08dbe9e861e8bc3234ce2508d4c330c"
+__version__ = "2.11.0"
+COMMIT = "7968aa2d316e253b9045810abdacbda55aa8ea56"
 MAJOR = 2
-MINOR = 10
-PATCH = 2
+MINOR = 11
+PATCH = 0

docs/plugins/ci.html

@@ -42,6 +42,7 @@ <h1 class="title">Module <code>continuous_delivery_scripts.plugins.ci</code></h1
 
 from continuous_delivery_scripts.spdx_report.spdx_project import SpdxProject
 from continuous_delivery_scripts.utils.configuration import configuration, ConfigurationVariable
+from continuous_delivery_scripts.utils.definitions import CommitType
 from continuous_delivery_scripts.utils.git_helpers import GitWrapper
 from continuous_delivery_scripts.utils.language_specifics_base import BaseLanguage, get_language_from_file_name
 
@@ -51,10 +52,9 @@ <h1 class="title">Module <code>continuous_delivery_scripts.plugins.ci</code></h1
 class CI(BaseLanguage):
     &#34;&#34;&#34;Specific actions for a CI project.&#34;&#34;&#34;
 
-    def package_software(self, version: str) -&gt; None:
-        &#34;&#34;&#34;No operation.&#34;&#34;&#34;
-        super().package_software(version)
-        # Nothing to do
+    def package_software(self, mode: CommitType, version: str) -&gt; None:
+        &#34;&#34;&#34;Nothing to do.&#34;&#34;&#34;
+        pass
 
     def generate_code_documentation(self, output_directory: Path, module_to_document: str) -&gt; None:
         &#34;&#34;&#34;Generates the code documentation.&#34;&#34;&#34;
@@ -70,9 +70,9 @@ <h1 class="title">Module <code>continuous_delivery_scripts.plugins.ci</code></h1
         cleansed_version = version.strip().lstrip(&#34;v&#34;)
         return f&#34;v{cleansed_version}&#34;
 
-    def release_package_to_repository(self, version: str) -&gt; None:
+    def release_package_to_repository(self, mode: CommitType, version: str) -&gt; None:
         &#34;&#34;&#34;No operation.&#34;&#34;&#34;
-        super().release_package_to_repository(version)
+        pass
 
     def check_credentials(self) -&gt; None:
         &#34;&#34;&#34;Checks any credentials.&#34;&#34;&#34;
@@ -122,10 +122,9 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 <pre><code class="python">class CI(BaseLanguage):
     &#34;&#34;&#34;Specific actions for a CI project.&#34;&#34;&#34;
 
-    def package_software(self, version: str) -&gt; None:
-        &#34;&#34;&#34;No operation.&#34;&#34;&#34;
-        super().package_software(version)
-        # Nothing to do
+    def package_software(self, mode: CommitType, version: str) -&gt; None:
+        &#34;&#34;&#34;Nothing to do.&#34;&#34;&#34;
+        pass
 
     def generate_code_documentation(self, output_directory: Path, module_to_document: str) -&gt; None:
         &#34;&#34;&#34;Generates the code documentation.&#34;&#34;&#34;
@@ -141,9 +140,9 @@ <h2 class="section-title" id="header-classes">Classes</h2>
         cleansed_version = version.strip().lstrip(&#34;v&#34;)
         return f&#34;v{cleansed_version}&#34;
 
-    def release_package_to_repository(self, version: str) -&gt; None:
+    def release_package_to_repository(self, mode: CommitType, version: str) -&gt; None:
         &#34;&#34;&#34;No operation.&#34;&#34;&#34;
-        super().release_package_to_repository(version)
+        pass
 
     def check_credentials(self) -&gt; None:
         &#34;&#34;&#34;Checks any credentials.&#34;&#34;&#34;
@@ -176,6 +175,10 @@ <h3>Ancestors</h3>
 <li><a title="continuous_delivery_scripts.utils.language_specifics_base.BaseLanguage" href="../utils/language_specifics_base.html#continuous_delivery_scripts.utils.language_specifics_base.BaseLanguage">BaseLanguage</a></li>
 <li>abc.ABC</li>
 </ul>
+<h3>Subclasses</h3>
+<ul class="hlist">
+<li><a title="continuous_delivery_scripts.plugins.github_actions.GitHubActions" href="github_actions.html#continuous_delivery_scripts.plugins.github_actions.GitHubActions">GitHubActions</a></li>
+</ul>
 <h3>Methods</h3>
 <dl>
 <dt id="continuous_delivery_scripts.plugins.ci.CI.can_add_licence_headers"><code class="name flex">
@@ -252,32 +255,31 @@ <h3>Methods</h3>
 </details>
 </dd>
 <dt id="continuous_delivery_scripts.plugins.ci.CI.package_software"><code class="name flex">
-<span>def <span class="ident">package_software</span></span>(<span>self, version: str) ‑> None</span>
+<span>def <span class="ident">package_software</span></span>(<span>self, mode: <a title="continuous_delivery_scripts.utils.definitions.CommitType" href="../utils/definitions.html#continuous_delivery_scripts.utils.definitions.CommitType">CommitType</a>, version: str) ‑> None</span>
 </code></dt>
 <dd>
-<div class="desc"><p>No operation.</p></div>
+<div class="desc"><p>Nothing to do.</p></div>
 <details class="source">
 <summary>
 <span>Expand source code</span>
 </summary>
-<pre><code class="python">def package_software(self, version: str) -&gt; None:
-    &#34;&#34;&#34;No operation.&#34;&#34;&#34;
-    super().package_software(version)
-    # Nothing to do</code></pre>
+<pre><code class="python">def package_software(self, mode: CommitType, version: str) -&gt; None:
+    &#34;&#34;&#34;Nothing to do.&#34;&#34;&#34;
+    pass</code></pre>
 </details>
 </dd>
 <dt id="continuous_delivery_scripts.plugins.ci.CI.release_package_to_repository"><code class="name flex">
-<span>def <span class="ident">release_package_to_repository</span></span>(<span>self, version: str) ‑> None</span>
+<span>def <span class="ident">release_package_to_repository</span></span>(<span>self, mode: <a title="continuous_delivery_scripts.utils.definitions.CommitType" href="../utils/definitions.html#continuous_delivery_scripts.utils.definitions.CommitType">CommitType</a>, version: str) ‑> None</span>
 </code></dt>
 <dd>
 <div class="desc"><p>No operation.</p></div>
 <details class="source">
 <summary>
 <span>Expand source code</span>
 </summary>
-<pre><code class="python">def release_package_to_repository(self, version: str) -&gt; None:
+<pre><code class="python">def release_package_to_repository(self, mode: CommitType, version: str) -&gt; None:
     &#34;&#34;&#34;No operation.&#34;&#34;&#34;
-    super().release_package_to_repository(version)</code></pre>
+    pass</code></pre>
 </details>
 </dd>
 </dl>

docs/plugins/docker.html

@@ -40,6 +40,7 @@ <h1 class="title">Module <code>continuous_delivery_scripts.plugins.docker</code>
 from pathlib import Path
 from typing import Optional
 from continuous_delivery_scripts.utils.language_specifics_base import BaseLanguage, get_language_from_file_name
+from continuous_delivery_scripts.utils.definitions import CommitType
 from continuous_delivery_scripts.spdx_report.spdx_project import SpdxProject
 
 logger = logging.getLogger(__name__)
@@ -52,13 +53,13 @@ <h1 class="title">Module <code>continuous_delivery_scripts.plugins.docker</code>
         &#34;&#34;&#34;Gets the related language.&#34;&#34;&#34;
         return get_language_from_file_name(__file__)
 
-    def package_software(self, version: str) -&gt; None:
+    def package_software(self, mode: CommitType, version: str) -&gt; None:
         &#34;&#34;&#34;Todo build docker image.&#34;&#34;&#34;
-        super().package_software(version)
+        super().package_software(mode, version)
 
-    def release_package_to_repository(self, version: str) -&gt; None:
+    def release_package_to_repository(self, mode: CommitType, version: str) -&gt; None:
         &#34;&#34;&#34;Todo push image to repository e.g. ecr, artifactory.&#34;&#34;&#34;
-        super().release_package_to_repository(version)
+        super().release_package_to_repository(mode, version)
 
     def check_credentials(self) -&gt; None:
         &#34;&#34;&#34;Checks any credentials.&#34;&#34;&#34;
@@ -109,13 +110,13 @@ <h2 class="section-title" id="header-classes">Classes</h2>
         &#34;&#34;&#34;Gets the related language.&#34;&#34;&#34;
         return get_language_from_file_name(__file__)
 
-    def package_software(self, version: str) -&gt; None:
+    def package_software(self, mode: CommitType, version: str) -&gt; None:
         &#34;&#34;&#34;Todo build docker image.&#34;&#34;&#34;
-        super().package_software(version)
+        super().package_software(mode, version)
 
-    def release_package_to_repository(self, version: str) -&gt; None:
+    def release_package_to_repository(self, mode: CommitType, version: str) -&gt; None:
         &#34;&#34;&#34;Todo push image to repository e.g. ecr, artifactory.&#34;&#34;&#34;
-        super().release_package_to_repository(version)
+        super().release_package_to_repository(mode, version)
 
     def check_credentials(self) -&gt; None:
         &#34;&#34;&#34;Checks any credentials.&#34;&#34;&#34;
@@ -206,31 +207,31 @@ <h3>Methods</h3>
 </details>
 </dd>
 <dt id="continuous_delivery_scripts.plugins.docker.Docker.package_software"><code class="name flex">
-<span>def <span class="ident">package_software</span></span>(<span>self, version: str) ‑> None</span>
+<span>def <span class="ident">package_software</span></span>(<span>self, mode: <a title="continuous_delivery_scripts.utils.definitions.CommitType" href="../utils/definitions.html#continuous_delivery_scripts.utils.definitions.CommitType">CommitType</a>, version: str) ‑> None</span>
 </code></dt>
 <dd>
 <div class="desc"><p>Todo build docker image.</p></div>
 <details class="source">
 <summary>
 <span>Expand source code</span>
 </summary>
-<pre><code class="python">def package_software(self, version: str) -&gt; None:
+<pre><code class="python">def package_software(self, mode: CommitType, version: str) -&gt; None:
     &#34;&#34;&#34;Todo build docker image.&#34;&#34;&#34;
-    super().package_software(version)</code></pre>
+    super().package_software(mode, version)</code></pre>
 </details>
 </dd>
 <dt id="continuous_delivery_scripts.plugins.docker.Docker.release_package_to_repository"><code class="name flex">
-<span>def <span class="ident">release_package_to_repository</span></span>(<span>self, version: str) ‑> None</span>
+<span>def <span class="ident">release_package_to_repository</span></span>(<span>self, mode: <a title="continuous_delivery_scripts.utils.definitions.CommitType" href="../utils/definitions.html#continuous_delivery_scripts.utils.definitions.CommitType">CommitType</a>, version: str) ‑> None</span>
 </code></dt>
 <dd>
 <div class="desc"><p>Todo push image to repository e.g. ecr, artifactory.</p></div>
 <details class="source">
 <summary>
 <span>Expand source code</span>
 </summary>
-<pre><code class="python">def release_package_to_repository(self, version: str) -&gt; None:
+<pre><code class="python">def release_package_to_repository(self, mode: CommitType, version: str) -&gt; None:
     &#34;&#34;&#34;Todo push image to repository e.g. ecr, artifactory.&#34;&#34;&#34;
-    super().release_package_to_repository(version)</code></pre>
+    super().release_package_to_repository(mode, version)</code></pre>
 </details>
 </dd>
 </dl>