feat: add subcommand update-actions

Author: Sven Siegmund

pyproject.toml

@@ -21,6 +21,7 @@ dependencies = [
     "gitpython>=3.1.45",
     "importlib-resources>=5.10 ; python_full_version < '3.12'",
     "platformdirs>=4.4.0",
+    "requests>=2.32.5",
     "ruamel-yaml>=0.18.15",
     "semver>=3.0.4",
     "tomli-w>=1.2.0",

src/ci_starter/__init__.py

@@ -2,12 +2,16 @@
 from importlib.metadata import version as get_version
 from logging import getLogger
 from pathlib import Path
+from typing import TYPE_CHECKING
 
 from .constants import BASE_WORKFLOW_ASSET_PATH, HELPER_SCRIPT_ASSET_PATH
 from .git_helpers import get_repo_name
 from .presets import DISTRIBUTION_ARTIFACTS_DIR, LOCKFILE_ARTIFACT
 from .semantic_release_config import SemanticReleaseConfiguration
-from .utils import from_yaml, get_asset
+from .utils import dump, from_yaml, get_actions, get_asset, update_step_data
+
+if TYPE_CHECKING:
+    from .action import Action
 
 __version__ = get_version(__package__)
 
@@ -45,4 +49,17 @@ def generate_reusable_workflow(asset_path: Path) -> dict:
 
 
 def update_actions(workflows_path: Path) -> None:
-    pass
+    actions: dict[str, Action] = {}
+
+    for file in workflows_path.rglob("*.yml"):
+        data = from_yaml(file)
+
+        for action in get_actions(data):
+            if action.name not in actions:
+                action.update()
+                actions[action.name] = action
+            updated_action = actions[action.name]
+
+            data = update_step_data(data, updated_action)
+
+        dump(data, file)

src/ci_starter/action.py

@@ -1,26 +1,32 @@
+from os import getenv
 from re import compile
 from typing import Self
 
-from semver import VersionInfo
+from requests import get
+from semver.version import Version
 
 from .errors import ActionNotParsableError
 
 
 class Action:
     PATTERN = compile(r"(?P<owner>[\w_-]+)/(?P<repo>[\w_-]+)@(?P<commit>[\S]+)")
+    TOKEN = getenv("CI_STARTER_GH_API_TOKEN")
 
-    def __init__(self, owner: str, repo: str, commit: str, version: VersionInfo | None = None) -> None:
+    def __init__(self, owner: str, repo: str, commit: str, version: Version | None = None) -> None:
         self.owner: str = owner
         self.repo: str = repo
         self.commit: str = commit
-        self.version: VersionInfo = version
+        self.version: Version = version
 
-    def to_text(self):
-        text = f"{self.owner}/{self.repo}@{self.commit}"
-        return text
+    @property
+    def name(self) -> str:
+        return f"{self.owner}/{self.repo}"
+
+    def to_text(self) -> str:
+        return f"{self.name}@{self.commit}"
 
     @classmethod
-    def from_text(cls, text: str, version: VersionInfo | None = None) -> Self:
+    def from_text(cls, text: str, version: Version | None = None) -> Self:
         match = cls.PATTERN.search(text)
         if not match:
             raise ActionNotParsableError(text)
@@ -29,9 +35,46 @@ def from_text(cls, text: str, version: VersionInfo | None = None) -> Self:
 
         return action
 
+    def update(self) -> None:
+        response = get(self.url, headers=self.header)
+        if not response.ok:
+            response.raise_for_status()
+
+        data = response.json()
+        current_release = data[0]
+
+        current_version = current_release["name"].removeprefix("v")
+        current_commit = current_release["commit"]["sha"]
+
+        self.version = Version.parse(current_version)
+        self.commit = current_commit
+
+    def update_from_other(self, other: Self) -> None:
+        if not self.name == other.name:
+            raise ValueError(
+                f"can update only from an {self.__class__.__name__} "
+                f"of name '{self.name}', not '{other.name}'"
+            )
+        self.commit = other.commit
+        self.version = other.version
+
+    @property
+    def url(self) -> str:
+        return f"https://api.github.com/repos/{self.owner}/{self.repo}/tags"
+
+    @property
+    def header(self) -> dict[str, str]:
+        result = {
+            "User-Agent": __package__,
+            "Accept": "application.vnd.github+json",
+        }
+        if self.TOKEN:
+            result.update(Authorization=f"token {self.TOKEN}")
+        return result
+
     def __repr__(self) -> str:
         string = (
-            f"{self.__class__.__name__}(user={self.user}, repo={self.repo}, "
+            f"{self.__class__.__name__}(owner={self.owner}, repo={self.repo}, "
             f"commit={self.commit}, version={self.version})"
         )
         return string

src/ci_starter/utils.py

@@ -1,7 +1,7 @@
 from collections.abc import Iterable, Mapping
 from pathlib import Path
 from sys import version_info
-from typing import TYPE_CHECKING, TextIO
+from typing import TYPE_CHECKING, Any, TextIO
 
 from ruamel.yaml import YAML as Yaml
 
@@ -39,7 +39,7 @@ def step_yaml() -> Yaml:
     return yaml
 
 
-def from_yaml(s: str) -> dict:
+def from_yaml(s: str | Path) -> dict:
     yaml = step_yaml()
     obj = yaml.load(s)
     return obj
@@ -62,3 +62,24 @@ def get_actions(workflow: Mapping) -> Iterable[Action]:
             yield from get_actions_from_list(v)
         elif isinstance(v, Mapping):
             yield from get_actions(v)
+
+
+def get_steps_from_list(lst: list) -> Iterable[Step]:
+    for item in lst:
+        if isinstance(item, Step):
+            yield item
+
+
+def get_steps(workflow: Mapping) -> Iterable[Step]:
+    for v in workflow.values():
+        if isinstance(v, list):
+            yield from get_steps_from_list(v)
+        elif isinstance(v, Mapping):
+            yield from get_steps(v)
+
+
+def update_step_data(data: Mapping[str, Any], action: Action) -> dict[str, Any]:
+    for step in get_steps(data):
+        if step.uses.name == action.name:
+            step.uses = action
+    return data