🚀 releasing version 2.2.3 @ 2021-08-11 00:51

[skip ci]

Author: monty-bot

CHANGELOG.md

@@ -13,6 +13,15 @@ This project was forked from version 1.7.4 of [mbed-tools-ci-scripts](https://gi
 
 [//]: # (begin_release_notes)
 
+"2.2.3" (2021-08-11)
+====================
+
+Bugfixes
+--------
+
+- Improved logging when creating and asserting news files (#202108110106)
+
+
 "2.2.2" (2021-08-10)
 ====================
 

continuous_delivery_scripts/_version.py

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

docs/assert_news.html

@@ -126,7 +126,7 @@ <h1 class="title">Module <code>continuous_delivery_scripts.assert_news</code></h
         validate_news_file(absolute_file_path)
 
 
-def add_news_files(git: GitWrapper, news_dir: str) -&gt; None:
+def generate_news_file(git: GitWrapper, news_dir: str) -&gt; pathlib.Path:
     &#34;&#34;&#34;Adds a news file if the branch corresponds to an dependency update.
 
     Args:
@@ -142,19 +142,21 @@ <h1 class="title">Module <code>continuous_delivery_scripts.assert_news</code></h
     if not configuration.get_value(ConfigurationVariable.AUTOGENERATE_NEWS_FILE_ON_DEPENDENCY_UPDATE):
         raise EnvironmentError(f&#34;Branch {current_branch} must contain a news file.&#34;)
 
-    create_news_file(
+    message = str(configuration.get_value(ConfigurationVariable.DEPENDENCY_UPDATE_NEWS_MESSAGE)).format(
+        message=&#34;, &#34;.join(groups)
+    )
+    logger.info(f&#34;Generating a news file with content: {message}...&#34;)
+    return create_news_file(
         news_dir,
-        str(configuration.get_value(ConfigurationVariable.DEPENDENCY_UPDATE_NEWS_MESSAGE)).format(
-            message=&#34;, &#34;.join(groups)
-        ),
+        message,
         configuration.get_value(ConfigurationVariable.DEPENDENCY_UPDATE_NEWS_TYPE),
     )
 
 
-def _commit_news_file(git: GitWrapper, news_dir: str) -&gt; None:
-    logger.info(&#34;Committing news file...&#34;)
+def _commit_news_file(git: GitWrapper, news_file: pathlib.Path) -&gt; None:
+    logger.info(f&#34;Committing news file {str(news_file)}...&#34;)
     git.configure_for_github()
-    git.add(news_dir)
+    git.add(str(news_file))
     git.commit(&#34;📰 Automatic changes ⚙ Adding news file&#34;)
     git.push()
     git.pull()
@@ -183,11 +185,11 @@ <h1 class="title">Module <code>continuous_delivery_scripts.assert_news</code></h
             except Exception as e:
                 log_exception(logger, e)
                 try:
-                    add_news_files(git, absolute_news_dir)
-                    _commit_news_file(git, absolute_news_dir)
+                    news_file = generate_news_file(git, absolute_news_dir)
+                    _commit_news_file(git, news_file)
                 except Exception as e2:
                     log_exception(logger, e2)
-                    sys.exit(1)
+                sys.exit(1)
 
 
 if __name__ == &#34;__main__&#34;:
@@ -201,47 +203,6 @@ <h1 class="title">Module <code>continuous_delivery_scripts.assert_news</code></h
 <section>
 <h2 class="section-title" id="header-functions">Functions</h2>
 <dl>
-<dt id="continuous_delivery_scripts.assert_news.add_news_files"><code class="name flex">
-<span>def <span class="ident">add_news_files</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) ‑> NoneType</span>
-</code></dt>
-<dd>
-<div class="desc"><p>Adds a news file if the branch corresponds to an dependency update.</p>
-<h2 id="args">Args</h2>
-<dl>
-<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>
-</dl></div>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def add_news_files(git: GitWrapper, news_dir: str) -&gt; None:
-    &#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.
-    &#34;&#34;&#34;
-    current_branch = str(git.get_current_branch())
-    is_dependency_update, groups = git.is_current_branch_of_type(
-        str(configuration.get_value(ConfigurationVariable.DEPENDENCY_UPDATE_BRANCH_PATTERN))
-    )
-    if not is_dependency_update:
-        raise EnvironmentError(f&#34;Branch {current_branch} must contain a news file.&#34;)
-    if not configuration.get_value(ConfigurationVariable.AUTOGENERATE_NEWS_FILE_ON_DEPENDENCY_UPDATE):
-        raise EnvironmentError(f&#34;Branch {current_branch} must contain a news file.&#34;)
-
-    create_news_file(
-        news_dir,
-        str(configuration.get_value(ConfigurationVariable.DEPENDENCY_UPDATE_NEWS_MESSAGE)).format(
-            message=&#34;, &#34;.join(groups)
-        ),
-        configuration.get_value(ConfigurationVariable.DEPENDENCY_UPDATE_NEWS_TYPE),
-    )</code></pre>
-</details>
-</dd>
 <dt id="continuous_delivery_scripts.assert_news.find_news_files"><code class="name flex">
 <span>def <span class="ident">find_news_files</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>, root_dir: str, news_dir: str) ‑> List[str]</span>
 </code></dt>
@@ -283,6 +244,49 @@ <h2 id="returns">Returns</h2>
     return [str(pathlib.Path(root_dir, file_path)) for file_path in added_news_files]</code></pre>
 </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>
+</code></dt>
+<dd>
+<div class="desc"><p>Adds a news file if the branch corresponds to an dependency update.</p>
+<h2 id="args">Args</h2>
+<dl>
+<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>
+</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:
+    &#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.
+    &#34;&#34;&#34;
+    current_branch = str(git.get_current_branch())
+    is_dependency_update, groups = git.is_current_branch_of_type(
+        str(configuration.get_value(ConfigurationVariable.DEPENDENCY_UPDATE_BRANCH_PATTERN))
+    )
+    if not is_dependency_update:
+        raise EnvironmentError(f&#34;Branch {current_branch} must contain a news file.&#34;)
+    if not configuration.get_value(ConfigurationVariable.AUTOGENERATE_NEWS_FILE_ON_DEPENDENCY_UPDATE):
+        raise EnvironmentError(f&#34;Branch {current_branch} must contain a news file.&#34;)
+
+    message = str(configuration.get_value(ConfigurationVariable.DEPENDENCY_UPDATE_NEWS_MESSAGE)).format(
+        message=&#34;, &#34;.join(groups)
+    )
+    logger.info(f&#34;Generating a news file with content: {message}...&#34;)
+    return create_news_file(
+        news_dir,
+        message,
+        configuration.get_value(ConfigurationVariable.DEPENDENCY_UPDATE_NEWS_TYPE),
+    )</code></pre>
+</details>
+</dd>
 <dt id="continuous_delivery_scripts.assert_news.main"><code class="name flex">
 <span>def <span class="ident">main</span></span>(<span>) ‑> NoneType</span>
 </code></dt>
@@ -315,11 +319,11 @@ <h2 id="returns">Returns</h2>
             except Exception as e:
                 log_exception(logger, e)
                 try:
-                    add_news_files(git, absolute_news_dir)
-                    _commit_news_file(git, absolute_news_dir)
+                    news_file = generate_news_file(git, absolute_news_dir)
+                    _commit_news_file(git, news_file)
                 except Exception as e2:
                     log_exception(logger, e2)
-                    sys.exit(1)</code></pre>
+                sys.exit(1)</code></pre>
 </details>
 </dd>
 <dt id="continuous_delivery_scripts.assert_news.validate_news_file"><code class="name flex">
@@ -496,8 +500,8 @@ <h1>Index</h1>
 </li>
 <li><h3><a href="#header-functions">Functions</a></h3>
 <ul class="">
-<li><code><a title="continuous_delivery_scripts.assert_news.add_news_files" href="#continuous_delivery_scripts.assert_news.add_news_files">add_news_files</a></code></li>
 <li><code><a title="continuous_delivery_scripts.assert_news.find_news_files" href="#continuous_delivery_scripts.assert_news.find_news_files">find_news_files</a></code></li>
+<li><code><a title="continuous_delivery_scripts.assert_news.generate_news_file" href="#continuous_delivery_scripts.assert_news.generate_news_file">generate_news_file</a></code></li>
 <li><code><a title="continuous_delivery_scripts.assert_news.main" href="#continuous_delivery_scripts.assert_news.main">main</a></code></li>
 <li><code><a title="continuous_delivery_scripts.assert_news.validate_news_file" href="#continuous_delivery_scripts.assert_news.validate_news_file">validate_news_file</a></code></li>
 <li><code><a title="continuous_delivery_scripts.assert_news.validate_news_files" href="#continuous_delivery_scripts.assert_news.validate_news_files">validate_news_files</a></code></li>

docs/third_party_IP_report.html

@@ -65,7 +65,7 @@
   </head>
   <body>
     <h1>Project's 3rd party IP report</h1>
-    <p><i>2021-08-10 18:00:23.670880</i></p>
+    <p><i>2021-08-11 00:51:11.878580</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-10 18:00:23.670880
+                                         2021-08-11 00:51:11.878580
 
 # Summary:
     Licence compliance: Compliant

docs/utils/news_file.html

@@ -38,9 +38,12 @@ <h1 class="title">Module <code>continuous_delivery_scripts.utils.news_file</code
 &#34;&#34;&#34;Helpers with regards to news files.&#34;&#34;&#34;
 import enum
 import pathlib
+import logging
 from datetime import datetime
 from typing import Any
 
+logger = logging.getLogger(__name__)
+
 
 class NewsType(enum.Enum):
     &#34;&#34;&#34;Describes the type of news we&#39;re writing.&#34;&#34;&#34;
@@ -77,6 +80,7 @@ <h1 class="title">Module <code>continuous_delivery_scripts.utils.news_file</code
 
 
 def _write_file(file_path: pathlib.Path, text: str) -&gt; None:
+    logger.info(f&#34;Writing news file: {file_path}&#34;)
     file_path.parent.mkdir(parents=True, exist_ok=True)
     if not text.endswith(&#34;\n&#34;):
         text = f&#34;{text}\n&#34;