🚀 releasing version 2.3.0 @ 2021-08-11 14:59

[skip ci]

Author: monty-bot

CHANGELOG.md

@@ -1,3 +1,7 @@
+<!--
+Copyright (C) 2020-2021 Arm Limited or its affiliates and Contributors. All rights reserved.
+SPDX-License-Identifier: Apache-2.0
+-->
 # Changelog
 
 <!--
@@ -13,6 +17,22 @@ This project was forked from version 1.7.4 of [mbed-tools-ci-scripts](https://gi
 
 [//]: # (begin_release_notes)
 
+"2.3.0" (2021-08-11)
+====================
+
+Features
+--------
+
+- Added a command to determine project's version (#202108111437)
+
+
+Bugfixes
+--------
+
+- Dependency upgrade: licenseheaders-lt-0.8.9 (#202108110242)
+- Fix bug in determining the new release/beta version (#202108111347)
+
+
 "2.2.4" (2021-08-11)
 ====================
 

continuous_delivery_scripts/_version.py

@@ -10,8 +10,8 @@
 
 This file is autogenerated, do not modify by hand.
 """
-__version__ = "2.2.4"
-COMMIT = "3419789b01c48e806cf32b55fb5eb7834195d7d9"
+__version__ = "2.3.0"
+COMMIT = "be81639291b9d9f0763a32a6d2bdbd050a48a594"
 MAJOR = 2
-MINOR = 2
-PATCH = 4
+MINOR = 3
+PATCH = 0

docs/generate_news.html

@@ -42,13 +42,13 @@ <h1 class="title">Module <code>continuous_delivery_scripts.generate_news</code><
 import logging
 import os
 import subprocess
-from auto_version import auto_version_tool
-from continuous_delivery_scripts.utils.definitions import CommitType
-from continuous_delivery_scripts.utils.git_helpers import LocalProjectRepository
+from continuous_delivery_scripts.utils.versioning import calculate_version, determine_version_string
+from typing import Optional, Tuple, Dict
+
 from continuous_delivery_scripts.utils.configuration import configuration, ConfigurationVariable
-from continuous_delivery_scripts.utils.logging import log_exception, set_log_level
+from continuous_delivery_scripts.utils.definitions import CommitType
 from continuous_delivery_scripts.utils.filesystem_helpers import cd
-from typing import Optional, Tuple, Dict
+from continuous_delivery_scripts.utils.logging import log_exception, set_log_level
 
 logger = logging.getLogger(__name__)
 
@@ -64,87 +64,11 @@ <h1 class="title">Module <code>continuous_delivery_scripts.generate_news</code><
         (is new version, the new version)
     &#34;&#34;&#34;
     use_news_files = commit_type in [CommitType.BETA, CommitType.RELEASE]
-    is_new_version, new_version, version_elements = _calculate_version(commit_type, use_news_files)
+    is_new_version, new_version, version_elements = calculate_version(commit_type, use_news_files)
     _generate_changelog(new_version, use_news_files)
     return is_new_version, new_version, version_elements
 
 
-def _calculate_version(commit_type: CommitType, use_news_files: bool) -&gt; Tuple[bool, Optional[str], Dict[str, str]]:
-    &#34;&#34;&#34;Calculates the version for the release.
-
-    eg. &#34;0.1.2&#34;
-
-    Args:
-        commit_type:
-        use_news_files: Should the version be dependant on changes recorded in news files
-
-    Returns:
-        Tuple containing
-            a flag stating whether it is a new version or not
-            A semver-style version for the latest release
-    &#34;&#34;&#34;
-    BUMP_TYPES = {CommitType.DEVELOPMENT: &#34;build&#34;, CommitType.BETA: &#34;prerelease&#34;}
-    is_release = commit_type == CommitType.RELEASE
-    enable_file_triggers = True if use_news_files else None
-    bump = BUMP_TYPES.get(commit_type)
-    project_config_path = configuration.get_value(ConfigurationVariable.PROJECT_CONFIG)
-    new_version: Optional[str] = None
-    is_new_version: bool = False
-    with cd(os.path.dirname(project_config_path)):
-        old, new_version, updates = auto_version_tool.main(
-            release=is_release,
-            enable_file_triggers=enable_file_triggers,
-            commit_count_as=bump,
-            config_path=project_config_path,
-        )
-        # Autoversion second returned value is not actually the new version
-        # There seem to be a bug in autoversion.
-        # This is why the following needs to be done to determine the version
-        version_elements = _get_version_elements(updates)
-        new_version = version_elements.get(auto_version_tool.Constants.VERSION_FIELD, new_version)
-        is_new_version = old != new_version
-    logger.info(&#34;:: Determining the new version&#34;)
-    logger.info(f&#34;Version: {new_version}&#34;)
-    return is_new_version, new_version, version_elements
-
-
-def _update_version_string(
-    commit_type: CommitType, new_version: Optional[str], version_elements: Dict[str, str]
-) -&gt; Optional[str]:
-    &#34;&#34;&#34;Updates the version string for development releases.
-
-    Args:
-        commit_type: commit type
-        new_version: the new version
-        version_elements: version elements
-    &#34;&#34;&#34;
-    if commit_type == CommitType.DEVELOPMENT:
-        commit_count = version_elements.get(auto_version_tool.Constants.COMMIT_COUNT_FIELD)
-        if not commit_count:
-            with LocalProjectRepository() as git:
-                commit_count = git.get_commit_count()
-        return &#34;%s-%s.%s+%s&#34; % (
-            new_version,
-            auto_version_tool.config.BUILD_TOKEN,
-            commit_count,
-            version_elements.get(auto_version_tool.Constants.COMMIT_FIELD),
-        )
-        return new_version
-
-
-def _get_version_elements(native_version_elements: Dict[str, str]) -&gt; Dict[str, str]:
-    &#34;&#34;&#34;Determines the different version elements.
-
-    Args:
-        native_version_elements: native version elements as understood by autoversion
-    &#34;&#34;&#34;
-    return {
-        key: native_version_elements[native]
-        for native, key in auto_version_tool.config.key_aliases.items()
-        if native in native_version_elements
-    }
-
-
 def _generate_changelog(version: Optional[str], use_news_files: bool) -&gt; None:
     &#34;&#34;&#34;Creates a towncrier log of the release.
 
@@ -174,7 +98,7 @@ <h1 class="title">Module <code>continuous_delivery_scripts.generate_news</code><
     try:
         commit_type = CommitType.parse(args.release_type)
         is_new_version, new_version, version_elements = version_project(commit_type)
-        version_to_print = _update_version_string(commit_type, new_version, version_elements)
+        version_to_print = determine_version_string(commit_type, new_version, version_elements)
         print(version_to_print)
     except Exception as e:
         log_exception(logger, e)
@@ -214,7 +138,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
     try:
         commit_type = CommitType.parse(args.release_type)
         is_new_version, new_version, version_elements = version_project(commit_type)
-        version_to_print = _update_version_string(commit_type, new_version, version_elements)
+        version_to_print = determine_version_string(commit_type, new_version, version_elements)
         print(version_to_print)
     except Exception as e:
         log_exception(logger, e)
@@ -248,7 +172,7 @@ <h2 id="returns">Returns</h2>
         (is new version, the new version)
     &#34;&#34;&#34;
     use_news_files = commit_type in [CommitType.BETA, CommitType.RELEASE]
-    is_new_version, new_version, version_elements = _calculate_version(commit_type, use_news_files)
+    is_new_version, new_version, version_elements = calculate_version(commit_type, use_news_files)
     _generate_changelog(new_version, use_news_files)
     return is_new_version, new_version, version_elements</code></pre>
 </details>

docs/get_version.html

@@ -0,0 +1,186 @@
+<!--
+-- Copyright (C) 2020-2021 Arm Limited or its affiliates and Contributors. All rights reserved.
+-- SPDX-License-Identifier: Apache-2.0
+-->
+<!doctype html>
+<html lang="en">
+<head>
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
+<meta name="generator" content="pdoc 0.9.1" />
+<title>continuous_delivery_scripts.get_version API documentation</title>
+<meta name="description" content="Determine the project new version." />
+<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>
+<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>
+<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>
+<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>
+<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
+<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
+</head>
+<body>
+<main>
+<article id="content">
+<header>
+<h1 class="title">Module <code>continuous_delivery_scripts.get_version</code></h1>
+</header>
+<section id="section-intro">
+<p>Determine the project new version.</p>
+<details class="source">
+<summary>
+<span>Expand source code</span>
+</summary>
+<pre><code class="python">#
+# Copyright (C) 2020-2021 Arm Limited or its affiliates and Contributors. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+&#34;&#34;&#34;Determine the project new version.&#34;&#34;&#34;
+import sys
+
+import argparse
+import logging
+from continuous_delivery_scripts.utils.versioning import calculate_version, determine_version_string
+
+from continuous_delivery_scripts.utils.definitions import CommitType
+from continuous_delivery_scripts.utils.logging import log_exception, set_log_level
+
+logger = logging.getLogger(__name__)
+
+
+def get_project_version_string(commit_type: CommitType) -&gt; str:
+    &#34;&#34;&#34;Determine the project version string.
+
+    Args:
+        commit_type: states what is the type of the commit
+
+
+    Returns:
+        (is new version, the new version)
+    &#34;&#34;&#34;
+    use_news_files = commit_type in [CommitType.BETA, CommitType.RELEASE]
+    _, new_version, version_elements = calculate_version(commit_type, use_news_files)
+    version_string = determine_version_string(commit_type, new_version, version_elements)
+    return version_string
+
+
+def main() -&gt; None:
+    &#34;&#34;&#34;Handle command line arguments to determine version string.&#34;&#34;&#34;
+    parser = argparse.ArgumentParser(description=&#34;Determine project&#39;s version.&#34;)
+    parser.add_argument(
+        &#34;-t&#34;, &#34;--release-type&#34;, help=&#34;type of release to perform&#34;, required=True, type=str, choices=CommitType.choices()
+    )
+    parser.add_argument(&#34;-v&#34;, &#34;--verbose&#34;, action=&#34;count&#34;, default=0, help=&#34;Verbosity, by default errors are reported.&#34;)
+    args = parser.parse_args()
+    set_log_level(args.verbose)
+
+    try:
+        commit_type = CommitType.parse(args.release_type)
+        version_to_print = get_project_version_string(commit_type)
+        print(version_to_print)
+    except Exception as e:
+        log_exception(logger, e)
+        sys.exit(1)
+
+
+if __name__ == &#34;__main__&#34;:
+    main()</code></pre>
+</details>
+</section>
+<section>
+</section>
+<section>
+</section>
+<section>
+<h2 class="section-title" id="header-functions">Functions</h2>
+<dl>
+<dt id="continuous_delivery_scripts.get_version.get_project_version_string"><code class="name flex">
+<span>def <span class="ident">get_project_version_string</span></span>(<span>commit_type: <a title="continuous_delivery_scripts.utils.definitions.CommitType" href="utils/definitions.html#continuous_delivery_scripts.utils.definitions.CommitType">CommitType</a>) ‑> str</span>
+</code></dt>
+<dd>
+<div class="desc"><p>Determine the project version string.</p>
+<h2 id="args">Args</h2>
+<dl>
+<dt><strong><code>commit_type</code></strong></dt>
+<dd>states what is the type of the commit</dd>
+</dl>
+<h2 id="returns">Returns</h2>
+<p>(is new version, the new version)</p></div>
+<details class="source">
+<summary>
+<span>Expand source code</span>
+</summary>
+<pre><code class="python">def get_project_version_string(commit_type: CommitType) -&gt; str:
+    &#34;&#34;&#34;Determine the project version string.
+
+    Args:
+        commit_type: states what is the type of the commit
+
+
+    Returns:
+        (is new version, the new version)
+    &#34;&#34;&#34;
+    use_news_files = commit_type in [CommitType.BETA, CommitType.RELEASE]
+    _, new_version, version_elements = calculate_version(commit_type, use_news_files)
+    version_string = determine_version_string(commit_type, new_version, version_elements)
+    return version_string</code></pre>
+</details>
+</dd>
+<dt id="continuous_delivery_scripts.get_version.main"><code class="name flex">
+<span>def <span class="ident">main</span></span>(<span>) ‑> NoneType</span>
+</code></dt>
+<dd>
+<div class="desc"><p>Handle command line arguments to determine version string.</p></div>
+<details class="source">
+<summary>
+<span>Expand source code</span>
+</summary>
+<pre><code class="python">def main() -&gt; None:
+    &#34;&#34;&#34;Handle command line arguments to determine version string.&#34;&#34;&#34;
+    parser = argparse.ArgumentParser(description=&#34;Determine project&#39;s version.&#34;)
+    parser.add_argument(
+        &#34;-t&#34;, &#34;--release-type&#34;, help=&#34;type of release to perform&#34;, required=True, type=str, choices=CommitType.choices()
+    )
+    parser.add_argument(&#34;-v&#34;, &#34;--verbose&#34;, action=&#34;count&#34;, default=0, help=&#34;Verbosity, by default errors are reported.&#34;)
+    args = parser.parse_args()
+    set_log_level(args.verbose)
+
+    try:
+        commit_type = CommitType.parse(args.release_type)
+        version_to_print = get_project_version_string(commit_type)
+        print(version_to_print)
+    except Exception as e:
+        log_exception(logger, e)
+        sys.exit(1)</code></pre>
+</details>
+</dd>
+</dl>
+</section>
+<section>
+</section>
+</article>
+<nav id="sidebar">
+<h1>Index</h1>
+<div class="toc">
+<ul></ul>
+</div>
+<ul id="index">
+<li><h3>Super-module</h3>
+<ul>
+<li><code><a title="continuous_delivery_scripts" href="index.html">continuous_delivery_scripts</a></code></li>
+</ul>
+</li>
+<li><h3><a href="#header-functions">Functions</a></h3>
+<ul class="">
+<li><code><a title="continuous_delivery_scripts.get_version.get_project_version_string" href="#continuous_delivery_scripts.get_version.get_project_version_string">get_project_version_string</a></code></li>
+<li><code><a title="continuous_delivery_scripts.get_version.main" href="#continuous_delivery_scripts.get_version.main">main</a></code></li>
+</ul>
+</li>
+</ul>
+</nav>
+</main>
+<footer id="footer">
+<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.1</a>.</p>
+</footer>
+</body>
+</html>