Skip to content

Commit b89d99c

Browse files
monty-botmonty-bot
committed
🚀 releasing version 1.7.0 @ 2020-04-24 16:02
[skip ci]
1 parent 0935356 commit b89d99c

39 files changed

+4256
-713
lines changed

‎CHANGELOG.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,24 @@ beta releases are not included in this history. For a full list of all releases,
1111

1212
[//]: # (begin_release_notes)
1313

14+
"1.7.0" (2020-04-24)
15+
====================
16+
17+
Features
18+
--------
19+
20+
- Added a licence compliance check for the package and its dependencies. (#20200415)
21+
- Generates a licensing summary. (#20200420)
22+
- Add licensing summary to docs. (#20200423)
23+
- Changed the configuration type entry for package licence compliance check. (#20200424)
24+
25+
26+
Misc
27+
----
28+
29+
- #20200416
30+
31+
1432
"1.6.2" (2020-04-07)
1533
====================
1634

‎docs/assert_news.html‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@
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.7.5" />
10+
<meta name="generator" content="pdoc 0.8.1" />
1111
<title>mbed_tools_ci_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 href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
1414
<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
1515
<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
16-
<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
17-
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
16+
<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
17+
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
1818
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
1919
</head>
2020
<body>
@@ -168,7 +168,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
168168
<span>def <span class="ident">find_news_files</span></span>(<span>git: <a title="mbed_tools_ci_scripts.utils.git_helpers.GitWrapper" href="utils/git_helpers.html#mbed_tools_ci_scripts.utils.git_helpers.GitWrapper">GitWrapper</a>, root_dir: str, news_dir: str) -> List[str]</span>
169169
</code></dt>
170170
<dd>
171-
<section class="desc"><p>Determines a list of all the news files which were added as part of the PR.</p>
171+
<div class="desc"><p>Determines a list of all the news files which were added as part of the PR.</p>
172172
<h2 id="args">Args</h2>
173173
<dl>
174174
<dt><strong><code>git</code></strong></dt>
@@ -180,9 +180,9 @@ <h2 id="args">Args</h2>
180180
</dl>
181181
<h2 id="returns">Returns</h2>
182182
<dl>
183-
<dt><strong><code>list</code></strong></dt>
183+
<dt><code>list</code></dt>
184184
<dd>list of absolute paths to news files</dd>
185-
</dl></section>
185+
</dl></div>
186186
<details class="source">
187187
<summary>
188188
<span>Expand source code</span>
@@ -209,7 +209,7 @@ <h2 id="returns">Returns</h2>
209209
<span>def <span class="ident">main</span></span>(<span>) -> NoneType</span>
210210
</code></dt>
211211
<dd>
212-
<section class="desc"><p>Asserts the new PR comprises at least one news file and it adheres to the required standard.</p></section>
212+
<div class="desc"><p>Asserts the new PR comprises at least one news file and it adheres to the required standard.</p></div>
213213
<details class="source">
214214
<summary>
215215
<span>Expand source code</span>
@@ -248,7 +248,7 @@ <h2 id="returns">Returns</h2>
248248
<span>def <span class="ident">validate_news_file</span></span>(<span>absolute_path: Union[pathlib.Path, str]) -> NoneType</span>
249249
</code></dt>
250250
<dd>
251-
<section class="desc"><p>Applies NewsFileValidator validation logic to news file.</p></section>
251+
<div class="desc"><p>Applies NewsFileValidator validation logic to news file.</p></div>
252252
<details class="source">
253253
<summary>
254254
<span>Expand source code</span>
@@ -262,7 +262,7 @@ <h2 id="returns">Returns</h2>
262262
<span>def <span class="ident">validate_news_files</span></span>(<span>git: <a title="mbed_tools_ci_scripts.utils.git_helpers.GitWrapper" href="utils/git_helpers.html#mbed_tools_ci_scripts.utils.git_helpers.GitWrapper">GitWrapper</a>, root_dir: str, news_dir: str) -> NoneType</span>
263263
</code></dt>
264264
<dd>
265-
<section class="desc"><p>Checks that news files exist and pass validation checks.</p>
265+
<div class="desc"><p>Checks that news files exist and pass validation checks.</p>
266266
<h2 id="args">Args</h2>
267267
<dl>
268268
<dt><strong><code>git</code></strong></dt>
@@ -271,7 +271,7 @@ <h2 id="args">Args</h2>
271271
<dd>Root directory of the project.</dd>
272272
<dt><strong><code>news_dir</code></strong></dt>
273273
<dd>Relative path to news directory.</dd>
274-
</dl></section>
274+
</dl></div>
275275
<details class="source">
276276
<summary>
277277
<span>Expand source code</span>
@@ -301,13 +301,13 @@ <h2 class="section-title" id="header-classes">Classes</h2>
301301
<span>(</span><span>absolute_path: Union[pathlib.Path, str])</span>
302302
</code></dt>
303303
<dd>
304-
<section class="desc"><p>Verifies individual news files.</p>
304+
<div class="desc"><p>Verifies individual news files.</p>
305305
<p>Creates a new instance of NewsFileValidator.</p>
306306
<h2 id="args">Args</h2>
307307
<dl>
308308
<dt><strong><code>absolute_path</code></strong></dt>
309309
<dd>the absolute path to the news file</dd>
310-
</dl></section>
310+
</dl></div>
311311
<details class="source">
312312
<summary>
313313
<span>Expand source code</span>
@@ -352,7 +352,7 @@ <h3>Methods</h3>
352352
<span>def <span class="ident">validate</span></span>(<span>self) -> NoneType</span>
353353
</code></dt>
354354
<dd>
355-
<section class="desc"><p>Runs all validators.</p></section>
355+
<div class="desc"><p>Runs all validators.</p></div>
356356
<details class="source">
357357
<summary>
358358
<span>Expand source code</span>
@@ -368,7 +368,7 @@ <h3>Methods</h3>
368368
<span>def <span class="ident">validate_file_contents</span></span>(<span>self) -> NoneType</span>
369369
</code></dt>
370370
<dd>
371-
<section class="desc"><p>Ensures the news file is not empty and not longer than one line.</p></section>
371+
<div class="desc"><p>Ensures the news file is not empty and not longer than one line.</p></div>
372372
<details class="source">
373373
<summary>
374374
<span>Expand source code</span>
@@ -386,7 +386,7 @@ <h3>Methods</h3>
386386
<span>def <span class="ident">validate_file_name</span></span>(<span>self) -> NoneType</span>
387387
</code></dt>
388388
<dd>
389-
<section class="desc"><p>Ensures the news file follows the naming rules.</p></section>
389+
<div class="desc"><p>Ensures the news file follows the naming rules.</p></div>
390390
<details class="source">
391391
<summary>
392392
<span>Expand source code</span>
@@ -440,7 +440,7 @@ <h4><code><a title="mbed_tools_ci_scripts.assert_news.NewsFileValidator" href="#
440440
</nav>
441441
</main>
442442
<footer id="footer">
443-
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.5</a>.</p>
443+
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.8.1</a>.</p>
444444
</footer>
445445
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
446446
<script>hljs.initHighlightingOnLoad()</script>

0 commit comments

Comments
 (0)