Skip to content

Commit 1327657

Browse files
monty-botmonty-bot
committed
🚀 releasing version 1.7.4 @ 2020-07-08 17:04
[skip ci]
1 parent f0d47b0 commit 1327657

37 files changed

+476
-551
lines changed

‎CHANGELOG.md‎

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

1212
[//]: # (begin_release_notes)
1313

14+
"1.7.4" (2020-07-08)
15+
====================
16+
17+
Bugfixes
18+
--------
19+
20+
- Add newline to news file created with create-news-file (#20200707)
21+
- Remove from pre-commit checks (#2020070701)
22+
- add timestamp to news file name (#20200707185215)
23+
24+
1425
"1.7.3" (2020-06-18)
1526
====================
1627

‎docs/assert_news.html‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,17 @@
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.8.1" />
10+
<meta name="generator" content="pdoc 0.8.3" />
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." />
13-
<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
14-
<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
15-
<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}#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>
13+
<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>
14+
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
15+
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.1/styles/github.min.css" crossorigin>
16+
<style>:root{--highlight-color:#fe9}.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%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}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}dt:target .name{background:var(--highlight-color)}.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%}td{padding:0 .5em}.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>
1717
<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>
19+
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.1/highlight.min.js" integrity="sha256-eOgo0OtLL4cdq7RdwRUiGKLX9XsIJ7nGhWEKbohmVAQ=" crossorigin></script>
20+
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
1921
</head>
2022
<body>
2123
<main>
@@ -164,7 +166,7 @@ <h1 class="title">Module <code>mbed_tools_ci_scripts.assert_news</code></h1>
164166
<h2 class="section-title" id="header-functions">Functions</h2>
165167
<dl>
166168
<dt id="mbed_tools_ci_scripts.assert_news.find_news_files"><code class="name flex">
167-
<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>
169+
<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>
168170
</code></dt>
169171
<dd>
170172
<div class="desc"><p>Determines a list of all the news files which were added as part of the PR.</p>
@@ -205,7 +207,7 @@ <h2 id="returns">Returns</h2>
205207
</details>
206208
</dd>
207209
<dt id="mbed_tools_ci_scripts.assert_news.main"><code class="name flex">
208-
<span>def <span class="ident">main</span></span>(<span>) -> NoneType</span>
210+
<span>def <span class="ident">main</span></span>(<span>) ‑> NoneType</span>
209211
</code></dt>
210212
<dd>
211213
<div class="desc"><p>Asserts the new PR comprises at least one news file and it adheres to the required standard.</p></div>
@@ -243,7 +245,7 @@ <h2 id="returns">Returns</h2>
243245
</details>
244246
</dd>
245247
<dt id="mbed_tools_ci_scripts.assert_news.validate_news_file"><code class="name flex">
246-
<span>def <span class="ident">validate_news_file</span></span>(<span>absolute_path: Union[pathlib.Path, str]) -> NoneType</span>
248+
<span>def <span class="ident">validate_news_file</span></span>(<span>absolute_path: Union[pathlib.Path, str]) ‑> NoneType</span>
247249
</code></dt>
248250
<dd>
249251
<div class="desc"><p>Applies NewsFileValidator validation logic to news file.</p></div>
@@ -257,7 +259,7 @@ <h2 id="returns">Returns</h2>
257259
</details>
258260
</dd>
259261
<dt id="mbed_tools_ci_scripts.assert_news.validate_news_files"><code class="name flex">
260-
<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>
262+
<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>
261263
</code></dt>
262264
<dd>
263265
<div class="desc"><p>Checks that news files exist and pass validation checks.</p>
@@ -347,7 +349,7 @@ <h2 id="args">Args</h2>
347349
<h3>Methods</h3>
348350
<dl>
349351
<dt id="mbed_tools_ci_scripts.assert_news.NewsFileValidator.validate"><code class="name flex">
350-
<span>def <span class="ident">validate</span></span>(<span>self) -> NoneType</span>
352+
<span>def <span class="ident">validate</span></span>(<span>self) ‑> NoneType</span>
351353
</code></dt>
352354
<dd>
353355
<div class="desc"><p>Runs all validators.</p></div>
@@ -363,7 +365,7 @@ <h3>Methods</h3>
363365
</details>
364366
</dd>
365367
<dt id="mbed_tools_ci_scripts.assert_news.NewsFileValidator.validate_file_contents"><code class="name flex">
366-
<span>def <span class="ident">validate_file_contents</span></span>(<span>self) -> NoneType</span>
368+
<span>def <span class="ident">validate_file_contents</span></span>(<span>self) ‑> NoneType</span>
367369
</code></dt>
368370
<dd>
369371
<div class="desc"><p>Ensures the news file is not empty and not longer than one line.</p></div>
@@ -381,7 +383,7 @@ <h3>Methods</h3>
381383
</details>
382384
</dd>
383385
<dt id="mbed_tools_ci_scripts.assert_news.NewsFileValidator.validate_file_name"><code class="name flex">
384-
<span>def <span class="ident">validate_file_name</span></span>(<span>self) -> NoneType</span>
386+
<span>def <span class="ident">validate_file_name</span></span>(<span>self) ‑> NoneType</span>
385387
</code></dt>
386388
<dd>
387389
<div class="desc"><p>Ensures the news file follows the naming rules.</p></div>
@@ -438,9 +440,7 @@ <h4><code><a title="mbed_tools_ci_scripts.assert_news.NewsFileValidator" href="#
438440
</nav>
439441
</main>
440442
<footer id="footer">
441-
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.8.1</a>.</p>
443+
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.8.3</a>.</p>
442444
</footer>
443-
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
444-
<script>hljs.initHighlightingOnLoad()</script>
445445
</body>
446446
</html>

0 commit comments

Comments
 (0)