Skip to content

Commit

Permalink
🚀 releasing version 3.2.1 @ 2025-01-09 21:14
Browse files Browse the repository at this point in the history
[skip ci]
  • Loading branch information
monty-bot committed Jan 9, 2025
1 parent 516e08d commit d26c0cb
Show file tree
Hide file tree
Showing 58 changed files with 363 additions and 329 deletions.
20 changes: 20 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,26 @@ This project was forked from version 1.7.4 of [mbed-tools-ci-scripts](https://gi

[//]: # (begin_release_notes)

"3.2.1" (2025-01-09)
====================

Bugfixes
--------

- Support python 3.11 (#20230303162821)
- Dependency upgrade: mypy-1.1.1 (#20230307082327)
- Dependency upgrade: coverage-7.2.2 (#20230317082258)
- :bug: Fix the python error appearing from python > 3.11 (#20250109163919)
- Dependency upgrade: fetch-metadata-2.2.0 (#20250109185536)
- Dependency upgrade: scorecard-action-2.4.0 (#20250109185845)


Misc
----

- #20250109170328


"3.2.0" (2023-03-01)
====================

Expand Down
6 changes: 3 additions & 3 deletions continuous_delivery_scripts/_version.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@
This file is autogenerated, do not modify by hand.
"""
__version__ = "3.2.0"
COMMIT = "b8e85ab7e9d654882a35647095d8e51e4e7773fb"
__version__ = "3.2.1"
COMMIT = "516e08deffc6bba1a9fd975f52587189e19ef5aa"
MAJOR = 3
MINOR = 2
PATCH = 0
PATCH = 1
18 changes: 13 additions & 5 deletions docs/assert_news.html
Original file line number Diff line number Diff line change
Expand Up @@ -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-2023 Arm Limited or its affiliates and Contributors. All rights reserved.
# Copyright (C) 2020-2025 Arm Limited or its affiliates and Contributors. 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;
Expand All @@ -41,7 +41,7 @@ <h1 class="title">Module <code>continuous_delivery_scripts.assert_news</code></h
import pathlib
import re
import sys
from typing import List, Union
from typing import Union, Optional, Iterable, Any, List

from continuous_delivery_scripts.utils.configuration import configuration, ConfigurationVariable
from continuous_delivery_scripts.utils.git_helpers import ProjectTempClone, LocalProjectRepository, GitWrapper
Expand Down Expand Up @@ -131,6 +131,12 @@ <h1 class="title">Module <code>continuous_delivery_scripts.assert_news</code></h
validate_news_file(absolute_file_path)


def _convert_to_string_iter(list: Optional[List[Any]]) -&gt; Iterable[str]:
if list is None:
return []
return [str(item) for item in list]


def generate_news_file(git: GitWrapper, news_dir: pathlib.Path) -&gt; pathlib.Path:
&#34;&#34;&#34;Adds a news file if the branch corresponds to an dependency update.

Expand All @@ -147,8 +153,9 @@ <h1 class="title">Module <code>continuous_delivery_scripts.assert_news</code></h
if not configuration.get_value(ConfigurationVariable.AUTOGENERATE_NEWS_FILE_ON_DEPENDENCY_UPDATE):
raise EnvironmentError(f&#34;Branch {current_branch} must contain a news file.&#34;)

list_groups = _convert_to_string_iter(groups)
message = str(configuration.get_value(ConfigurationVariable.DEPENDENCY_UPDATE_NEWS_MESSAGE)).format(
message=&#34;, &#34;.join(groups)
message=&#34;, &#34;.join(list_groups)
)
logger.info(f&#34;Generating a news file with content: {message}...&#34;)
return create_news_file(
Expand All @@ -163,7 +170,7 @@ <h1 class="title">Module <code>continuous_delivery_scripts.assert_news</code></h
logger.info(f&#34;Committing news file {str(news_file)}...&#34;)
if not local:
git.configure_for_github()
git.add(str(news_file))
git.add(news_file)
git.commit(&#34;📰 Automatic changes ⚙ Adding news file&#34;)
if not local:
git.push()
Expand Down Expand Up @@ -289,8 +296,9 @@ <h2 id="args">Args</h2>
if not configuration.get_value(ConfigurationVariable.AUTOGENERATE_NEWS_FILE_ON_DEPENDENCY_UPDATE):
raise EnvironmentError(f&#34;Branch {current_branch} must contain a news file.&#34;)

list_groups = _convert_to_string_iter(groups)
message = str(configuration.get_value(ConfigurationVariable.DEPENDENCY_UPDATE_NEWS_MESSAGE)).format(
message=&#34;, &#34;.join(groups)
message=&#34;, &#34;.join(list_groups)
)
logger.info(f&#34;Generating a news file with content: {message}...&#34;)
return create_news_file(
Expand Down
2 changes: 1 addition & 1 deletion docs/create_news_file.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ <h2 id="usage">Usage</h2>
<span>Expand source code</span>
</summary>
<pre><code class="python">#
# Copyright (C) 2020-2023 Arm Limited or its affiliates and Contributors. All rights reserved.
# Copyright (C) 2020-2025 Arm Limited or its affiliates and Contributors. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
#
&#34;&#34;&#34;Easy news files generation.
Expand Down
2 changes: 1 addition & 1 deletion docs/generate_docs.html
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ <h1 class="title">Module <code>continuous_delivery_scripts.generate_docs</code><
<span>Expand source code</span>
</summary>
<pre><code class="python">#
# Copyright (C) 2020-2023 Arm Limited or its affiliates and Contributors. All rights reserved.
# Copyright (C) 2020-2025 Arm Limited or its affiliates and Contributors. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
#
&#34;&#34;&#34;Generates documentation.&#34;&#34;&#34;
Expand Down
2 changes: 1 addition & 1 deletion docs/generate_news.html
Original file line number Diff line number Diff line change
Expand Up @@ -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-2023 Arm Limited or its affiliates and Contributors. All rights reserved.
# Copyright (C) 2020-2025 Arm Limited or its affiliates and Contributors. 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;
Expand Down
2 changes: 1 addition & 1 deletion docs/get_config.html
Original file line number Diff line number Diff line change
Expand Up @@ -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-2023 Arm Limited or its affiliates and Contributors. All rights reserved.
# Copyright (C) 2020-2025 Arm Limited or its affiliates and Contributors. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
#
&#34;&#34;&#34;Retrieves configuration values.&#34;&#34;&#34;
Expand Down
9 changes: 5 additions & 4 deletions docs/get_version.html
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,13 @@ <h1 class="title">Module <code>continuous_delivery_scripts.get_version</code></h
<span>Expand source code</span>
</summary>
<pre><code class="python">#
# Copyright (C) 2020-2023 Arm Limited or its affiliates and Contributors. All rights reserved.
# Copyright (C) 2020-2025 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

from typing import Optional
import argparse
import logging
from continuous_delivery_scripts.utils.versioning import calculate_version, determine_version_string
Expand All @@ -48,7 +49,7 @@ <h1 class="title">Module <code>continuous_delivery_scripts.get_version</code></h
logger = logging.getLogger(__name__)


def get_project_version_string(commit_type: CommitType) -&gt; str:
def get_project_version_string(commit_type: CommitType) -&gt; Optional[str]:
&#34;&#34;&#34;Determine the project version string.

Args:
Expand Down Expand Up @@ -95,7 +96,7 @@ <h1 class="title">Module <code>continuous_delivery_scripts.get_version</code></h
<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>
<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>) ‑> Optional[str]</span>
</code></dt>
<dd>
<div class="desc"><p>Determine the project version string.</p>
Expand All @@ -110,7 +111,7 @@ <h2 id="returns">Returns</h2>
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def get_project_version_string(commit_type: CommitType) -&gt; str:
<pre><code class="python">def get_project_version_string(commit_type: CommitType) -&gt; Optional[str]:
&#34;&#34;&#34;Determine the project version string.

Args:
Expand Down
2 changes: 1 addition & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -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-2023 Arm Limited or its affiliates and Contributors. All rights reserved.
# Copyright (C) 2020-2025 Arm Limited or its affiliates and Contributors. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
#
&#34;&#34;&#34;Scripts and utilities used by the CI pipeline.&#34;&#34;&#34;
Expand Down
18 changes: 9 additions & 9 deletions docs/language_specifics.html
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ <h1 class="title">Module <code>continuous_delivery_scripts.language_specifics</c
<span>Expand source code</span>
</summary>
<pre><code class="python">#
# Copyright (C) 2020-2023 Arm Limited or its affiliates and Contributors. All rights reserved.
# Copyright (C) 2020-2025 Arm Limited or its affiliates and Contributors. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
#
&#34;&#34;&#34;Language plugins Loader.&#34;&#34;&#34;
Expand All @@ -49,8 +49,8 @@ <h1 class="title">Module <code>continuous_delivery_scripts.language_specifics</c
logger = logging.getLogger(__name__)


def _retrieve_all_subclasses(subclass: Type[BaseLanguage]) -&gt; Set[Type[BaseLanguage]]:
subclasses = set()
def _retrieve_all_subclasses(subclass: Type) -&gt; Set[Type]:
subclasses: set = set()
if not subclass:
return subclasses
if subclass != BaseLanguage:
Expand All @@ -64,10 +64,10 @@ <h1 class="title">Module <code>continuous_delivery_scripts.language_specifics</c
&#34;&#34;&#34;Fetches all language plugins which inherit from BaseLanguage.

Returns:
A list of classes containing language plugins
A list of classes containing language plugins
&#34;&#34;&#34;
all_plugins = _retrieve_all_subclasses(BaseLanguage)
return {la.get_related_language().lower().strip(): la for la in [lang() for lang in all_plugins]} # type: ignore
return {la.get_related_language().lower().strip(): la for la in [lang() for lang in all_plugins]}


def fetch_project_language_plugin(all_plugins: Dict[str, BaseLanguage], language: str) -&gt; BaseLanguage:
Expand All @@ -78,7 +78,7 @@ <h1 class="title">Module <code>continuous_delivery_scripts.language_specifics</c
language: the language to select

Returns:
A language plugin corresponding to the language requested
A language plugin corresponding to the language requested
&#34;&#34;&#34;
return cast(BaseLanguage, all_plugins.get(_sanitise_program_language(language)))

Expand Down Expand Up @@ -136,10 +136,10 @@ <h2 id="returns">Returns</h2>
&#34;&#34;&#34;Fetches all language plugins which inherit from BaseLanguage.

Returns:
A list of classes containing language plugins
A list of classes containing language plugins
&#34;&#34;&#34;
all_plugins = _retrieve_all_subclasses(BaseLanguage)
return {la.get_related_language().lower().strip(): la for la in [lang() for lang in all_plugins]} # type: ignore</code></pre>
return {la.get_related_language().lower().strip(): la for la in [lang() for lang in all_plugins]}</code></pre>
</details>
</dd>
<dt id="continuous_delivery_scripts.language_specifics.fetch_project_language_plugin"><code class="name flex">
Expand All @@ -164,7 +164,7 @@ <h2 id="returns">Returns</h2>
language: the language to select

Returns:
A language plugin corresponding to the language requested
A language plugin corresponding to the language requested
&#34;&#34;&#34;
return cast(BaseLanguage, all_plugins.get(_sanitise_program_language(language)))</code></pre>
</details>
Expand Down
2 changes: 1 addition & 1 deletion docs/license_files.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ <h1 class="title">Module <code>continuous_delivery_scripts.license_files</code><
<span>Expand source code</span>
</summary>
<pre><code class="python">#
# Copyright (C) 2020-2023 Arm Limited or its affiliates and Contributors. All rights reserved.
# Copyright (C) 2020-2025 Arm Limited or its affiliates and Contributors. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
#
&#34;&#34;&#34;Apply copyright and licensing to all source files present in a project.
Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/basic.html
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ <h1 class="title">Module <code>continuous_delivery_scripts.plugins.basic</code><
<span>Expand source code</span>
</summary>
<pre><code class="python">#
# Copyright (C) 2020-2023 Arm Limited or its affiliates and Contributors. All rights reserved.
# Copyright (C) 2020-2025 Arm Limited or its affiliates and Contributors. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
#
&#34;&#34;&#34;Basic plugin.&#34;&#34;&#34;
Expand Down
10 changes: 5 additions & 5 deletions docs/plugins/ci.html
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ <h1 class="title">Module <code>continuous_delivery_scripts.plugins.ci</code></h1
<span>Expand source code</span>
</summary>
<pre><code class="python">#
# Copyright (C) 2020-2023 Arm Limited or its affiliates and Contributors. All rights reserved.
# Copyright (C) 2020-2025 Arm Limited or its affiliates and Contributors. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
#
&#34;&#34;&#34;Plugin for CI projects.&#34;&#34;&#34;
Expand Down Expand Up @@ -63,7 +63,7 @@ <h1 class="title">Module <code>continuous_delivery_scripts.plugins.ci</code></h1
&#34;&#34;&#34;Gets the related language.&#34;&#34;&#34;
return get_language_from_file_name(__file__)

def get_version_tag(self, version: str):
def get_version_tag(self, version: str) -&gt; str:
&#34;&#34;&#34;Gets tag based on version.&#34;&#34;&#34;
cleansed_version = version.strip().lstrip(&#34;v&#34;)
return f&#34;v{cleansed_version}&#34;
Expand Down Expand Up @@ -128,7 +128,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
&#34;&#34;&#34;Gets the related language.&#34;&#34;&#34;
return get_language_from_file_name(__file__)

def get_version_tag(self, version: str):
def get_version_tag(self, version: str) -&gt; str:
&#34;&#34;&#34;Gets tag based on version.&#34;&#34;&#34;
cleansed_version = version.strip().lstrip(&#34;v&#34;)
return f&#34;v{cleansed_version}&#34;
Expand Down Expand Up @@ -229,15 +229,15 @@ <h3>Methods</h3>
</details>
</dd>
<dt id="continuous_delivery_scripts.plugins.ci.CI.get_version_tag"><code class="name flex">
<span>def <span class="ident">get_version_tag</span></span>(<span>self, version: str)</span>
<span>def <span class="ident">get_version_tag</span></span>(<span>self, version: str)> str</span>
</code></dt>
<dd>
<div class="desc"><p>Gets tag based on version.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def get_version_tag(self, version: str):
<pre><code class="python">def get_version_tag(self, version: str) -&gt; str:
&#34;&#34;&#34;Gets tag based on version.&#34;&#34;&#34;
cleansed_version = version.strip().lstrip(&#34;v&#34;)
return f&#34;v{cleansed_version}&#34;</code></pre>
Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/docker.html
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ <h1 class="title">Module <code>continuous_delivery_scripts.plugins.docker</code>
<span>Expand source code</span>
</summary>
<pre><code class="python">#
# Copyright (C) 2020-2023 Arm Limited or its affiliates and Contributors. All rights reserved.
# Copyright (C) 2020-2025 Arm Limited or its affiliates and Contributors. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
#
&#34;&#34;&#34;Plugin for Docker projects.&#34;&#34;&#34;
Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/github_actions.html
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ <h1 class="title">Module <code>continuous_delivery_scripts.plugins.github_action
<span>Expand source code</span>
</summary>
<pre><code class="python">#
# Copyright (C) 2020-2023 Arm Limited or its affiliates and Contributors. All rights reserved.
# Copyright (C) 2020-2025 Arm Limited or its affiliates and Contributors. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
#
&#34;&#34;&#34;Plugin for CI projects.&#34;&#34;&#34;
Expand Down
12 changes: 6 additions & 6 deletions docs/plugins/golang.html
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ <h1 class="title">Module <code>continuous_delivery_scripts.plugins.golang</code>
<span>Expand source code</span>
</summary>
<pre><code class="python">#
# Copyright (C) 2020-2023 Arm Limited or its affiliates and Contributors. All rights reserved.
# Copyright (C) 2020-2025 Arm Limited or its affiliates and Contributors. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
#
&#34;&#34;&#34;Plugin for Golang projects.&#34;&#34;&#34;
Expand Down Expand Up @@ -127,7 +127,7 @@ <h1 class="title">Module <code>continuous_delivery_scripts.plugins.golang</code>
check_call(_generate_goreleaser_check_command_list(), cwd=ROOT_DIR, env=env)


def _determine_go_module_tag(version) -&gt; Optional[str]:
def _determine_go_module_tag(version: str) -&gt; Optional[str]:
&#34;&#34;&#34;Determines go module for tagging.

See https://golang.org/ref/mod#vcs-version.
Expand All @@ -154,7 +154,7 @@ <h1 class="title">Module <code>continuous_delivery_scripts.plugins.golang</code>
&#34;&#34;&#34;Gets the related language.&#34;&#34;&#34;
return get_language_from_file_name(__file__)

def get_version_tag(self, version: str):
def get_version_tag(self, version: str) -&gt; str:
&#34;&#34;&#34;Gets tag based on version.&#34;&#34;&#34;
cleansed_version = version.strip().lstrip(&#34;v&#34;)
return f&#34;v{cleansed_version}&#34;
Expand Down Expand Up @@ -249,7 +249,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
&#34;&#34;&#34;Gets the related language.&#34;&#34;&#34;
return get_language_from_file_name(__file__)

def get_version_tag(self, version: str):
def get_version_tag(self, version: str) -&gt; str:
&#34;&#34;&#34;Gets tag based on version.&#34;&#34;&#34;
cleansed_version = version.strip().lstrip(&#34;v&#34;)
return f&#34;v{cleansed_version}&#34;
Expand Down Expand Up @@ -384,15 +384,15 @@ <h3>Methods</h3>
</details>
</dd>
<dt id="continuous_delivery_scripts.plugins.golang.Go.get_version_tag"><code class="name flex">
<span>def <span class="ident">get_version_tag</span></span>(<span>self, version: str)</span>
<span>def <span class="ident">get_version_tag</span></span>(<span>self, version: str)> str</span>
</code></dt>
<dd>
<div class="desc"><p>Gets tag based on version.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def get_version_tag(self, version: str):
<pre><code class="python">def get_version_tag(self, version: str) -&gt; str:
&#34;&#34;&#34;Gets tag based on version.&#34;&#34;&#34;
cleansed_version = version.strip().lstrip(&#34;v&#34;)
return f&#34;v{cleansed_version}&#34;</code></pre>
Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ <h1 class="title">Module <code>continuous_delivery_scripts.plugins</code></h1>
<span>Expand source code</span>
</summary>
<pre><code class="python">#
# Copyright (C) 2020-2023 Arm Limited or its affiliates and Contributors. All rights reserved.
# Copyright (C) 2020-2025 Arm Limited or its affiliates and Contributors. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
#
&#34;&#34;&#34;Language specific actions.&#34;&#34;&#34;
Expand Down
Loading

0 comments on commit d26c0cb

Please sign in to comment.