🚀 releasing version 3.1.0 @ 2023-03-01 14:30

[skip ci]

Author: monty-bot

CHANGELOG.md

@@ -17,6 +17,30 @@ This project was forked from version 1.7.4 of [mbed-tools-ci-scripts](https://gi
 
 [//]: # (begin_release_notes)
 
+
+Features
+--------
+
+- :sparkles: Extended `create-news` so that the reference number can be specified (#20230301133846)
+
+
+Bugfixes
+--------
+
+- Dependency upgrade: mypy-1.0.0 (#20230207072240)
+- Dependency upgrade: mypy-1.0.1 (#20230220081601)
+- Dependency upgrade: coverage-7.2.0 (#20230223072638)
+- Dependency upgrade: setup-python-4 (#20230227080926)
+- :zap: Improved the performance of `assert news` for cases where news files are added to the current commit (#20230228103345)
+- Dependency upgrade: coverage-7.2.1 (#20230301081045)
+
+
+Misc
+----
+
+- #20230228130522
+
+
 "3.0.7" (2023-01-25)
 ====================
 

continuous_delivery_scripts/_version.py

@@ -10,8 +10,8 @@
 
 This file is autogenerated, do not modify by hand.
 """
-__version__ = "3.0.7"
-COMMIT = "76bfdb419b674ab645ddfbba05ac0ef061b50c0b"
+__version__ = "3.1.0"
+COMMIT = "e6a032c1434a9945d1d49843fc519d50a2e50283"
 MAJOR = 3
-MINOR = 0
-PATCH = 7
+MINOR = 1
+PATCH = 0

docs/assert_news.html

@@ -38,10 +38,10 @@ <h1 class="title">Module <code>continuous_delivery_scripts.assert_news</code></h
 &#34;&#34;&#34;Checks if valid news files are created for changes in the project.&#34;&#34;&#34;
 import argparse
 import logging
+import pathlib
 import re
 import sys
 from typing import List, Union
-import pathlib
 
 from continuous_delivery_scripts.utils.configuration import configuration, ConfigurationVariable
 from continuous_delivery_scripts.utils.git_helpers import ProjectTempClone, LocalProjectRepository, GitWrapper
@@ -104,10 +104,15 @@ <h1 class="title">Module <code>continuous_delivery_scripts.assert_news</code></h
     Returns:
         list: list of absolute paths to news files
     &#34;&#34;&#34;
-    files_changed = git.list_files_added_on_current_branch()
+    files_changed = git.list_files_added_to_current_commit()
+    # To speed up the process, we first look at files added to the current commit.
+    # If no news files were added, then we check for addition on the branch.
     # Relies on the fact GitWrapper returns paths that are always relative
     # to the project root.
     added_news_files = [file_path for file_path in files_changed if file_path.startswith(news_dir)]
+    if len(added_news_files) == 0:
+        files_changed = git.list_files_added_on_current_branch()
+        added_news_files = [file_path for file_path in files_changed if file_path.startswith(news_dir)]
     return [str(pathlib.Path(root_dir, file_path)) for file_path in added_news_files]
 
 
@@ -239,10 +244,15 @@ <h2 id="returns">Returns</h2>
     Returns:
         list: list of absolute paths to news files
     &#34;&#34;&#34;
-    files_changed = git.list_files_added_on_current_branch()
+    files_changed = git.list_files_added_to_current_commit()
+    # To speed up the process, we first look at files added to the current commit.
+    # If no news files were added, then we check for addition on the branch.
     # Relies on the fact GitWrapper returns paths that are always relative
     # to the project root.
     added_news_files = [file_path for file_path in files_changed if file_path.startswith(news_dir)]
+    if len(added_news_files) == 0:
+        files_changed = git.list_files_added_on_current_branch()
+        added_news_files = [file_path for file_path in files_changed if file_path.startswith(news_dir)]
     return [str(pathlib.Path(root_dir, file_path)) for file_path in added_news_files]</code></pre>
 </details>
 </dd>

docs/create_news_file.html

@@ -64,9 +64,10 @@ <h2 id="usage">Usage</h2>
     parser.add_argument(
         &#34;-t&#34;, &#34;--type&#34;, help=&#34;News type to create.&#34;, choices=[t.name for t in NewsType], default=&#34;feature&#34;
     )
+    parser.add_argument(&#34;-n&#34;, &#34;--ref-number&#34;, help=&#34;Reference number of the news file to use&#34;, required=False)
 
     args = parser.parse_args()
-    created_file = create_news_file(str(NEWS_DIR), args.news_text, NewsType[args.type])
+    created_file = create_news_file(str(NEWS_DIR), args.ref_number, args.news_text, NewsType[args.type])
 
     try:
         validate_news_file(created_file)
@@ -105,9 +106,10 @@ <h2 class="section-title" id="header-functions">Functions</h2>
     parser.add_argument(
         &#34;-t&#34;, &#34;--type&#34;, help=&#34;News type to create.&#34;, choices=[t.name for t in NewsType], default=&#34;feature&#34;
     )
+    parser.add_argument(&#34;-n&#34;, &#34;--ref-number&#34;, help=&#34;Reference number of the news file to use&#34;, required=False)
 
     args = parser.parse_args()
-    created_file = create_news_file(str(NEWS_DIR), args.news_text, NewsType[args.type])
+    created_file = create_news_file(str(NEWS_DIR), args.ref_number, args.news_text, NewsType[args.type])
 
     try:
         validate_news_file(created_file)

docs/third_party_IP_report.html

@@ -65,7 +65,7 @@
   </head>
   <body>
     <h1>Project's 3rd party IP report</h1>
-    <p><i>2023-01-25 19:09:05.851526</i></p>
+    <p><i>2023-03-01 14:30:50.921371</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
 
-                                         2023-01-25 19:09:05.851526
+                                         2023-03-01 14:30:50.921371
 
 # Summary:
     Licence compliance: Not compliant

docs/utils/git_helpers.html

@@ -40,11 +40,10 @@ <h1 class="title">Module <code>continuous_delivery_scripts.utils.git_helpers</co
 import os
 import re
 import shutil
-from pathlib import Path
-from typing import Optional, List, Union, Any, Tuple
-
 from git import Repo, Actor, GitCommandError
 from packaging import version
+from pathlib import Path
+from typing import Optional, List, Union, Any, Tuple
 
 from .configuration import configuration, ConfigurationVariable
 from .filesystem_helpers import TemporaryDirectory
@@ -434,7 +433,13 @@ <h1 class="title">Module <code>continuous_delivery_scripts.utils.git_helpers</co
         return self.get_remote_branch(branch_name) is not None
 
     def _get_specific_changes(self, change_type: Optional[str], commit1: Any, commit2: Any) -&gt; List[str]:
-        diff = commit1.diff(commit2)
+        diff = None
+        if commit1:
+            diff = commit1.diff(commit2) if commit2 else commit1.diff()
+        elif commit2:
+            diff = commit2.diff()
+        if not diff:
+            return []
         if change_type:
             change_type = change_type.upper()
             change_type = change_type if change_type in diff.change_type else None
@@ -580,6 +585,14 @@ <h1 class="title">Module <code>continuous_delivery_scripts.utils.git_helpers</co
             logger.warning(e)
             return None
 
+    def list_files_added_to_current_commit(self) -&gt; List[str]:
+        &#34;&#34;&#34;Returns a list of files added in the current commit.&#34;&#34;&#34;
+        current_commit = self.repo.head.commit
+        previous_commit = self.repo.commit(&#34;HEAD~1&#34;)
+        if not current_commit:
+            current_commit = self.get_current_commit()
+        return self.get_changes_list(previous_commit, current_commit, change_type=&#34;a&#34;)
+
     def list_files_added_on_current_branch(self) -&gt; List[str]:
         &#34;&#34;&#34;Returns a list of files changed against master branch.&#34;&#34;&#34;
         master_branch = self.get_master_branch()
@@ -598,8 +611,7 @@ <h1 class="title">Module <code>continuous_delivery_scripts.utils.git_helpers</co
                 # The branch point off `beta` is more recent than off `master`.
                 # Hence, the difference between current and `beta` should be considered.
                 branch_point = beta_branch_point
-        changes = self.get_changes_list(branch_point, current_branch_commit, change_type=&#34;a&#34;)
-        return changes
+        return self.get_changes_list(branch_point, current_branch_commit, change_type=&#34;a&#34;)
 
     def is_current_branch_feature(self) -&gt; bool:
         &#34;&#34;&#34;Returns boolean indicating if current branch is considered a feature.&#34;&#34;&#34;
@@ -1012,6 +1024,7 @@ <h3>Inherited members</h3>
 <li><code><a title="continuous_delivery_scripts.utils.git_helpers.GitWrapper.is_release_branch" href="#continuous_delivery_scripts.utils.git_helpers.GitWrapper.is_release_branch">is_release_branch</a></code></li>
 <li><code><a title="continuous_delivery_scripts.utils.git_helpers.GitWrapper.list_branches" href="#continuous_delivery_scripts.utils.git_helpers.GitWrapper.list_branches">list_branches</a></code></li>
 <li><code><a title="continuous_delivery_scripts.utils.git_helpers.GitWrapper.list_files_added_on_current_branch" href="#continuous_delivery_scripts.utils.git_helpers.GitWrapper.list_files_added_on_current_branch">list_files_added_on_current_branch</a></code></li>
+<li><code><a title="continuous_delivery_scripts.utils.git_helpers.GitWrapper.list_files_added_to_current_commit" href="#continuous_delivery_scripts.utils.git_helpers.GitWrapper.list_files_added_to_current_commit">list_files_added_to_current_commit</a></code></li>
 <li><code><a title="continuous_delivery_scripts.utils.git_helpers.GitWrapper.merge" href="#continuous_delivery_scripts.utils.git_helpers.GitWrapper.merge">merge</a></code></li>
 <li><code><a title="continuous_delivery_scripts.utils.git_helpers.GitWrapper.pull" href="#continuous_delivery_scripts.utils.git_helpers.GitWrapper.pull">pull</a></code></li>
 <li><code><a title="continuous_delivery_scripts.utils.git_helpers.GitWrapper.pull_all" href="#continuous_delivery_scripts.utils.git_helpers.GitWrapper.pull_all">pull_all</a></code></li>
@@ -1484,7 +1497,13 @@ <h2 id="args">Args</h2>
         return self.get_remote_branch(branch_name) is not None
 
     def _get_specific_changes(self, change_type: Optional[str], commit1: Any, commit2: Any) -&gt; List[str]:
-        diff = commit1.diff(commit2)
+        diff = None
+        if commit1:
+            diff = commit1.diff(commit2) if commit2 else commit1.diff()
+        elif commit2:
+            diff = commit2.diff()
+        if not diff:
+            return []
         if change_type:
             change_type = change_type.upper()
             change_type = change_type if change_type in diff.change_type else None
@@ -1630,6 +1649,14 @@ <h2 id="args">Args</h2>
             logger.warning(e)
             return None
 
+    def list_files_added_to_current_commit(self) -&gt; List[str]:
+        &#34;&#34;&#34;Returns a list of files added in the current commit.&#34;&#34;&#34;
+        current_commit = self.repo.head.commit
+        previous_commit = self.repo.commit(&#34;HEAD~1&#34;)
+        if not current_commit:
+            current_commit = self.get_current_commit()
+        return self.get_changes_list(previous_commit, current_commit, change_type=&#34;a&#34;)
+
     def list_files_added_on_current_branch(self) -&gt; List[str]:
         &#34;&#34;&#34;Returns a list of files changed against master branch.&#34;&#34;&#34;
         master_branch = self.get_master_branch()
@@ -1648,8 +1675,7 @@ <h2 id="args">Args</h2>
                 # The branch point off `beta` is more recent than off `master`.
                 # Hence, the difference between current and `beta` should be considered.
                 branch_point = beta_branch_point
-        changes = self.get_changes_list(branch_point, current_branch_commit, change_type=&#34;a&#34;)
-        return changes
+        return self.get_changes_list(branch_point, current_branch_commit, change_type=&#34;a&#34;)
 
     def is_current_branch_feature(self) -&gt; bool:
         &#34;&#34;&#34;Returns boolean indicating if current branch is considered a feature.&#34;&#34;&#34;
@@ -2760,8 +2786,25 @@ <h2 id="returns">Returns</h2>
             # The branch point off `beta` is more recent than off `master`.
             # Hence, the difference between current and `beta` should be considered.
             branch_point = beta_branch_point
-    changes = self.get_changes_list(branch_point, current_branch_commit, change_type=&#34;a&#34;)
-    return changes</code></pre>
+    return self.get_changes_list(branch_point, current_branch_commit, change_type=&#34;a&#34;)</code></pre>
+</details>
+</dd>
+<dt id="continuous_delivery_scripts.utils.git_helpers.GitWrapper.list_files_added_to_current_commit"><code class="name flex">
+<span>def <span class="ident">list_files_added_to_current_commit</span></span>(<span>self) ‑> List[str]</span>
+</code></dt>
+<dd>
+<div class="desc"><p>Returns a list of files added in the current commit.</p></div>
+<details class="source">
+<summary>
+<span>Expand source code</span>
+</summary>
+<pre><code class="python">def list_files_added_to_current_commit(self) -&gt; List[str]:
+    &#34;&#34;&#34;Returns a list of files added in the current commit.&#34;&#34;&#34;
+    current_commit = self.repo.head.commit
+    previous_commit = self.repo.commit(&#34;HEAD~1&#34;)
+    if not current_commit:
+        current_commit = self.get_current_commit()
+    return self.get_changes_list(previous_commit, current_commit, change_type=&#34;a&#34;)</code></pre>
 </details>
 </dd>
 <dt id="continuous_delivery_scripts.utils.git_helpers.GitWrapper.merge"><code class="name flex">
@@ -3049,6 +3092,7 @@ <h3>Inherited members</h3>
 <li><code><a title="continuous_delivery_scripts.utils.git_helpers.GitWrapper.is_release_branch" href="#continuous_delivery_scripts.utils.git_helpers.GitWrapper.is_release_branch">is_release_branch</a></code></li>
 <li><code><a title="continuous_delivery_scripts.utils.git_helpers.GitWrapper.list_branches" href="#continuous_delivery_scripts.utils.git_helpers.GitWrapper.list_branches">list_branches</a></code></li>
 <li><code><a title="continuous_delivery_scripts.utils.git_helpers.GitWrapper.list_files_added_on_current_branch" href="#continuous_delivery_scripts.utils.git_helpers.GitWrapper.list_files_added_on_current_branch">list_files_added_on_current_branch</a></code></li>
+<li><code><a title="continuous_delivery_scripts.utils.git_helpers.GitWrapper.list_files_added_to_current_commit" href="#continuous_delivery_scripts.utils.git_helpers.GitWrapper.list_files_added_to_current_commit">list_files_added_to_current_commit</a></code></li>
 <li><code><a title="continuous_delivery_scripts.utils.git_helpers.GitWrapper.merge" href="#continuous_delivery_scripts.utils.git_helpers.GitWrapper.merge">merge</a></code></li>
 <li><code><a title="continuous_delivery_scripts.utils.git_helpers.GitWrapper.pull" href="#continuous_delivery_scripts.utils.git_helpers.GitWrapper.pull">pull</a></code></li>
 <li><code><a title="continuous_delivery_scripts.utils.git_helpers.GitWrapper.pull_all" href="#continuous_delivery_scripts.utils.git_helpers.GitWrapper.pull_all">pull_all</a></code></li>
@@ -3168,6 +3212,7 @@ <h4><code><a title="continuous_delivery_scripts.utils.git_helpers.GitWrapper" hr
 <li><code><a title="continuous_delivery_scripts.utils.git_helpers.GitWrapper.is_release_branch" href="#continuous_delivery_scripts.utils.git_helpers.GitWrapper.is_release_branch">is_release_branch</a></code></li>
 <li><code><a title="continuous_delivery_scripts.utils.git_helpers.GitWrapper.list_branches" href="#continuous_delivery_scripts.utils.git_helpers.GitWrapper.list_branches">list_branches</a></code></li>
 <li><code><a title="continuous_delivery_scripts.utils.git_helpers.GitWrapper.list_files_added_on_current_branch" href="#continuous_delivery_scripts.utils.git_helpers.GitWrapper.list_files_added_on_current_branch">list_files_added_on_current_branch</a></code></li>
+<li><code><a title="continuous_delivery_scripts.utils.git_helpers.GitWrapper.list_files_added_to_current_commit" href="#continuous_delivery_scripts.utils.git_helpers.GitWrapper.list_files_added_to_current_commit">list_files_added_to_current_commit</a></code></li>
 <li><code><a title="continuous_delivery_scripts.utils.git_helpers.GitWrapper.merge" href="#continuous_delivery_scripts.utils.git_helpers.GitWrapper.merge">merge</a></code></li>
 <li><code><a title="continuous_delivery_scripts.utils.git_helpers.GitWrapper.pull" href="#continuous_delivery_scripts.utils.git_helpers.GitWrapper.pull">pull</a></code></li>
 <li><code><a title="continuous_delivery_scripts.utils.git_helpers.GitWrapper.pull_all" href="#continuous_delivery_scripts.utils.git_helpers.GitWrapper.pull_all">pull_all</a></code></li>