continuous-delivery-scripts 3.5.0__tar.gz → 4.0.0__tar.gz

{continuous_delivery_scripts-3.5.0/continuous_delivery_scripts.egg-info → continuous_delivery_scripts-4.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: continuous-delivery-scripts
-Version: 3.5.0
+Version: 4.0.0
 Summary: Continuous Delivery scripts to increase automation
 Home-page: https://github.com/ARMmbed/continuous-delivery-scripts
 Author: CMSIS team
@@ -11,19 +11,20 @@ Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Software Development :: Build Tools
-Requires-Python: >=3.8,<4
+Requires-Python: >=3.10,<4
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: setuptools
 Requires-Dist: gitpython
 Requires-Dist: towncrier==22.12.0
 Requires-Dist: pyautoversion~=1.2.0
-Requires-Dist: pdoc3==0.10.0
+Requires-Dist: pdoc3==0.11.6
 Requires-Dist: toml
 Requires-Dist: semver~=2.13.0
 Requires-Dist: python-dotenv
@@ -32,7 +33,7 @@ Requires-Dist: boto3
 Requires-Dist: detect-secrets[gibberish]==1.5.0
 Requires-Dist: packaging
 Requires-Dist: licenseheaders<0.8.9
-Requires-Dist: spdx-tools==0.6.1
+Requires-Dist: spdx-tools==0.8.5
 Requires-Dist: license-expression
 Requires-Dist: wcmatch
 Requires-Dist: jellyfish
@@ -141,6 +142,16 @@ Therefore, it installs the following tools which can be used anywhere within a p
 * `cd-generate-spdx`: Generates SPDX documents for the project (3rd party IP reporting/ OpenChain)
 * `cd-license-files`: Updates the Licence header and copyright to all the source code files
 
+For GitHub automation that performs authenticated clone or fetch operations, see [GitHub Token Authentication](#github-token-authentication).
+
+## GitHub Token Authentication
+
+When git operations need to retry against GitHub over HTTPS, this project now uses the credential layout `https://x-access-token:<token>@github.com/<owner>/<repo>.git`.
+
+This means the token is sent in the password position with `x-access-token` as the username, which is the format GitHub accepts for workflow-generated and other non-OAuth tokens used by automation.
+
+Older `https://<token>:x-oauth-basic@github.com/...` URLs were tied to OAuth-style credentials and could reject tokens created dynamically during CI/CD flows.
+
 ## Project Structure
 
 The follow described the major aspects of the project structure:

{continuous_delivery_scripts-3.5.0 → continuous_delivery_scripts-4.0.0}/README.md

@@ -88,6 +88,16 @@ Therefore, it installs the following tools which can be used anywhere within a p
 * `cd-generate-spdx`: Generates SPDX documents for the project (3rd party IP reporting/ OpenChain)
 * `cd-license-files`: Updates the Licence header and copyright to all the source code files
 
+For GitHub automation that performs authenticated clone or fetch operations, see [GitHub Token Authentication](#github-token-authentication).
+
+## GitHub Token Authentication
+
+When git operations need to retry against GitHub over HTTPS, this project now uses the credential layout `https://x-access-token:<token>@github.com/<owner>/<repo>.git`.
+
+This means the token is sent in the password position with `x-access-token` as the username, which is the format GitHub accepts for workflow-generated and other non-OAuth tokens used by automation.
+
+Older `https://<token>:x-oauth-basic@github.com/...` URLs were tied to OAuth-style credentials and could reject tokens created dynamically during CI/CD flows.
+
 ## Project Structure
 
 The follow described the major aspects of the project structure:

{continuous_delivery_scripts-3.5.0 → continuous_delivery_scripts-4.0.0}/continuous_delivery_scripts/_version.py

@@ -11,8 +11,8 @@ References
 This file is autogenerated, do not modify by hand.
 """
 
-__version__ = "3.5.0"
-COMMIT = "c8bbe64d754ac6d58403d50c46679ccebc5e1ef8"
-MAJOR = 3
-MINOR = 5
+__version__ = "4.0.0"
+COMMIT = "88537b61214eccbd719674df43ddf40d985ecd92"
+MAJOR = 4
+MINOR = 0
 PATCH = 0

{continuous_delivery_scripts-3.5.0 → continuous_delivery_scripts-4.0.0}/continuous_delivery_scripts/assert_news.py

@@ -21,6 +21,10 @@ logger = logging.getLogger(__name__)
 NEWS_FILE_NAME_REGEX = r"^[0-9]+.(misc|doc|removal|bugfix|feature|major)$"
 
 
+class MissingNewsFileError(FileNotFoundError):
+    """The branch contains no added news file."""
+
+
 class NewsFileValidator:
     """Verifies individual news files."""
 
@@ -77,10 +81,11 @@ def find_news_files(git: GitWrapper, root_dir: str, news_dir: str) -> List[str]:
     # If no news files were added, then we check for addition on the branch.
     # Relies on the fact GitWrapper returns paths that are always relative
     # to the project root.
-    added_news_files = [file_path for file_path in files_changed if file_path.startswith(news_dir)]
+    news_prefix = news_dir.replace("\\", "/").rstrip("/") + "/"
+    added_news_files = [file_path for file_path in files_changed if file_path.startswith(news_prefix)]
     if len(added_news_files) == 0:
         files_changed = git.list_files_added_on_current_branch()
-        added_news_files = [file_path for file_path in files_changed if file_path.startswith(news_dir)]
+        added_news_files = [file_path for file_path in files_changed if file_path.startswith(news_prefix)]
     return [str(pathlib.Path(root_dir, file_path)) for file_path in added_news_files]
 
 
@@ -94,7 +99,7 @@ def validate_news_files(git: GitWrapper, root_dir: str, news_dir: str) -> None:
     """
     added_news_files = find_news_files(git=git, news_dir=news_dir, root_dir=root_dir)
     if not added_news_files:
-        raise FileNotFoundError(f"PR must contain a news file in {news_dir}. See README.md.")
+        raise MissingNewsFileError(f"PR must contain a news file in {news_dir}. See README.md.")
     for absolute_file_path in added_news_files:
         validate_news_file(absolute_file_path)
 
@@ -164,8 +169,8 @@ def main() -> None:
             absolute_news_dir = configuration.get_value(ConfigurationVariable.NEWS_DIR)
             news_dir = str(pathlib.Path(absolute_news_dir).relative_to(root_dir))
             try:
-                validate_news_files(git=git, news_dir=news_dir, root_dir=root_dir)
-            except Exception as e:
+                validate_news_files(git=git, news_dir=news_dir, root_dir=str(git.root))
+            except MissingNewsFileError as e:
                 log_exception(logger, e)
                 try:
                     news_file = generate_news_file(git, git.get_corresponding_path(pathlib.Path(news_dir)))
@@ -173,6 +178,9 @@ def main() -> None:
                 except Exception as e2:
                     log_exception(logger, e2)
                 sys.exit(1)
+            except Exception as e:
+                log_exception(logger, e)
+                sys.exit(1)
 
 
 if __name__ == "__main__":

{continuous_delivery_scripts-3.5.0 → continuous_delivery_scripts-4.0.0}/continuous_delivery_scripts/utils/git_helpers.py

@@ -39,14 +39,17 @@ class GitWrapper:
     def _git_url_ssh_to_https(self, url: str) -> str:
         """Changes repository URL to use authorisation token.
 
-        Converts the git url to use the GitHub token:
-        See https://github.blog/2012-09-21-easier-builds-and-deployments-using-git-over-https-and-oauth/
+        Converts the git url to use GitHub's token-based HTTPS authentication
+        format so workflow-generated tokens can be used for git operations.
+
+        Reference:
+        https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/about-authentication-to-github#githubs-token-formats
 
         Returns:
             new URL
         """
         path = url.split("github.com", 1)[1][1:].strip()
-        new = "https://{GITHUB_TOKEN}:x-oauth-basic@github.com/%s" % path
+        new = "https://x-access-token:{GITHUB_TOKEN}@github.com/%s" % path
         logger.info("rewriting git url to: %s" % new)
         return new.format(GITHUB_TOKEN=configuration.get_value(ConfigurationVariable.GIT_TOKEN))
 

{continuous_delivery_scripts-3.5.0 → continuous_delivery_scripts-4.0.0}/continuous_delivery_scripts/utils/news_file.py

@@ -7,6 +7,7 @@
 import enum
 import pathlib
 import logging
+import time
 from datetime import datetime
 from typing import Any, Optional
 
@@ -57,4 +58,6 @@ def _write_file(file_path: pathlib.Path, text: str) -> None:
 
 def determine_basic_new_news_file_name() -> str:
     """Returns a new news file name."""
-    return datetime.now().strftime("%Y%m%d%H%M%S")
+    now_ns = time.time_ns()
+    seconds, nanoseconds = divmod(now_ns, 1_000_000_000)
+    return f"{datetime.fromtimestamp(seconds):%Y%m%d%H%M%S}{nanoseconds:09d}"

{continuous_delivery_scripts-3.5.0 → continuous_delivery_scripts-4.0.0}/continuous_delivery_scripts/utils/third_party_licences.py

@@ -9,9 +9,9 @@ import re
 import json
 from dataclasses import dataclass
 from importlib.util import find_spec
-from license_expression import Licensing, LicenseExpression, OR
+from license_expression import Licensing, LicenseExpression, OR, get_spdx_licensing
 from pathlib import Path
-from typing import Iterable, cast, Optional, Iterator, List, Pattern, Any
+from typing import Dict, Iterable, cast, Optional, Iterator, List, Pattern, Any, Tuple
 
 from continuous_delivery_scripts.utils.configuration import (
     ConfigurationVariable,
@@ -57,10 +57,101 @@ LICENCE_NON_ACCEPTED_CHARACTERS = r"[^\w\s\.\:\-()]"
 def _get_spdx_licenses_path() -> Path:
     spec = find_spec("spdx")
     if not spec or not spec.origin:
-        raise ModuleNotFoundError("No module named 'spdx'")
+        raise FileNotFoundError("Could not find SPDX licenses.json")
     return Path(spec.origin).resolve().parent.joinpath("licenses.json")
 
 
+FALLBACK_LICENCE_DATA = {
+    "0BSD": {
+        "reference_number": "319",
+        "name": "BSD Zero Clause License",
+    },
+    "Apache-2.0": {
+        "reference_number": "26",
+        "name": "Apache License 2.0",
+    },
+    "GPL-3.0-only": {
+        "name": "GNU General Public License v3.0 only",
+    },
+    "MPL-2.0": {
+        "name": "Mozilla Public License 2.0",
+    },
+    "MIT": {
+        "name": "MIT License",
+    },
+    "PSF-2.0": {
+        "name": "Python Software Foundation License 2.0",
+    },
+    "Python-2.0": {
+        "name": "Python License 2.0",
+    },
+}
+
+
+FALLBACK_LICENCE_ALIASES = {
+    "0BSD": ["BSD", "BSD License", "BSD Zero Clause License"],
+    "Apache-2.0": [
+        "Apache",
+        "Apache 2",
+        "Apache 2.0",
+        "Apache License 2",
+        "Apache License 2.0",
+        "Apache License Version 2",
+        "Apache License Version 2.0",
+        "Apache License, Version 2",
+        "Apache License, Version 2.0",
+        "Apache Licence 2",
+        "Apache Licence 2.0",
+        "Apache Licence Version 2",
+        "Apache Licence Version 2.0",
+        "Apache Licence, Version 2",
+        "Apache Licence, Version 2.0",
+        "Apache Software License",
+    ],
+    "GPL-3.0-only": ["GPL 3", "GPL 3.0", "GPL-3.0", "GPL-3", "GNU GPL 3"],
+    "MIT": ["MIT License"],
+    "PSF-2.0": ["Python Software Foundation License 2.0"],
+    "Python-2.0": ["Python Software Foundation License"],
+}
+
+
+def _build_fallback_licence(identifier: str, is_deprecated: bool = False) -> Licence:
+    metadata = FALLBACK_LICENCE_DATA.get(identifier, {})
+    return Licence(
+        reference_number=str(metadata.get("reference_number", "")),
+        identifier=identifier,
+        name=str(metadata.get("name", identifier)),
+        is_deprecated=is_deprecated,
+        is_osi_approved=bool(metadata.get("is_osi_approved", True)),
+        url=f"http://spdx.org/licenses/{identifier}.json",
+        reference=f"./{identifier}.html",
+    )
+
+
+def _iter_fallback_licences() -> Iterable[Tuple[Licence, Iterable[str]]]:
+    spdx_licensing = get_spdx_licensing()
+    seen = set()
+    for symbol in spdx_licensing.known_symbols.values():
+        identifier = getattr(symbol, "key", None)
+        if not identifier or identifier in seen:
+            continue
+        if identifier.startswith("LicenseRef-") or getattr(symbol, "is_exception", False):
+            continue
+        seen.add(identifier)
+        aliases = list(getattr(symbol, "aliases", ())) + FALLBACK_LICENCE_ALIASES.get(identifier, [])
+        yield _build_fallback_licence(identifier, is_deprecated=bool(getattr(symbol, "is_deprecated", False))), aliases
+
+
+def _normalise_licence_text(text: str) -> str:
+    normalised_text = text.strip().lower()
+    normalised_text = re.sub(r"osi\s?approved[:]*", "", normalised_text)
+    normalised_text = re.sub(r"licen[cs]e", " ", normalised_text)
+    normalised_text = re.sub(r"version", " ", normalised_text)
+    normalised_text = re.sub(r"[^\w\s]", " ", normalised_text)
+    normalised_text = re.sub(r"\s+", " ", normalised_text)
+    return normalised_text.strip()
+
+
 def _parse_licence_expression(licensing: Licensing, licence_expression: str) -> LicenseExpression:
     # Removing any unwanted characters so that the expression follows the laws:
     # > the valid characters are: letters and numbers, underscore, dot, colon or hyphen signs and spaces
@@ -92,11 +183,17 @@ def iter_licenses(licence_info: dict) -> Iterable[Licence]:
 def _handle_special_licence_entries(cleansed_descriptor: str) -> str:
     if cleansed_descriptor in ["Python Software Foundation License"]:
         return "Python"
+    if re.fullmatch(r"Python(?:[\w\s\-\.]*)", cleansed_descriptor, re.IGNORECASE):
+        return "Python-2.0"
     if cleansed_descriptor in ["Apache Software License", "Apache", "apache"]:
         return "Apache-2.0"
     if cleansed_descriptor in ["LGPL", "UNKNOWN", "Dual License"]:
         # It is not possible to find which is the actual licence to consider.
         return UNKNOWN_LICENCE.identifier
+    if re.fullmatch(r"Apache(?:\s+(?:Software\s+)?)?(?:Licen[cs]e)?(?:,?\s+Version)?\s*2(?:\.0)?", cleansed_descriptor):
+        return "Apache-2.0"
+    if re.fullmatch(r"GPL\s*3(?:\.0)?", cleansed_descriptor, re.IGNORECASE):
+        return "GPL-3.0-only"
     return cleansed_descriptor
 
 
@@ -122,18 +219,32 @@ class OpenSourceLicences:
         self._licence_store: Optional[dict] = None
         self._licence_list: Optional[list] = None
 
+    def _store_licence(self, licence: Licence, aliases: Iterable[str] = ()) -> None:
+        if not self._licence_store or self._licence_list is None:
+            return
+        entries = [licence.identifier, licence.name, *aliases]
+        for entry in entries:
+            if not entry:
+                continue
+            self._licence_store[entry] = licence
+            self._licence_list.append(entry)
+
     def load(self) -> None:
         """Loads licence data from internal Json file."""
         if self._licence_list and self._licence_store:
             return
         self._licence_store = {UNKNOWN_LICENCE.identifier: UNKNOWN_LICENCE}
         self._licence_list = [UNKNOWN_LICENCE.identifier]
-        with open(_get_spdx_licenses_path(), "r", encoding="utf8") as f:
-            for licence in iter_licenses(json.load(f)):
-                self._licence_store[licence.identifier] = licence
-                self._licence_list.append(licence.identifier)
-                self._licence_store[licence.name] = licence
-                self._licence_list.append(licence.name)
+        try:
+            with open(_get_spdx_licenses_path(), "r", encoding="utf8") as f:
+                for licence in iter_licenses(json.load(f)):
+                    self._store_licence(licence)
+            return
+        except (FileNotFoundError, ModuleNotFoundError):
+            pass
+
+        for licence, aliases in _iter_fallback_licences():
+            self._store_licence(licence, aliases)
 
     def get_licences_from_pattern(self, licence_descriptor_pattern: Pattern) -> Optional[List[Licence]]:
         """Determines all the licences following a certain pattern."""
@@ -153,8 +264,23 @@ class OpenSourceLicences:
         if not self._licence_store or not self._licence_list or not licence_descriptor:
             return None
         cleansed_descriptor = cleanse_licence_descriptor(licence_descriptor)
-        likelihood, licence = determine_similar_string_from_list(cleansed_descriptor, self._licence_list)
-        return self._licence_store.get(licence) if likelihood > LICENCE_LIKELIHOOD_THRESHOLD else None
+        exact_match = self._licence_store.get(cleansed_descriptor)
+        if exact_match:
+            return cast(Licence, exact_match)
+
+        normalised_map: Dict[str, Licence] = {}
+        for name in self._licence_list:
+            licence = cast(Licence, self._licence_store.get(name))
+            if licence:
+                normalised_map[_normalise_licence_text(name)] = licence
+
+        normalised_descriptor = _normalise_licence_text(cleansed_descriptor)
+        normalised_exact_match = normalised_map.get(normalised_descriptor)
+        if normalised_exact_match:
+            return normalised_exact_match
+
+        likelihood, matched_key = determine_similar_string_from_list(normalised_descriptor, normalised_map.keys())
+        return normalised_map.get(matched_key) if likelihood > LICENCE_LIKELIHOOD_THRESHOLD else None
 
 
 OPENSOURCE_LICENCES = OpenSourceLicences()

{continuous_delivery_scripts-3.5.0 → continuous_delivery_scripts-4.0.0/continuous_delivery_scripts.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: continuous-delivery-scripts
-Version: 3.5.0
+Version: 4.0.0
 Summary: Continuous Delivery scripts to increase automation
 Home-page: https://github.com/ARMmbed/continuous-delivery-scripts
 Author: CMSIS team
@@ -11,19 +11,20 @@ Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Software Development :: Build Tools
-Requires-Python: >=3.8,<4
+Requires-Python: >=3.10,<4
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: setuptools
 Requires-Dist: gitpython
 Requires-Dist: towncrier==22.12.0
 Requires-Dist: pyautoversion~=1.2.0
-Requires-Dist: pdoc3==0.10.0
+Requires-Dist: pdoc3==0.11.6
 Requires-Dist: toml
 Requires-Dist: semver~=2.13.0
 Requires-Dist: python-dotenv
@@ -32,7 +33,7 @@ Requires-Dist: boto3
 Requires-Dist: detect-secrets[gibberish]==1.5.0
 Requires-Dist: packaging
 Requires-Dist: licenseheaders<0.8.9
-Requires-Dist: spdx-tools==0.6.1
+Requires-Dist: spdx-tools==0.8.5
 Requires-Dist: license-expression
 Requires-Dist: wcmatch
 Requires-Dist: jellyfish
@@ -141,6 +142,16 @@ Therefore, it installs the following tools which can be used anywhere within a p
 * `cd-generate-spdx`: Generates SPDX documents for the project (3rd party IP reporting/ OpenChain)
 * `cd-license-files`: Updates the Licence header and copyright to all the source code files
 
+For GitHub automation that performs authenticated clone or fetch operations, see [GitHub Token Authentication](#github-token-authentication).
+
+## GitHub Token Authentication
+
+When git operations need to retry against GitHub over HTTPS, this project now uses the credential layout `https://x-access-token:<token>@github.com/<owner>/<repo>.git`.
+
+This means the token is sent in the password position with `x-access-token` as the username, which is the format GitHub accepts for workflow-generated and other non-OAuth tokens used by automation.
+
+Older `https://<token>:x-oauth-basic@github.com/...` URLs were tied to OAuth-style credentials and could reject tokens created dynamically during CI/CD flows.
+
 ## Project Structure
 
 The follow described the major aspects of the project structure:

{continuous_delivery_scripts-3.5.0 → continuous_delivery_scripts-4.0.0}/continuous_delivery_scripts.egg-info/requires.txt

@@ -2,7 +2,7 @@ setuptools
 gitpython
 towncrier==22.12.0
 pyautoversion~=1.2.0
-pdoc3==0.10.0
+pdoc3==0.11.6
 toml
 semver~=2.13.0
 python-dotenv
@@ -11,7 +11,7 @@ boto3
 detect-secrets[gibberish]==1.5.0
 packaging
 licenseheaders<0.8.9
-spdx-tools==0.6.1
+spdx-tools==0.8.5
 license-expression
 wcmatch
 jellyfish

{continuous_delivery_scripts-3.5.0 → continuous_delivery_scripts-4.0.0}/setup.py

@@ -30,10 +30,11 @@ setup(
         "License :: OSI Approved :: Apache Software License",
         "Programming Language :: Python",
         "Programming Language :: Python :: 3 :: Only",
-        "Programming Language :: Python :: 3.8",
-        "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: 3.10",
         "Programming Language :: Python :: 3.11",
+        "Programming Language :: Python :: 3.12",
+        "Programming Language :: Python :: 3.13",
+        "Programming Language :: Python :: 3.14",
         "Topic :: Software Development :: Build Tools",
     ],
     description="Continuous Delivery scripts to increase automation",
@@ -61,7 +62,7 @@ setup(
         "towncrier==22.12.0",
         "pyautoversion~=1.2.0",
         # FIXME change when https://github.com/pdoc3/pdoc/issues/299 is fixed
-        "pdoc3==0.10.0",
+        "pdoc3==0.11.6",
         "toml",
         "semver~=2.13.0",
         "python-dotenv",
@@ -70,7 +71,7 @@ setup(
         "detect-secrets[gibberish]==1.5.0",
         "packaging",
         "licenseheaders<0.8.9",
-        "spdx-tools==0.6.1",
+        "spdx-tools==0.8.5",
         "license-expression",
         "wcmatch",
         "jellyfish",
@@ -82,7 +83,7 @@ setup(
     long_description=long_description,
     name=PROJECT_SLUG,
     packages=[SOURCE_DIR],
-    python_requires=">=3.8,<4",
+    python_requires=">=3.10,<4",
     url=f"https://github.com/ARMmbed/{PROJECT_SLUG}",
     version=__version__,
 )