Merge pull request #21 from vsoch/add/action-updater

add updater for action.yml files

Author: vsoch

CHANGELOG.md

@@ -14,6 +14,7 @@ and **Merged pull requests**. Critical items to know are:
 The versions coincide with releases on pip. Only major versions will be released as tags on Github.
 
 ## [0.0.x](https://github.com/rse-ops/actions-updater/tree/main) (0.0.x)
+ - add support for updating action.yml (with composite action) (0.0.15)
  - add line_length parameter to settings (0.0.14)
  - enforce fallback to use major versions still enforces commit (0.0.13)
  - bug fix to version updater (0.0.12)

action_updater/main/action.py

@@ -28,6 +28,21 @@ def __init__(self, filename):
     def jobs(self):
         return self.changes.get("jobs")
 
+    @property
+    def runs(self):
+        return self.changes.get("runs")
+
+    @property
+    def steps(self):
+        if self.jobs:
+            for _, job in self.jobs.items():
+                for step in job.get("steps", []):
+                    yield step
+
+        elif self.runs:
+            for step in self.runs.get("steps", []):
+                yield step
+
     def write(self, path, line_length=None):
         """
         Save the action to file.

action_updater/main/schemas.py

@@ -8,6 +8,54 @@
 
 schema_url = "http://json-schema.org/draft-07/schema"
 
+steps = {
+    "description": "A job contains a sequence of tasks called steps. Steps can run commands, run setup tasks, or run an action in your repository, a public repository, or an action published in a Docker registry. Not all steps run actions, but all actions are run as a step. Each step runs in its own process in the virtual environment and has access to the workspace and filesystem. Because steps are run in their own process, changes to environment variables are not preserved between steps. GitHub provides built-in steps to set up and complete a job.",
+    "type": "array",
+    "items": {
+        "type": "object",
+        "properties": {
+            "name": {
+                "description": "A name for your step to display on GitHub.",
+                "type": "string",
+            },
+            "uses": {
+                "description": "Selects an action to run as part of a step in your job. An action is a reusable unit of code. You can use an action defined in the same repository as the workflow, a public repository, or in a published Docker container image.",
+                "type": "string",
+            },
+            "with": {
+                "type": "object",
+                "description": "A map of the input parameters defined by the action. Each input parameter is a key/value pair. Input parameters are set as environment variables. The variable is prefixed with INPUT_ and converted to upper case.",
+                "addtionalProperties": {"type": "string"},
+            },
+            "env": {
+                "type": "object",
+                "description": "Sets environment variables for steps to use in the virtual environment. Public actions may specify expected environment variables in the README file. If you are setting a secret in an environment variable, you must set secrets using the secrets context.",
+                "addtionalProperties": {"type": "string"},
+            },
+            "if": {
+                "description": "Identifies any steps that must complete successfully before this step will run. It can be a string or an array of strings. If a step fails, all steps that need it will also fail unless the steps use a conditional statement that causes the step to continue.",
+                "type": "string",
+            },
+            "run": {
+                "description": "Runs command line programs using the operating system's shell. If you do not provide a name, the step name will default to the run command. Commands run using non-login shells by default.",
+                "type": "string",
+            },
+            "working-directory": {
+                "description": "The default directory that the action uses in a job's workspace.",
+                "type": "string",
+            },
+            "continue-on-error": {
+                "description": "Prevents a job from failing when a step fails. Set to true to allow a job to pass when this step fails.",
+                "type": "boolean",
+            },
+            "timeout-minutes": {
+                "description": "The maximum number of minutes to let a workflow run before GitHub automatically cancels it.",
+                "type": "number",
+            },
+        },
+    },
+}
+
 workflow_schema = {
     "title": "Github workflow file - https://help.github.com/en/articles/workflow-syntax-for-github-actions",
     "$schema": schema_url,
@@ -77,62 +125,18 @@
                         "default": "ubuntu-latest",
                         "enum": [
                             "ubuntu-latest",
+                            "ubuntu-22.04",
+                            "ubuntu-20.04",
                             "ubuntu-18.04",
-                            "ubuntu-16.04",
                             "windows-latest",
                             "windows-2019",
-                            "windows-2016",
-                            "macOS-latest",
-                            "macOS-10.14",
+                            "windows-2022",
+                            "macos-latest",
+                            "macos-12",
+                            "macos-11",
                         ],
                     },
-                    "steps": {
-                        "description": "A job contains a sequence of tasks called steps. Steps can run commands, run setup tasks, or run an action in your repository, a public repository, or an action published in a Docker registry. Not all steps run actions, but all actions are run as a step. Each step runs in its own process in the virtual environment and has access to the workspace and filesystem. Because steps are run in their own process, changes to environment variables are not preserved between steps. GitHub provides built-in steps to set up and complete a job.",
-                        "type": "array",
-                        "items": {
-                            "type": "object",
-                            "properties": {
-                                "name": {
-                                    "description": "A name for your step to display on GitHub.",
-                                    "type": "string",
-                                },
-                                "uses": {
-                                    "description": "Selects an action to run as part of a step in your job. An action is a reusable unit of code. You can use an action defined in the same repository as the workflow, a public repository, or in a published Docker container image.",
-                                    "type": "string",
-                                },
-                                "with": {
-                                    "type": "object",
-                                    "description": "A map of the input parameters defined by the action. Each input parameter is a key/value pair. Input parameters are set as environment variables. The variable is prefixed with INPUT_ and converted to upper case.",
-                                    "addtionalProperties": {"type": "string"},
-                                },
-                                "env": {
-                                    "type": "object",
-                                    "description": "Sets environment variables for steps to use in the virtual environment. Public actions may specify expected environment variables in the README file. If you are setting a secret in an environment variable, you must set secrets using the secrets context.",
-                                    "addtionalProperties": {"type": "string"},
-                                },
-                                "if": {
-                                    "description": "Identifies any steps that must complete successfully before this step will run. It can be a string or an array of strings. If a step fails, all steps that need it will also fail unless the steps use a conditional statement that causes the step to continue.",
-                                    "type": "string",
-                                },
-                                "run": {
-                                    "description": "Runs command line programs using the operating system's shell. If you do not provide a name, the step name will default to the run command. Commands run using non-login shells by default.",
-                                    "type": "string",
-                                },
-                                "working-directory": {
-                                    "description": "The default directory that the action uses in a job's workspace.",
-                                    "type": "string",
-                                },
-                                "continue-on-error": {
-                                    "description": "Prevents a job from failing when a step fails. Set to true to allow a job to pass when this step fails.",
-                                    "type": "boolean",
-                                },
-                                "timeout-minutes": {
-                                    "description": "The maximum number of minutes to let a workflow run before GitHub automatically cancels it.",
-                                    "type": "number",
-                                },
-                            },
-                        },
-                    },
+                    "steps": steps,
                 },
             },
         },
@@ -164,6 +168,29 @@
     "code_theme": {"type": "string", "choices": list(get_all_styles())},
 }
 
+action = {
+    "$schema": schema_url,
+    "title": "action.yml Schema",
+    "type": "object",
+    "required": [
+        "name",
+        "description",
+        "runs",
+    ],
+    "properties": {
+        "name": {"type": "string"},
+        "description": {"type": "string"},
+        "runs": {
+            "type": "object",
+            "properties": {
+                "using": {"type": "string"},
+                "steps": steps,
+            },
+        },
+    },
+    "additionalProperties": True,
+}
+
 settings = {
     "$schema": schema_url,
     "title": "Settings Schema",

action_updater/main/updaters/savestate/update.py

@@ -19,24 +19,23 @@ def detect(self, action):
         self.count = 0
 
         # No point if we don't have jobs!
-        if not action.jobs:
+        if not action.steps:
             return False
 
         # For each job, look for steps->updater versions
-        for _, job in action.jobs.items():
-            for step in job.get("steps", []):
+        for step in action.steps:
 
-                # We are primarily interested in uses
-                if "run" not in step:
-                    continue
+            # We are primarily interested in uses
+            if "run" not in step:
+                continue
 
-                # Update step run lines
-                updated_lines = update_lines(step["run"], "save-state", "$GITHUB_STATE")
+            # Update step run lines
+            updated_lines = update_lines(step["run"], "save-state", "$GITHUB_STATE")
 
-                # Keep track of change counts
-                if updated_lines != step["run"]:
-                    self.count += 1
+            # Keep track of change counts
+            if updated_lines != step["run"]:
+                self.count += 1
 
-                step["run"] = updated_lines
+            step["run"] = updated_lines
 
         return self.count != 0

action_updater/main/updaters/setenv/update.py

@@ -19,23 +19,22 @@ def detect(self, action):
         self.count = 0
 
         # No point if we don't have jobs!
-        if not action.jobs:
+        if not action.steps:
             return False
 
         # For each job, look for steps->updater versions
-        for _, job in action.jobs.items():
-            for step in job.get("steps", []):
+        for step in action.steps:
 
-                # We are primarily interested in uses
-                if "run" not in step:
-                    continue
+            # We are primarily interested in uses
+            if "run" not in step:
+                continue
 
-                # Update step run lines
-                updated_lines = update_lines(step["run"], "set-env", "$GITHUB_ENV")
+            # Update step run lines
+            updated_lines = update_lines(step["run"], "set-env", "$GITHUB_ENV")
 
-                # Keep track of change counts
-                if updated_lines != step["run"]:
-                    self.count += 1
-                step["run"] = updated_lines
+            # Keep track of change counts
+            if updated_lines != step["run"]:
+                self.count += 1
+            step["run"] = updated_lines
 
         return self.count != 0

action_updater/main/updaters/setoutput/update.py

@@ -49,24 +49,23 @@ def detect(self, action):
         self.count = 0
 
         # No point if we don't have jobs!
-        if not action.jobs:
+        if not action.steps:
             return False
 
         # For each job, look for steps->updater versions
-        for _, job in action.jobs.items():
-            for step in job.get("steps", []):
+        for step in action.steps:
 
-                # We are primarily interested in uses
-                if "run" not in step:
-                    continue
+            # We are primarily interested in uses
+            if "run" not in step:
+                continue
 
-                # Update step run lines (returns parsed again together)
-                updated_lines = update_lines(step["run"])
+            # Update step run lines (returns parsed again together)
+            updated_lines = update_lines(step["run"])
 
-                # Keep track of change counts
-                if updated_lines != step["run"]:
-                    self.count += 1
+            # Keep track of change counts
+            if updated_lines != step["run"]:
+                self.count += 1
 
-                step["run"] = updated_lines
+            step["run"] = updated_lines
 
         return self.count != 0

action_updater/main/updaters/version/update.py

@@ -30,65 +30,64 @@ def detect(self, action):
         self.count = 0
 
         # No point if we don't have jobs!
-        if not action.jobs:
+        if not action.steps:
             return False
 
         # We will use major versions for these orgs (trusted)
         trusted_orgs = self.settings.get("major_orgs")
 
         # For each job, look for steps->updater versions
-        for _, job in action.jobs.items():
-            for step in job.get("steps", []):
+        for step in action.steps:
 
-                # We are primarily interested in uses
-                if "uses" not in step:
-                    continue
+            # We are primarily interested in uses
+            if "uses" not in step:
+                continue
 
-                repo = step["uses"]
+            repo = step["uses"]
 
-                # If we have a local action, nothing to update
-                if repo.startswith("./"):
-                    continue
+            # If we have a local action, nothing to update
+            if repo.startswith("./"):
+                continue
 
-                # Get the current tag or version (we will want to maintain this convention)
-                # Create a lookup based on the ref
-                repo, _ = repo.split("@")
-                org, _ = repo.split("/", 1)
+            # Get the current tag or version (we will want to maintain this convention)
+            # Create a lookup based on the ref
+            repo, _ = repo.split("@")
+            org, _ = repo.split("/", 1)
 
-                # Retrieve all tags for the repository, a lookup by tag name
-                tags = self.cache["tags"].get(repo) or self.get_tags_lookup(repo)
+            # Retrieve all tags for the repository, a lookup by tag name
+            tags = self.cache["tags"].get(repo) or self.get_tags_lookup(repo)
 
-                updated = None
-                if trusted_orgs and org in trusted_orgs:
-                    updated = self.get_major_tag(tags)
+            updated = None
+            if trusted_orgs and org in trusted_orgs:
+                updated = self.get_major_tag(tags)
 
-                if not updated:
-                    updated = self.get_tagged_commit(tags)
+            if not updated:
+                updated = self.get_tagged_commit(tags)
 
-                # If we don't have tags by this point, no go - we cannot parse
-                if not updated:
-                    continue
-                updated = f"{repo}@{updated}"
-                previous = step["uses"]
+            # If we don't have tags by this point, no go - we cannot parse
+            if not updated:
+                continue
+            updated = f"{repo}@{updated}"
+            previous = step["uses"]
 
-                # If we added a new comment, update the old one
-                if "#" in updated:
-                    updated, comment = updated.split("#", 1)
-                    comment = comment.strip()
-                    step["uses"] = updated.strip()
+            # If we added a new comment, update the old one
+            if "#" in updated:
+                updated, comment = updated.split("#", 1)
+                comment = comment.strip()
+                step["uses"] = updated.strip()
 
-                    # TODO some check to preserve other previous comments?
-                    step.ca.items["uses"] = [None, None, None, None]
+                # TODO some check to preserve other previous comments?
+                step.ca.items["uses"] = [None, None, None, None]
 
-                    # Add the end of line comment (third position in list)
-                    step.yaml_add_eol_comment(f"# {comment}\n", "uses", column=0)
+                # Add the end of line comment (third position in list)
+                step.yaml_add_eol_comment(f"# {comment}\n", "uses", column=0)
 
-                # Always do the update (regardless of comment!)
-                step["uses"] = updated.strip()
+            # Always do the update (regardless of comment!)
+            step["uses"] = updated.strip()
 
-                # Do we have a change?
-                if step["uses"] != previous:
-                    self.count += 1
+            # Do we have a change?
+            if step["uses"] != previous:
+                self.count += 1
 
         return self.count != 0