Skip to content

Commit 2afa72a

Browse files
committed
🚀 releasing version 2.9.0 @ 2022-12-01 19:01
[skip ci]
1 parent 7ae26f6 commit 2afa72a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

65 files changed

+714
-261
lines changed

CHANGELOG.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,39 @@ This project was forked from version 1.7.4 of [mbed-tools-ci-scripts](https://gi
1717

1818
[//]: # (begin_release_notes)
1919

20+
"2.9.0" (2022-12-01)
21+
====================
22+
23+
Features
24+
--------
25+
26+
- :sparkles: New plugin for CI projects (#202212011749)
27+
28+
29+
Bugfixes
30+
--------
31+
32+
- Dependency upgrade: pdoc3-0.10.0 (#202108110629)
33+
- Dependency upgrade: mypy-0.921 (#202112220825)
34+
- Dependency upgrade: towncrier-22.8.0 (#202208310626)
35+
- fix how manually checked licences are expressed in the project configuration files to accommodate `.` in package names (#202211301646)
36+
- Dependency upgrade: codeql-action-2 (#202211301827)
37+
- Dependency upgrade: fetch-metadata-1.3.5 (#202211301829)
38+
- Dependency upgrade: cache-3 (#202211301830)
39+
- Dependency upgrade: codecov-action-3 (#202211301832)
40+
- Dependency upgrade: upload-artifact-3 (#202211301833)
41+
- Dependency upgrade: checkout-3 (#202211301834)
42+
- Dependency upgrade: mypy-0.991 (#202211301940)
43+
- Dependency upgrade: dependency-review-action-3 (#202212010715)
44+
- :bug: Change the news file name to avoid conflicts (#20221201175408059814)
45+
46+
47+
Misc
48+
----
49+
50+
- #202211301645, #202212011822
51+
52+
2053
"2.8.5" (2022-03-22)
2154
====================
2255

continuous_delivery_scripts/_version.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@
1010
1111
This file is autogenerated, do not modify by hand.
1212
"""
13-
__version__ = "2.8.5"
14-
COMMIT = "06395d19ed1f76c3330c3c5f46fe2b8ce08194ef"
13+
__version__ = "2.9.0"
14+
COMMIT = "7ae26f64f56fe76130db3281a0ce3abdfb49e857"
1515
MAJOR = 2
16-
MINOR = 8
17-
PATCH = 5
16+
MINOR = 9
17+
PATCH = 0

docs/assert_news.html

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<head>
88
<meta charset="utf-8">
99
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
10-
<meta name="generator" content="pdoc 0.9.1" />
10+
<meta name="generator" content="pdoc 0.10.0" />
1111
<title>continuous_delivery_scripts.assert_news API documentation</title>
1212
<meta name="description" content="Checks if valid news files are created for changes in the project." />
1313
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
@@ -290,7 +290,7 @@ <h2 id="args">Args</h2>
290290
</details>
291291
</dd>
292292
<dt id="continuous_delivery_scripts.assert_news.main"><code class="name flex">
293-
<span>def <span class="ident">main</span></span>(<span>) ‑> NoneType</span>
293+
<span>def <span class="ident">main</span></span>(<span>) ‑> None</span>
294294
</code></dt>
295295
<dd>
296296
<div class="desc"><p>Asserts the new PR comprises at least one news file and it adheres to the required standard.</p></div>
@@ -329,7 +329,7 @@ <h2 id="args">Args</h2>
329329
</details>
330330
</dd>
331331
<dt id="continuous_delivery_scripts.assert_news.validate_news_file"><code class="name flex">
332-
<span>def <span class="ident">validate_news_file</span></span>(<span>absolute_path: Union[pathlib.Path, str]) ‑> NoneType</span>
332+
<span>def <span class="ident">validate_news_file</span></span>(<span>absolute_path: Union[pathlib.Path, str]) ‑> None</span>
333333
</code></dt>
334334
<dd>
335335
<div class="desc"><p>Applies NewsFileValidator validation logic to news file.</p></div>
@@ -343,7 +343,7 @@ <h2 id="args">Args</h2>
343343
</details>
344344
</dd>
345345
<dt id="continuous_delivery_scripts.assert_news.validate_news_files"><code class="name flex">
346-
<span>def <span class="ident">validate_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) ‑> NoneType</span>
346+
<span>def <span class="ident">validate_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) ‑> None</span>
347347
</code></dt>
348348
<dd>
349349
<div class="desc"><p>Checks that news files exist and pass validation checks.</p>
@@ -433,7 +433,7 @@ <h2 id="args">Args</h2>
433433
<h3>Methods</h3>
434434
<dl>
435435
<dt id="continuous_delivery_scripts.assert_news.NewsFileValidator.validate"><code class="name flex">
436-
<span>def <span class="ident">validate</span></span>(<span>self) ‑> NoneType</span>
436+
<span>def <span class="ident">validate</span></span>(<span>self) ‑> None</span>
437437
</code></dt>
438438
<dd>
439439
<div class="desc"><p>Runs all validators.</p></div>
@@ -449,7 +449,7 @@ <h3>Methods</h3>
449449
</details>
450450
</dd>
451451
<dt id="continuous_delivery_scripts.assert_news.NewsFileValidator.validate_file_contents"><code class="name flex">
452-
<span>def <span class="ident">validate_file_contents</span></span>(<span>self) ‑> NoneType</span>
452+
<span>def <span class="ident">validate_file_contents</span></span>(<span>self) ‑> None</span>
453453
</code></dt>
454454
<dd>
455455
<div class="desc"><p>Ensures the news file is not empty and not longer than one line.</p></div>
@@ -467,7 +467,7 @@ <h3>Methods</h3>
467467
</details>
468468
</dd>
469469
<dt id="continuous_delivery_scripts.assert_news.NewsFileValidator.validate_file_name"><code class="name flex">
470-
<span>def <span class="ident">validate_file_name</span></span>(<span>self) ‑> NoneType</span>
470+
<span>def <span class="ident">validate_file_name</span></span>(<span>self) ‑> None</span>
471471
</code></dt>
472472
<dd>
473473
<div class="desc"><p>Ensures the news file follows the naming rules.</p></div>
@@ -525,7 +525,7 @@ <h4><code><a title="continuous_delivery_scripts.assert_news.NewsFileValidator" h
525525
</nav>
526526
</main>
527527
<footer id="footer">
528-
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.1</a>.</p>
528+
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
529529
</footer>
530530
</body>
531531
</html>

docs/create_news_file.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<head>
88
<meta charset="utf-8">
99
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
10-
<meta name="generator" content="pdoc 0.9.1" />
10+
<meta name="generator" content="pdoc 0.10.0" />
1111
<title>continuous_delivery_scripts.create_news_file API documentation</title>
1212
<meta name="description" content="Easy news files generation …" />
1313
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
@@ -144,7 +144,7 @@ <h1>Index</h1>
144144
</nav>
145145
</main>
146146
<footer id="footer">
147-
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.1</a>.</p>
147+
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
148148
</footer>
149149
</body>
150150
</html>

docs/generate_docs.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<head>
88
<meta charset="utf-8">
99
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
10-
<meta name="generator" content="pdoc 0.9.1" />
10+
<meta name="generator" content="pdoc 0.10.0" />
1111
<title>continuous_delivery_scripts.generate_docs API documentation</title>
1212
<meta name="description" content="Generates documentation." />
1313
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
@@ -118,7 +118,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
118118
</details>
119119
</dd>
120120
<dt id="continuous_delivery_scripts.generate_docs.generate_documentation"><code class="name flex">
121-
<span>def <span class="ident">generate_documentation</span></span>(<span>output_directory: pathlib.Path, module_to_document: str) ‑> NoneType</span>
121+
<span>def <span class="ident">generate_documentation</span></span>(<span>output_directory: pathlib.Path, module_to_document: str) ‑> None</span>
122122
</code></dt>
123123
<dd>
124124
<div class="desc"><p>Generates the documentation.</p></div>
@@ -134,7 +134,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
134134
</details>
135135
</dd>
136136
<dt id="continuous_delivery_scripts.generate_docs.main"><code class="name flex">
137-
<span>def <span class="ident">main</span></span>(<span>) ‑> NoneType</span>
137+
<span>def <span class="ident">main</span></span>(<span>) ‑> None</span>
138138
</code></dt>
139139
<dd>
140140
<div class="desc"><p>Parses command line arguments and generates docs.</p></div>
@@ -183,7 +183,7 @@ <h1>Index</h1>
183183
</nav>
184184
</main>
185185
<footer id="footer">
186-
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.1</a>.</p>
186+
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
187187
</footer>
188188
</body>
189189
</html>

docs/generate_news.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<head>
88
<meta charset="utf-8">
99
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
10-
<meta name="generator" content="pdoc 0.9.1" />
10+
<meta name="generator" content="pdoc 0.10.0" />
1111
<title>continuous_delivery_scripts.generate_news API documentation</title>
1212
<meta name="description" content="Handles usage of towncrier for automated changelog generation and pyautoversion for versioning." />
1313
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
@@ -117,7 +117,7 @@ <h1 class="title">Module <code>continuous_delivery_scripts.generate_news</code><
117117
<h2 class="section-title" id="header-functions">Functions</h2>
118118
<dl>
119119
<dt id="continuous_delivery_scripts.generate_news.main"><code class="name flex">
120-
<span>def <span class="ident">main</span></span>(<span>) ‑> NoneType</span>
120+
<span>def <span class="ident">main</span></span>(<span>) ‑> None</span>
121121
</code></dt>
122122
<dd>
123123
<div class="desc"><p>Handle command line arguments to generate a version and changelog file.</p></div>
@@ -203,7 +203,7 @@ <h1>Index</h1>
203203
</nav>
204204
</main>
205205
<footer id="footer">
206-
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.1</a>.</p>
206+
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
207207
</footer>
208208
</body>
209209
</html>

docs/get_config.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<head>
88
<meta charset="utf-8">
99
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
10-
<meta name="generator" content="pdoc 0.9.1" />
10+
<meta name="generator" content="pdoc 0.10.0" />
1111
<title>continuous_delivery_scripts.get_config API documentation</title>
1212
<meta name="description" content="Retrieves configuration values." />
1313
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
@@ -74,7 +74,7 @@ <h1 class="title">Module <code>continuous_delivery_scripts.get_config</code></h1
7474
<h2 class="section-title" id="header-functions">Functions</h2>
7575
<dl>
7676
<dt id="continuous_delivery_scripts.get_config.main"><code class="name flex">
77-
<span>def <span class="ident">main</span></span>(<span>) ‑> NoneType</span>
77+
<span>def <span class="ident">main</span></span>(<span>) ‑> None</span>
7878
</code></dt>
7979
<dd>
8080
<div class="desc"><p>Parses command line arguments and retrieves project configuration values.</p></div>
@@ -124,7 +124,7 @@ <h1>Index</h1>
124124
</nav>
125125
</main>
126126
<footer id="footer">
127-
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.1</a>.</p>
127+
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
128128
</footer>
129129
</body>
130130
</html>

docs/get_version.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<head>
88
<meta charset="utf-8">
99
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
10-
<meta name="generator" content="pdoc 0.9.1" />
10+
<meta name="generator" content="pdoc 0.10.0" />
1111
<title>continuous_delivery_scripts.get_version API documentation</title>
1212
<meta name="description" content="Determine the project new version." />
1313
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
@@ -127,7 +127,7 @@ <h2 id="returns">Returns</h2>
127127
</details>
128128
</dd>
129129
<dt id="continuous_delivery_scripts.get_version.main"><code class="name flex">
130-
<span>def <span class="ident">main</span></span>(<span>) ‑> NoneType</span>
130+
<span>def <span class="ident">main</span></span>(<span>) ‑> None</span>
131131
</code></dt>
132132
<dd>
133133
<div class="desc"><p>Handle command line arguments to determine version string.</p></div>
@@ -180,7 +180,7 @@ <h1>Index</h1>
180180
</nav>
181181
</main>
182182
<footer id="footer">
183-
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.1</a>.</p>
183+
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
184184
</footer>
185185
</body>
186186
</html>

docs/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<head>
88
<meta charset="utf-8">
99
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
10-
<meta name="generator" content="pdoc 0.9.1" />
10+
<meta name="generator" content="pdoc 0.10.0" />
1111
<title>continuous_delivery_scripts API documentation</title>
1212
<meta name="description" content="Scripts and utilities used by the CI pipeline." />
1313
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
@@ -130,7 +130,7 @@ <h1>Index</h1>
130130
</nav>
131131
</main>
132132
<footer id="footer">
133-
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.1</a>.</p>
133+
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
134134
</footer>
135135
</body>
136136
</html>

docs/language_specifics.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<head>
88
<meta charset="utf-8">
99
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
10-
<meta name="generator" content="pdoc 0.9.1" />
10+
<meta name="generator" content="pdoc 0.10.0" />
1111
<title>continuous_delivery_scripts.language_specifics API documentation</title>
1212
<meta name="description" content="Language plugins Loader." />
1313
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
@@ -191,7 +191,7 @@ <h4><code><a title="continuous_delivery_scripts.language_specifics.PluginLoader"
191191
</nav>
192192
</main>
193193
<footer id="footer">
194-
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.1</a>.</p>
194+
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
195195
</footer>
196196
</body>
197197
</html>

0 commit comments

Comments
 (0)