fix(gha): Update GitHub Actions Workflow Schema #5742 (#5759)

* add run-name to github actions schema * remove unsupported check_suite event types * remove unsupported member event type * remove unsupported project updated event type * move run-name into existing test resrouce
bridgecrewio · Nov 21, 2023 · 21375fa · 21375fa
1 parent 3dbc9fa
commit 21375fa
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 18 deletions.
diff --git a/checkov/github_actions/schemas.py b/checkov/github_actions/schemas.py
@@ -1579,6 +1579,11 @@
             "description": "The name of your workflow. GitHub displays the names of your workflows on your repository's actions page. If you omit this field, GitHub sets the name to the workflow's filename.",
             "type": "string"
         },
+        "run-name": {
+            "$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#run-name",
+            "description": "A name for your workflow run. You can use the name to filter job runs in the dashboard and in the REST API.",
+            "type": "string"
+        },
         "on": {
             "$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#on",
             "description": "The name of the GitHub event that triggers the workflow. You can provide a single event string, array of events, array of event types, or an event configuration map that schedules a workflow or restricts the execution of a workflow to specific files, tags, or branch changes. For a list of available events, see https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows.",
@@ -1645,7 +1650,7 @@
                                     "$ref": "#/definitions/types",
                                     "items": {
                                         "type": "string",
-                                        "enum": ["completed", "requested", "rerequested"]
+                                        "enum": ["completed"]
                                     },
                                     "default": ["completed", "requested", "rerequested"]
                                 }
@@ -1818,21 +1823,6 @@
                                 }
                             }
                         },
-                        "member": {
-                            "$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#member-event-member",
-                            "$ref": "#/definitions/eventObject",
-                            "description": "Runs your workflow anytime the member event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/repos/collaborators/.",
-                            "properties": {
-                                "types": {
-                                    "$ref": "#/definitions/types",
-                                    "items": {
-                                        "type": "string",
-                                        "enum": ["added", "edited", "deleted"]
-                                    },
-                                    "default": ["added", "edited", "deleted"]
-                                }
-                            }
-                        },
                         "merge_group": {
                             "$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#merge_group",
                             "$ref": "#/definitions/eventObject",
@@ -1885,7 +1875,6 @@
                                         "type": "string",
                                         "enum": [
                                             "created",
-                                            "updated",
                                             "closed",
                                             "reopened",
                                             "edited",
@@ -1894,7 +1883,6 @@
                                     },
                                     "default": [
                                         "created",
-                                        "updated",
                                         "closed",
                                         "reopened",
                                         "edited",

diff --git a/tests/github_actions/resources/.github/workflows/suspectcurl.yaml b/tests/github_actions/resources/.github/workflows/suspectcurl.yaml
@@ -1,4 +1,5 @@
 name: CI
+run-name: "Setting run name ${{ github.ref_name }}"
 
 # Controls when the workflow will run
 on: