continuous-delivery-scripts 3.4.1__tar.gz → 3.5.1__tar.gz

{continuous_delivery_scripts-3.4.1/continuous_delivery_scripts.egg-info → continuous_delivery_scripts-3.5.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: continuous-delivery-scripts
-Version: 3.4.1
+Version: 3.5.1
 Summary: Continuous Delivery scripts to increase automation
 Home-page: https://github.com/ARMmbed/continuous-delivery-scripts
 Author: CMSIS team
@@ -141,6 +141,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.4.1 → continuous_delivery_scripts-3.5.1}/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.4.1 → continuous_delivery_scripts-3.5.1}/continuous_delivery_scripts/_version.py

@@ -11,8 +11,8 @@ References
 This file is autogenerated, do not modify by hand.
 """
 
-__version__ = "3.4.1"
-COMMIT = "3cb7eefdafb8306ca4750f371325574e1a2ec9c7"
+__version__ = "3.5.1"
+COMMIT = "5f0dc45967d1e56a6e03168c0c9b54cc7aaa98c7"
 MAJOR = 3
-MINOR = 4
+MINOR = 5
 PATCH = 1

{continuous_delivery_scripts-3.4.1 → continuous_delivery_scripts-3.5.1}/continuous_delivery_scripts/plugins/golang.py

@@ -4,6 +4,7 @@
 #
 """Plugin for Golang projects."""
 
+import json
 import logging
 import os
 import shutil
@@ -143,24 +144,85 @@ def _call_goreleaser_check(version: str) -> None:
     check_call(_generate_goreleaser_check_command_list(), cwd=ROOT_DIR, env=env)
 
 
-def _determine_go_module_tag(version: str) -> Optional[str]:
-    """Determines go module for tagging.
-
-    See https://golang.org/ref/mod#vcs-version.
-    and https://github.com/golang/go/wiki/Modules#should-i-have-multiple-modules-in-a-single-repository.
-    """
-    module = ""
+def _determine_go_module_tag_for_directory(module_directory: Path, version: str) -> Optional[str]:
     try:
-        module = str(SRC_DIR.relative_to(ROOT_DIR))
+        module = module_directory.relative_to(ROOT_DIR)
     except ValueError:
         try:
-            module = str(ROOT_DIR.relative_to(SRC_DIR))
+            module = ROOT_DIR.relative_to(module_directory)
         except ValueError as exception:
             logger.warning(exception)
-    if module == "." or len(module) == 0:
+            return None
+    module_as_posix = module.as_posix().rstrip("/")
+    if module_as_posix == "." or len(module_as_posix) == 0:
         return None
-    module = module.rstrip("/")
-    return f"{module}/{version}"
+    return f"{module_as_posix}/{version}"
+
+
+def _find_go_work_files() -> List[Path]:
+    go_work_files: List[Path] = []
+    for go_work_file in [SRC_DIR.joinpath("go.work"), ROOT_DIR.joinpath("go.work")]:
+        if go_work_file.exists() and go_work_file not in go_work_files:
+            go_work_files.append(go_work_file)
+    return go_work_files
+
+
+def _determine_go_work_module_directories_from_json(go_work_file: Path) -> List[Path]:
+    """Determine module directories from `go work edit -json` output.
+
+    `go.work` lists all workspace modules that should be released together.
+    See https://go.dev/ref/mod#workspaces and https://pkg.go.dev/cmd/go#hdr-Edit_workspace_file.
+    """
+    go_work_root = go_work_file.parent
+    go_work = json.loads(check_output(["go", "work", "edit", "-json"], cwd=go_work_root, encoding="utf8"))
+    module_directories: List[Path] = []
+    for use_definition in go_work.get("Use", []):
+        disk_path = use_definition.get("DiskPath") or use_definition.get("Path")
+        if not disk_path:
+            continue
+        module_directory = Path(str(disk_path))
+        module_directories.append(
+            module_directory if module_directory.is_absolute() else go_work_root.joinpath(module_directory)
+        )
+    return module_directories
+
+
+def _determine_go_work_module_directories() -> List[Path]:
+    """Determine module directories declared in `go.work`.
+
+    `go.work` lists all workspace modules that should be released together.
+    See https://go.dev/ref/mod#workspaces.
+    """
+    module_directories: List[Path] = []
+    for go_work_file in _find_go_work_files():
+        module_directories.extend(_determine_go_work_module_directories_from_json(go_work_file))
+    return list(dict.fromkeys(module_directories))
+
+
+def _determine_go_subproject_directories() -> List[Path]:
+    if not SRC_DIR.exists():
+        return []
+    return sorted((go_mod_file.parent for go_mod_file in SRC_DIR.rglob("go.mod")), key=lambda path: str(path))
+
+
+def _determine_go_module_tag(version: str) -> List[str]:
+    """Determine all go module tags for release.
+
+    See https://golang.org/ref/mod#vcs-version,
+    https://go.dev/ref/mod#workspaces, and
+    https://github.com/golang/go/wiki/Modules/a549b3e4b7ad6be6e7d11c37ef247bb2279c8146#faqs--multi-module-repositories.
+    """
+    module_directories = [SRC_DIR]
+    go_work_module_directories = _determine_go_work_module_directories()
+    if go_work_module_directories:
+        module_directories.extend(go_work_module_directories)
+    else:
+        module_directories.extend(_determine_go_subproject_directories())
+
+    tags = [
+        _determine_go_module_tag_for_directory(module_directory, version) for module_directory in module_directories
+    ]
+    return list(dict.fromkeys([tag for tag in tags if tag]))
 
 
 class Go(BaseLanguage):
@@ -209,7 +271,7 @@ class Go(BaseLanguage):
             r".*go\.sum$",
             r"^\.circleci[\\/].*",
             r"^workflows/.*",
-            r"^\.github[\\/]workflows[\\/].*",
+            (r"^\.github[\\/]workflows[\\/].*"),
         ]
 
     def get_current_spdx_project(self) -> Optional["SpdxProject"]:
@@ -224,8 +286,7 @@ class Go(BaseLanguage):
     def tag_release(self, git: GitWrapper, version: str, shortcuts: Dict[str, bool]) -> None:
         """Tags release commit."""
         super().tag_release(git, version, shortcuts)
-        go_tag = _determine_go_module_tag(self.get_version_tag(version))
-        if go_tag:
+        for go_tag in _determine_go_module_tag(self.get_version_tag(version)):
             git.create_tag(go_tag, message=f"Golang module release: {go_tag}")
 
     def _call_goreleaser_release(self, version: str) -> None:

{continuous_delivery_scripts-3.4.1 → continuous_delivery_scripts-3.5.1}/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))
 
@@ -808,6 +811,7 @@ class GitTempClone:
         Tempfiles objects on Windows are holding references to open files until
         they are collected by the garbage collector, thus preventing deletion.
         """
+        self._clone.repo.close()
         self._repo.repo.close()
         self._temporary_dir.cleanup()
 

{continuous_delivery_scripts-3.4.1 → continuous_delivery_scripts-3.5.1/continuous_delivery_scripts.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: continuous-delivery-scripts
-Version: 3.4.1
+Version: 3.5.1
 Summary: Continuous Delivery scripts to increase automation
 Home-page: https://github.com/ARMmbed/continuous-delivery-scripts
 Author: CMSIS team
@@ -141,6 +141,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: