Skip to content

Commit f261d33

Browse files
monty-botmonty-bot
committed
🚀 releasing version 1.0.0 @ 2020-11-26 15:13
[skip ci]
1 parent 935f54f commit f261d33

34 files changed

+1311
-1097
lines changed

‎CHANGELOG.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,11 @@ beta releases are not included in this history. For a full list of all releases,
1212
This project was forked from version 1.7.4 of [mbed-tools-ci-scripts](https://github.com/ARMmbed/mbed-tools-ci-scripts)
1313

1414
[//]: # (begin_release_notes)
15+
16+
"1.0.0" (2020-11-26)
17+
====================
18+
19+
Major changes
20+
-------------
21+
22+
- Initial Release (#1)

‎docs/assert_news.html‎

Lines changed: 34 additions & 42 deletions
Large diffs are not rendered by default.

‎docs/create_news_file.html‎

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -7,23 +7,23 @@
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.3" />
11-
<title>mbed_tools_ci_scripts.create_news_file API documentation</title>
10+
<meta name="generator" content="pdoc 0.9.1" />
11+
<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>
1414
<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>
15+
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
1616
<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>
19+
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
2020
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
2121
</head>
2222
<body>
2323
<main>
2424
<article id="content">
2525
<header>
26-
<h1 class="title">Module <code>mbed_tools_ci_scripts.create_news_file</code></h1>
26+
<h1 class="title">Module <code>continuous_delivery_scripts.create_news_file</code></h1>
2727
</header>
2828
<section id="section-intro">
2929
<p>Easy news files generation.</p>
@@ -49,9 +49,9 @@ <h2 id="usage">Usage</h2>
4949
import sys
5050
from datetime import datetime
5151

52-
from mbed_tools_ci_scripts.utils.configuration import configuration, ConfigurationVariable
53-
from mbed_tools_ci_scripts.assert_news import validate_news_file
54-
from mbed_tools_ci_scripts.utils.logging import log_exception
52+
from continuous_delivery_scripts.utils.configuration import configuration, ConfigurationVariable
53+
from continuous_delivery_scripts.assert_news import validate_news_file
54+
from continuous_delivery_scripts.utils.logging import log_exception
5555

5656
logger = logging.getLogger(__name__)
5757

@@ -129,8 +129,8 @@ <h2 id="usage">Usage</h2>
129129
<section>
130130
<h2 class="section-title" id="header-functions">Functions</h2>
131131
<dl>
132-
<dt id="mbed_tools_ci_scripts.create_news_file.create_news_file"><code class="name flex">
133-
<span>def <span class="ident">create_news_file</span></span>(<span>news_text: str, news_type: <a title="mbed_tools_ci_scripts.create_news_file.NewsType" href="#mbed_tools_ci_scripts.create_news_file.NewsType">NewsType</a>) ‑> pathlib.Path</span>
132+
<dt id="continuous_delivery_scripts.create_news_file.create_news_file"><code class="name flex">
133+
<span>def <span class="ident">create_news_file</span></span>(<span>news_text: str, news_type: <a title="continuous_delivery_scripts.create_news_file.NewsType" href="#continuous_delivery_scripts.create_news_file.NewsType">NewsType</a>) ‑> pathlib.Path</span>
134134
</code></dt>
135135
<dd>
136136
<div class="desc"><p>Facilitates creating a news file, determining it's file name based on the type.</p></div>
@@ -145,8 +145,8 @@ <h2 class="section-title" id="header-functions">Functions</h2>
145145
return file_path</code></pre>
146146
</details>
147147
</dd>
148-
<dt id="mbed_tools_ci_scripts.create_news_file.determine_news_file_path"><code class="name flex">
149-
<span>def <span class="ident">determine_news_file_path</span></span>(<span>news_type: <a title="mbed_tools_ci_scripts.create_news_file.NewsType" href="#mbed_tools_ci_scripts.create_news_file.NewsType">NewsType</a>) ‑> pathlib.Path</span>
148+
<dt id="continuous_delivery_scripts.create_news_file.determine_news_file_path"><code class="name flex">
149+
<span>def <span class="ident">determine_news_file_path</span></span>(<span>news_type: <a title="continuous_delivery_scripts.create_news_file.NewsType" href="#continuous_delivery_scripts.create_news_file.NewsType">NewsType</a>) ‑> pathlib.Path</span>
150150
</code></dt>
151151
<dd>
152152
<div class="desc"><p>Returns an available file path for given news type.</p></div>
@@ -165,7 +165,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
165165
return news_file_path</code></pre>
166166
</details>
167167
</dd>
168-
<dt id="mbed_tools_ci_scripts.create_news_file.main"><code class="name flex">
168+
<dt id="continuous_delivery_scripts.create_news_file.main"><code class="name flex">
169169
<span>def <span class="ident">main</span></span>(<span>) ‑> int</span>
170170
</code></dt>
171171
<dd>
@@ -198,7 +198,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
198198
<section>
199199
<h2 class="section-title" id="header-classes">Classes</h2>
200200
<dl>
201-
<dt id="mbed_tools_ci_scripts.create_news_file.NewsType"><code class="flex name class">
201+
<dt id="continuous_delivery_scripts.create_news_file.NewsType"><code class="flex name class">
202202
<span>class <span class="ident">NewsType</span></span>
203203
<span>(</span><span>value, names=None, *, module=None, qualname=None, type=None, start=1)</span>
204204
</code></dt>
@@ -224,27 +224,27 @@ <h3>Ancestors</h3>
224224
</ul>
225225
<h3>Class variables</h3>
226226
<dl>
227-
<dt id="mbed_tools_ci_scripts.create_news_file.NewsType.bugfix"><code class="name">var <span class="ident">bugfix</span></code></dt>
227+
<dt id="continuous_delivery_scripts.create_news_file.NewsType.bugfix"><code class="name">var <span class="ident">bugfix</span></code></dt>
228228
<dd>
229229
<div class="desc"></div>
230230
</dd>
231-
<dt id="mbed_tools_ci_scripts.create_news_file.NewsType.doc"><code class="name">var <span class="ident">doc</span></code></dt>
231+
<dt id="continuous_delivery_scripts.create_news_file.NewsType.doc"><code class="name">var <span class="ident">doc</span></code></dt>
232232
<dd>
233233
<div class="desc"></div>
234234
</dd>
235-
<dt id="mbed_tools_ci_scripts.create_news_file.NewsType.feature"><code class="name">var <span class="ident">feature</span></code></dt>
235+
<dt id="continuous_delivery_scripts.create_news_file.NewsType.feature"><code class="name">var <span class="ident">feature</span></code></dt>
236236
<dd>
237237
<div class="desc"></div>
238238
</dd>
239-
<dt id="mbed_tools_ci_scripts.create_news_file.NewsType.major"><code class="name">var <span class="ident">major</span></code></dt>
239+
<dt id="continuous_delivery_scripts.create_news_file.NewsType.major"><code class="name">var <span class="ident">major</span></code></dt>
240240
<dd>
241241
<div class="desc"></div>
242242
</dd>
243-
<dt id="mbed_tools_ci_scripts.create_news_file.NewsType.misc"><code class="name">var <span class="ident">misc</span></code></dt>
243+
<dt id="continuous_delivery_scripts.create_news_file.NewsType.misc"><code class="name">var <span class="ident">misc</span></code></dt>
244244
<dd>
245245
<div class="desc"></div>
246246
</dd>
247-
<dt id="mbed_tools_ci_scripts.create_news_file.NewsType.removal"><code class="name">var <span class="ident">removal</span></code></dt>
247+
<dt id="continuous_delivery_scripts.create_news_file.NewsType.removal"><code class="name">var <span class="ident">removal</span></code></dt>
248248
<dd>
249249
<div class="desc"></div>
250250
</dd>
@@ -261,27 +261,27 @@ <h1>Index</h1>
261261
<ul id="index">
262262
<li><h3>Super-module</h3>
263263
<ul>
264-
<li><code><a title="mbed_tools_ci_scripts" href="index.html">mbed_tools_ci_scripts</a></code></li>
264+
<li><code><a title="continuous_delivery_scripts" href="index.html">continuous_delivery_scripts</a></code></li>
265265
</ul>
266266
</li>
267267
<li><h3><a href="#header-functions">Functions</a></h3>
268268
<ul class="">
269-
<li><code><a title="mbed_tools_ci_scripts.create_news_file.create_news_file" href="#mbed_tools_ci_scripts.create_news_file.create_news_file">create_news_file</a></code></li>
270-
<li><code><a title="mbed_tools_ci_scripts.create_news_file.determine_news_file_path" href="#mbed_tools_ci_scripts.create_news_file.determine_news_file_path">determine_news_file_path</a></code></li>
271-
<li><code><a title="mbed_tools_ci_scripts.create_news_file.main" href="#mbed_tools_ci_scripts.create_news_file.main">main</a></code></li>
269+
<li><code><a title="continuous_delivery_scripts.create_news_file.create_news_file" href="#continuous_delivery_scripts.create_news_file.create_news_file">create_news_file</a></code></li>
270+
<li><code><a title="continuous_delivery_scripts.create_news_file.determine_news_file_path" href="#continuous_delivery_scripts.create_news_file.determine_news_file_path">determine_news_file_path</a></code></li>
271+
<li><code><a title="continuous_delivery_scripts.create_news_file.main" href="#continuous_delivery_scripts.create_news_file.main">main</a></code></li>
272272
</ul>
273273
</li>
274274
<li><h3><a href="#header-classes">Classes</a></h3>
275275
<ul>
276276
<li>
277-
<h4><code><a title="mbed_tools_ci_scripts.create_news_file.NewsType" href="#mbed_tools_ci_scripts.create_news_file.NewsType">NewsType</a></code></h4>
277+
<h4><code><a title="continuous_delivery_scripts.create_news_file.NewsType" href="#continuous_delivery_scripts.create_news_file.NewsType">NewsType</a></code></h4>
278278
<ul class="two-column">
279-
<li><code><a title="mbed_tools_ci_scripts.create_news_file.NewsType.bugfix" href="#mbed_tools_ci_scripts.create_news_file.NewsType.bugfix">bugfix</a></code></li>
280-
<li><code><a title="mbed_tools_ci_scripts.create_news_file.NewsType.doc" href="#mbed_tools_ci_scripts.create_news_file.NewsType.doc">doc</a></code></li>
281-
<li><code><a title="mbed_tools_ci_scripts.create_news_file.NewsType.feature" href="#mbed_tools_ci_scripts.create_news_file.NewsType.feature">feature</a></code></li>
282-
<li><code><a title="mbed_tools_ci_scripts.create_news_file.NewsType.major" href="#mbed_tools_ci_scripts.create_news_file.NewsType.major">major</a></code></li>
283-
<li><code><a title="mbed_tools_ci_scripts.create_news_file.NewsType.misc" href="#mbed_tools_ci_scripts.create_news_file.NewsType.misc">misc</a></code></li>
284-
<li><code><a title="mbed_tools_ci_scripts.create_news_file.NewsType.removal" href="#mbed_tools_ci_scripts.create_news_file.NewsType.removal">removal</a></code></li>
279+
<li><code><a title="continuous_delivery_scripts.create_news_file.NewsType.bugfix" href="#continuous_delivery_scripts.create_news_file.NewsType.bugfix">bugfix</a></code></li>
280+
<li><code><a title="continuous_delivery_scripts.create_news_file.NewsType.doc" href="#continuous_delivery_scripts.create_news_file.NewsType.doc">doc</a></code></li>
281+
<li><code><a title="continuous_delivery_scripts.create_news_file.NewsType.feature" href="#continuous_delivery_scripts.create_news_file.NewsType.feature">feature</a></code></li>
282+
<li><code><a title="continuous_delivery_scripts.create_news_file.NewsType.major" href="#continuous_delivery_scripts.create_news_file.NewsType.major">major</a></code></li>
283+
<li><code><a title="continuous_delivery_scripts.create_news_file.NewsType.misc" href="#continuous_delivery_scripts.create_news_file.NewsType.misc">misc</a></code></li>
284+
<li><code><a title="continuous_delivery_scripts.create_news_file.NewsType.removal" href="#continuous_delivery_scripts.create_news_file.NewsType.removal">removal</a></code></li>
285285
</ul>
286286
</li>
287287
</ul>
@@ -290,7 +290,7 @@ <h4><code><a title="mbed_tools_ci_scripts.create_news_file.NewsType" href="#mbed
290290
</nav>
291291
</main>
292292
<footer id="footer">
293-
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.8.3</a>.</p>
293+
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.1</a>.</p>
294294
</footer>
295295
</body>
296296
</html>

0 commit comments

Comments
 (0)