🚀 releasing version 2.0.0 @ 2020-11-30 12:04

[skip ci]

Author: monty-bot

CHANGELOG.md

@@ -13,6 +13,27 @@ This project was forked from version 1.7.4 of [mbed-tools-ci-scripts](https://gi
 
 [//]: # (begin_release_notes)
 
+"2.0.0" (2020-11-30)
+====================
+
+Major changes
+-------------
+
+- Implemented a plugin system for programming language specific actions. (#20201127193355)
+
+
+Features
+--------
+
+- Added a Docker plugin (#20201130101020)
+
+
+Bugfixes
+--------
+
+- Changed News files name granularity to the minute rather than second (#20201130095841)
+
+
 "1.0.1" (2020-11-27)
 ====================
 

continuous_delivery_scripts/_version.py

@@ -10,8 +10,8 @@
 
 This file is autogenerated, do not modify by hand.
 """
-__version__ = "1.0.1"
-COMMIT = "6511ce861c1f6e738ecc6af28d98ba601b6b0010"
-MAJOR = 1
+__version__ = "2.0.0"
+COMMIT = "171e960cf9c9d05ba888b7788265a930930c3ec4"
+MAJOR = 2
 MINOR = 0
-PATCH = 1
+PATCH = 0

docs/assert_news.html

@@ -32,7 +32,7 @@ <h1 class="title">Module <code>continuous_delivery_scripts.assert_news</code></h
 <span>Expand source code</span>
 </summary>
 <pre><code class="python">#
-# Copyright (C) 2020 Arm Mbed. All rights reserved.
+# Copyright (C) 2020 Arm. All rights reserved.
 # SPDX-License-Identifier: Apache-2.0
 #
 &#34;&#34;&#34;Checks if valid news files are created for changes in the project.&#34;&#34;&#34;

docs/create_news_file.html

@@ -34,7 +34,7 @@ <h2 id="usage">Usage</h2>
 <span>Expand source code</span>
 </summary>
 <pre><code class="python">#
-# Copyright (C) 2020 Arm Mbed. All rights reserved.
+# Copyright (C) 2020 Arm. All rights reserved.
 # SPDX-License-Identifier: Apache-2.0
 #
 &#34;&#34;&#34;Easy news files generation.
@@ -96,7 +96,7 @@ <h2 id="usage">Usage</h2>
 
 
 def _determine_todays_news_file_name() -&gt; str:
-    return datetime.now().strftime(&#34;%Y%m%d%H%M%S&#34;)
+    return datetime.now().strftime(&#34;%Y%m%d%H%M&#34;)
 
 
 def main() -&gt; int:

docs/generate_docs.html

@@ -9,7 +9,7 @@
 <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
 <meta name="generator" content="pdoc 0.9.2" />
 <title>continuous_delivery_scripts.generate_docs API documentation</title>
-<meta name="description" content="Generates documentation using Pdoc." />
+<meta name="description" content="Generates documentation." />
 <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>
 <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>
 <link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
@@ -26,28 +26,25 @@
 <h1 class="title">Module <code>continuous_delivery_scripts.generate_docs</code></h1>
 </header>
 <section id="section-intro">
-<p>Generates documentation using Pdoc.</p>
+<p>Generates documentation.</p>
 <details class="source">
 <summary>
 <span>Expand source code</span>
 </summary>
 <pre><code class="python">#
-# Copyright (C) 2020 Arm Mbed. All rights reserved.
+# Copyright (C) 2020 Arm. All rights reserved.
 # SPDX-License-Identifier: Apache-2.0
 #
-&#34;&#34;&#34;Generates documentation using Pdoc.&#34;&#34;&#34;
+&#34;&#34;&#34;Generates documentation.&#34;&#34;&#34;
+import argparse
+import logging
 import os
 import shutil
 import sys
-
-import argparse
-import logging
 from pathlib import Path
-from subprocess import check_call
-from typing import List
 
+from continuous_delivery_scripts.language_specifics import get_language_specifics
 from continuous_delivery_scripts.utils.configuration import configuration, ConfigurationVariable
-from continuous_delivery_scripts.utils.filesystem_helpers import TemporaryDirectory
 from continuous_delivery_scripts.utils.logging import log_exception
 
 logger = logging.getLogger(__name__)
@@ -59,40 +56,11 @@ <h1 class="title">Module <code>continuous_delivery_scripts.generate_docs</code><
         shutil.rmtree(str(output_directory))
 
 
-def _generate_pdoc_command_list(output_directory: Path, module: str) -&gt; List[str]:
-    return [
-        &#34;pdoc&#34;,
-        &#34;--html&#34;,
-        f&#34;{module}&#34;,
-        &#34;--output-dir&#34;,
-        f&#34;{str(output_directory)}&#34;,
-        &#34;--force&#34;,
-        &#34;--config&#34;,
-        &#34;show_type_annotations=True&#34;,
-    ]
-
-
 def generate_documentation(output_directory: Path, module_to_document: str) -&gt; None:
-    &#34;&#34;&#34;Ensures the documentation is in the correct location.
-
-    Pdoc nests its docs output in a folder with the module&#39;s name.
-    This process removes this unwanted folder.
-    &#34;&#34;&#34;
+    &#34;&#34;&#34;Generates the documentation.&#34;&#34;&#34;
     _clear_previous_docs(output_directory)
     os.makedirs(str(output_directory), exist_ok=True)
-    with TemporaryDirectory() as temp_dir:
-        _call_pdoc(temp_dir, module_to_document)
-        docs_contents_dir = temp_dir.joinpath(module_to_document)
-        if docs_contents_dir.exists() and docs_contents_dir.is_dir():
-            for element in docs_contents_dir.iterdir():
-                shutil.move(str(element), str(output_directory))
-
-
-def _call_pdoc(output_directory: Path, module: str) -&gt; None:
-    &#34;&#34;&#34;Calls Pdoc for generating the docs.&#34;&#34;&#34;
-    logger.info(&#34;Creating Pdoc documentation.&#34;)
-    command_list = _generate_pdoc_command_list(output_directory, module)
-    check_call(command_list)
+    get_language_specifics().generate_code_documentation(output_directory, module_to_document)
 
 
 def generate_docs(output_directory: Path, module: str) -&gt; int:
@@ -153,27 +121,16 @@ <h2 class="section-title" id="header-functions">Functions</h2>
 <span>def <span class="ident">generate_documentation</span></span>(<span>output_directory: pathlib.Path, module_to_document: str) ‑> NoneType</span>
 </code></dt>
 <dd>
-<div class="desc"><p>Ensures the documentation is in the correct location.</p>
-<p>Pdoc nests its docs output in a folder with the module's name.
-This process removes this unwanted folder.</p></div>
+<div class="desc"><p>Generates the documentation.</p></div>
 <details class="source">
 <summary>
 <span>Expand source code</span>
 </summary>
 <pre><code class="python">def generate_documentation(output_directory: Path, module_to_document: str) -&gt; None:
-    &#34;&#34;&#34;Ensures the documentation is in the correct location.
-
-    Pdoc nests its docs output in a folder with the module&#39;s name.
-    This process removes this unwanted folder.
-    &#34;&#34;&#34;
+    &#34;&#34;&#34;Generates the documentation.&#34;&#34;&#34;
     _clear_previous_docs(output_directory)
     os.makedirs(str(output_directory), exist_ok=True)
-    with TemporaryDirectory() as temp_dir:
-        _call_pdoc(temp_dir, module_to_document)
-        docs_contents_dir = temp_dir.joinpath(module_to_document)
-        if docs_contents_dir.exists() and docs_contents_dir.is_dir():
-            for element in docs_contents_dir.iterdir():
-                shutil.move(str(element), str(output_directory))</code></pre>
+    get_language_specifics().generate_code_documentation(output_directory, module_to_document)</code></pre>
 </details>
 </dd>
 <dt id="continuous_delivery_scripts.generate_docs.main"><code class="name flex">

docs/generate_news.html

@@ -32,7 +32,7 @@ <h1 class="title">Module <code>continuous_delivery_scripts.generate_news</code><
 <span>Expand source code</span>
 </summary>
 <pre><code class="python">#
-# Copyright (C) 2020 Arm Mbed. All rights reserved.
+# Copyright (C) 2020 Arm. All rights reserved.
 # SPDX-License-Identifier: Apache-2.0
 #
 &#34;&#34;&#34;Handles usage of towncrier for automated changelog generation and pyautoversion for versioning.&#34;&#34;&#34;

docs/get_config.html

@@ -32,7 +32,7 @@ <h1 class="title">Module <code>continuous_delivery_scripts.get_config</code></h1
 <span>Expand source code</span>
 </summary>
 <pre><code class="python">#
-# Copyright (C) 2020 Arm Mbed. All rights reserved.
+# Copyright (C) 2020 Arm. All rights reserved.
 # SPDX-License-Identifier: Apache-2.0
 #
 &#34;&#34;&#34;Retrieves configuration values.&#34;&#34;&#34;

docs/index.html

@@ -32,7 +32,7 @@ <h1 class="title">Package <code>continuous_delivery_scripts</code></h1>
 <span>Expand source code</span>
 </summary>
 <pre><code class="python">#
-# Copyright (C) 2020 Arm Mbed. All rights reserved.
+# Copyright (C) 2020 Arm. All rights reserved.
 # SPDX-License-Identifier: Apache-2.0
 #
 &#34;&#34;&#34;Scripts and utilities used by the CI pipeline.&#34;&#34;&#34;
@@ -52,7 +52,7 @@ <h2 class="section-title" id="header-submodules">Sub-modules</h2>
 </dd>
 <dt><code class="name"><a title="continuous_delivery_scripts.generate_docs" href="generate_docs.html">continuous_delivery_scripts.generate_docs</a></code></dt>
 <dd>
-<div class="desc"><p>Generates documentation using Pdoc.</p></div>
+<div class="desc"><p>Generates documentation.</p></div>
 </dd>
 <dt><code class="name"><a title="continuous_delivery_scripts.generate_news" href="generate_news.html">continuous_delivery_scripts.generate_news</a></code></dt>
 <dd>
@@ -62,10 +62,18 @@ <h2 class="section-title" id="header-submodules">Sub-modules</h2>
 <dd>
 <div class="desc"><p>Retrieves configuration values.</p></div>
 </dd>
+<dt><code class="name"><a title="continuous_delivery_scripts.language_specifics" href="language_specifics.html">continuous_delivery_scripts.language_specifics</a></code></dt>
+<dd>
+<div class="desc"><p>Language plugins Loader.</p></div>
+</dd>
 <dt><code class="name"><a title="continuous_delivery_scripts.license_files" href="license_files.html">continuous_delivery_scripts.license_files</a></code></dt>
 <dd>
 <div class="desc"><p>Apply copyright and licensing to all source files present in a project …</p></div>
 </dd>
+<dt><code class="name"><a title="continuous_delivery_scripts.plugins" href="plugins/index.html">continuous_delivery_scripts.plugins</a></code></dt>
+<dd>
+<div class="desc"><p>Language specific actions.</p></div>
+</dd>
 <dt><code class="name"><a title="continuous_delivery_scripts.report_third_party_ip" href="report_third_party_ip.html">continuous_delivery_scripts.report_third_party_ip</a></code></dt>
 <dd>
 <div class="desc"><p>Script providing information about licensing and third party IP in order to comply with OpenChain …</p></div>
@@ -104,7 +112,9 @@ <h1>Index</h1>
 <li><code><a title="continuous_delivery_scripts.generate_docs" href="generate_docs.html">continuous_delivery_scripts.generate_docs</a></code></li>
 <li><code><a title="continuous_delivery_scripts.generate_news" href="generate_news.html">continuous_delivery_scripts.generate_news</a></code></li>
 <li><code><a title="continuous_delivery_scripts.get_config" href="get_config.html">continuous_delivery_scripts.get_config</a></code></li>
+<li><code><a title="continuous_delivery_scripts.language_specifics" href="language_specifics.html">continuous_delivery_scripts.language_specifics</a></code></li>
 <li><code><a title="continuous_delivery_scripts.license_files" href="license_files.html">continuous_delivery_scripts.license_files</a></code></li>
+<li><code><a title="continuous_delivery_scripts.plugins" href="plugins/index.html">continuous_delivery_scripts.plugins</a></code></li>
 <li><code><a title="continuous_delivery_scripts.report_third_party_ip" href="report_third_party_ip.html">continuous_delivery_scripts.report_third_party_ip</a></code></li>
 <li><code><a title="continuous_delivery_scripts.spdx_report" href="spdx_report/index.html">continuous_delivery_scripts.spdx_report</a></code></li>
 <li><code><a title="continuous_delivery_scripts.tag_and_release" href="tag_and_release.html">continuous_delivery_scripts.tag_and_release</a></code></li>