🚀 releasing version 2.2.4 @ 2021-08-11 02:33

[skip ci]

Author: monty-bot

CHANGELOG.md

@@ -13,6 +13,22 @@ This project was forked from version 1.7.4 of [mbed-tools-ci-scripts](https://gi
 
 [//]: # (begin_release_notes)
 
+"2.2.4" (2021-08-11)
+====================
+
+Bugfixes
+--------
+
+- Fixed dependency update news file bug (#202108110247)
+- Fixed local assert news file (#20210811024701)
+
+
+Misc
+----
+
+- #202108110255
+
+
 "2.2.3" (2021-08-11)
 ====================
 

continuous_delivery_scripts/_version.py

@@ -10,8 +10,8 @@
 
 This file is autogenerated, do not modify by hand.
 """
-__version__ = "2.2.3"
-COMMIT = "e35be277302dcfa48495d5da398730e67d0d91ba"
+__version__ = "2.2.4"
+COMMIT = "3419789b01c48e806cf32b55fb5eb7834195d7d9"
 MAJOR = 2
 MINOR = 2
-PATCH = 3
+PATCH = 4

docs/assert_news.html

@@ -32,7 +32,7 @@ <h1 class="title">Module <code>continuous_delivery_scripts.assert_news</code></h
 <span>Expand source code</span>
 </summary>
 <pre><code class="python">#
-# Copyright (C) 2020-2021 Arm. All rights reserved.
+# Copyright (C) 2020-2021 Arm Limited or its affiliates and Contributors. All rights reserved.
 # SPDX-License-Identifier: Apache-2.0
 #
 &#34;&#34;&#34;Checks if valid news files are created for changes in the project.&#34;&#34;&#34;
@@ -126,12 +126,12 @@ <h1 class="title">Module <code>continuous_delivery_scripts.assert_news</code></h
         validate_news_file(absolute_file_path)
 
 
-def generate_news_file(git: GitWrapper, news_dir: str) -&gt; pathlib.Path:
+def generate_news_file(git: GitWrapper, news_dir: pathlib.Path) -&gt; pathlib.Path:
     &#34;&#34;&#34;Adds a news file if the branch corresponds to an dependency update.
 
     Args:
         git: Instance of GitWrapper.
-        news_dir: Relative path to news directory.
+        news_dir: path to news directory.
     &#34;&#34;&#34;
     current_branch = str(git.get_current_branch())
     is_dependency_update, groups = git.is_current_branch_of_type(
@@ -147,19 +147,21 @@ <h1 class="title">Module <code>continuous_delivery_scripts.assert_news</code></h
     )
     logger.info(f&#34;Generating a news file with content: {message}...&#34;)
     return create_news_file(
-        news_dir,
+        str(news_dir),
         message,
         configuration.get_value(ConfigurationVariable.DEPENDENCY_UPDATE_NEWS_TYPE),
     )
 
 
-def _commit_news_file(git: GitWrapper, news_file: pathlib.Path) -&gt; None:
+def _commit_news_file(git: GitWrapper, news_file: pathlib.Path, local: bool) -&gt; None:
     logger.info(f&#34;Committing news file {str(news_file)}...&#34;)
-    git.configure_for_github()
+    if not local:
+        git.configure_for_github()
     git.add(str(news_file))
     git.commit(&#34;📰 Automatic changes ⚙ Adding news file&#34;)
-    git.push()
-    git.pull()
+    if not local:
+        git.push()
+        git.pull()
 
 
 def main() -&gt; None:
@@ -185,8 +187,8 @@ <h1 class="title">Module <code>continuous_delivery_scripts.assert_news</code></h
             except Exception as e:
                 log_exception(logger, e)
                 try:
-                    news_file = generate_news_file(git, absolute_news_dir)
-                    _commit_news_file(git, news_file)
+                    news_file = generate_news_file(git, git.get_corresponding_path(pathlib.Path(news_dir)))
+                    _commit_news_file(git, news_file, args.local)
                 except Exception as e2:
                     log_exception(logger, e2)
                 sys.exit(1)
@@ -245,7 +247,7 @@ <h2 id="returns">Returns</h2>
 </details>
 </dd>
 <dt id="continuous_delivery_scripts.assert_news.generate_news_file"><code class="name flex">
-<span>def <span class="ident">generate_news_file</span></span>(<span>git: <a title="continuous_delivery_scripts.utils.git_helpers.GitWrapper" href="utils/git_helpers.html#continuous_delivery_scripts.utils.git_helpers.GitWrapper">GitWrapper</a>, news_dir: str) ‑> pathlib.Path</span>
+<span>def <span class="ident">generate_news_file</span></span>(<span>git: <a title="continuous_delivery_scripts.utils.git_helpers.GitWrapper" href="utils/git_helpers.html#continuous_delivery_scripts.utils.git_helpers.GitWrapper">GitWrapper</a>, news_dir: pathlib.Path) ‑> pathlib.Path</span>
 </code></dt>
 <dd>
 <div class="desc"><p>Adds a news file if the branch corresponds to an dependency update.</p>
@@ -254,18 +256,18 @@ <h2 id="args">Args</h2>
 <dt><strong><code>git</code></strong></dt>
 <dd>Instance of GitWrapper.</dd>
 <dt><strong><code>news_dir</code></strong></dt>
-<dd>Relative path to news directory.</dd>
+<dd>path to news directory.</dd>
 </dl></div>
 <details class="source">
 <summary>
 <span>Expand source code</span>
 </summary>
-<pre><code class="python">def generate_news_file(git: GitWrapper, news_dir: str) -&gt; pathlib.Path:
+<pre><code class="python">def generate_news_file(git: GitWrapper, news_dir: pathlib.Path) -&gt; pathlib.Path:
     &#34;&#34;&#34;Adds a news file if the branch corresponds to an dependency update.
 
     Args:
         git: Instance of GitWrapper.
-        news_dir: Relative path to news directory.
+        news_dir: path to news directory.
     &#34;&#34;&#34;
     current_branch = str(git.get_current_branch())
     is_dependency_update, groups = git.is_current_branch_of_type(
@@ -281,7 +283,7 @@ <h2 id="args">Args</h2>
     )
     logger.info(f&#34;Generating a news file with content: {message}...&#34;)
     return create_news_file(
-        news_dir,
+        str(news_dir),
         message,
         configuration.get_value(ConfigurationVariable.DEPENDENCY_UPDATE_NEWS_TYPE),
     )</code></pre>
@@ -319,8 +321,8 @@ <h2 id="args">Args</h2>
             except Exception as e:
                 log_exception(logger, e)
                 try:
-                    news_file = generate_news_file(git, absolute_news_dir)
-                    _commit_news_file(git, news_file)
+                    news_file = generate_news_file(git, git.get_corresponding_path(pathlib.Path(news_dir)))
+                    _commit_news_file(git, news_file, args.local)
                 except Exception as e2:
                     log_exception(logger, e2)
                 sys.exit(1)</code></pre>

docs/create_news_file.html

@@ -34,7 +34,7 @@ <h2 id="usage">Usage</h2>
 <span>Expand source code</span>
 </summary>
 <pre><code class="python">#
-# Copyright (C) 2020-2021 Arm. All rights reserved.
+# Copyright (C) 2020-2021 Arm Limited or its affiliates and Contributors. All rights reserved.
 # SPDX-License-Identifier: Apache-2.0
 #
 &#34;&#34;&#34;Easy news files generation.

docs/generate_docs.html

@@ -32,7 +32,7 @@ <h1 class="title">Module <code>continuous_delivery_scripts.generate_docs</code><
 <span>Expand source code</span>
 </summary>
 <pre><code class="python">#
-# Copyright (C) 2020-2021 Arm. All rights reserved.
+# Copyright (C) 2020-2021 Arm Limited or its affiliates and Contributors. All rights reserved.
 # SPDX-License-Identifier: Apache-2.0
 #
 &#34;&#34;&#34;Generates documentation.&#34;&#34;&#34;

docs/generate_news.html

@@ -32,7 +32,7 @@ <h1 class="title">Module <code>continuous_delivery_scripts.generate_news</code><
 <span>Expand source code</span>
 </summary>
 <pre><code class="python">#
-# Copyright (C) 2020-2021 Arm. All rights reserved.
+# Copyright (C) 2020-2021 Arm Limited or its affiliates and Contributors. All rights reserved.
 # SPDX-License-Identifier: Apache-2.0
 #
 &#34;&#34;&#34;Handles usage of towncrier for automated changelog generation and pyautoversion for versioning.&#34;&#34;&#34;

docs/get_config.html

@@ -32,7 +32,7 @@ <h1 class="title">Module <code>continuous_delivery_scripts.get_config</code></h1
 <span>Expand source code</span>
 </summary>
 <pre><code class="python">#
-# Copyright (C) 2020-2021 Arm. All rights reserved.
+# Copyright (C) 2020-2021 Arm Limited or its affiliates and Contributors. All rights reserved.
 # SPDX-License-Identifier: Apache-2.0
 #
 &#34;&#34;&#34;Retrieves configuration values.&#34;&#34;&#34;

docs/index.html

@@ -32,7 +32,7 @@ <h1 class="title">Package <code>continuous_delivery_scripts</code></h1>
 <span>Expand source code</span>
 </summary>
 <pre><code class="python">#
-# Copyright (C) 2020-2021 Arm. All rights reserved.
+# Copyright (C) 2020-2021 Arm Limited or its affiliates and Contributors. All rights reserved.
 # SPDX-License-Identifier: Apache-2.0
 #
 &#34;&#34;&#34;Scripts and utilities used by the CI pipeline.&#34;&#34;&#34;

docs/language_specifics.html

@@ -32,7 +32,7 @@ <h1 class="title">Module <code>continuous_delivery_scripts.language_specifics</c
 <span>Expand source code</span>
 </summary>
 <pre><code class="python">#
-# Copyright (C) 2020-2021 Arm. All rights reserved.
+# Copyright (C) 2020-2021 Arm Limited or its affiliates and Contributors. All rights reserved.
 # SPDX-License-Identifier: Apache-2.0
 #
 &#34;&#34;&#34;Language plugins Loader.&#34;&#34;&#34;

docs/license_files.html

@@ -34,7 +34,7 @@ <h1 class="title">Module <code>continuous_delivery_scripts.license_files</code><
 <span>Expand source code</span>
 </summary>
 <pre><code class="python">#
-# Copyright (C) 2020-2021 Arm. All rights reserved.
+# Copyright (C) 2020-2021 Arm Limited or its affiliates and Contributors. All rights reserved.
 # SPDX-License-Identifier: Apache-2.0
 #
 &#34;&#34;&#34;Apply copyright and licensing to all source files present in a project.