actions/languageservices
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update schema with descriptions

Browse Source
This commit is contained in:
Christopher Schleiden
2023-01-13 11:27:20 -08:00
parent c0fc4312f5
commit 5a4b6219ff
1 changed files with 126 additions and 125 deletions
Download Patch File Download Diff File Expand all files Collapse all files
actions-workflow-parser/src/workflow-v1.0.json
+126 -125
View File
@@ -41,7 +41,7 @@
}
},
"workflow-name": {
"description": "The name of the workflow.",
"description": "The name of the workflow that GitHub displays on your repository's 'Actions' tab.\n\n[Documentation](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#name)",
"string": {}
},
"run-name": {
@@ -51,10 +51,10 @@
"vars"
],
"string": {},
"description": "The name for workflow runs generated from the workflow. GitHub displays the workflow run name in the list of workflow runs on your repository's 'Actions' tab."
"description": "The name for workflow runs generated from the workflow. GitHub displays the workflow run name in the list of workflow runs on your repository's 'Actions' tab.\n\n[Documentation](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#run-name)"
},
"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.",
"description": "The GitHub event that triggers the workflow. Events can be a single 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. View a full list of [events that trigger workflows](https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\n\n[Documentation](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on)",
"one-of": [
"string",
"sequence",
@@ -71,7 +71,7 @@
}
},
"on-strict": {
"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.",
"description": "The GitHub event that triggers the workflow. Events can be a single 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. View a full list of [events that trigger workflows](https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\n\n[Documentation](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on)",
"one-of": [
"on-string-strict",
"on-sequence-strict",
@@ -79,7 +79,7 @@
]
},
"on-mapping-strict": {
"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.",
"description": "The GitHub event that triggers the workflow. Events can be a single 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. View a full list of [events that trigger workflows](https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\n\n[Documentation](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on)",
"mapping": {
"properties": {
"branch_protection_rule": "branch-protection-rule",
@@ -187,7 +187,7 @@
}
},
"branch-protection-rule-activity": {
"description": "The types of branch protection rule activity that trigger the workflow. Can be one or more of: created, edited, deleted.",
"description": "The types of branch protection rule activity that trigger the workflow. Supported activity types: `created`, `edited`, `deleted`.",
"one-of": [
"branch-protection-rule-activity-type",
"branch-protection-rule-activity-types"
@@ -226,7 +226,7 @@
}
},
"check-run-activity": {
"description": "The types of check run activity that trigger the workflow. Can be one or more of: completed, requested, rerequested, or requested-action.",
"description": "The types of check run activity that trigger the workflow. Supported activity types: `created`, `rerequested`, `completed`, `requested_action`.",
"one-of": [
"check-run-activity-type",
"check-run-activity-types"
@@ -266,10 +266,10 @@
}
},
"check-suite-activity": {
"description": "The types of check suite activity that trigger the workflow. Currently only completed is supported.",
"description": "The types of check suite activity that trigger the workflow. Supported activity types: `completed`.",
"one-of": [
"check-suite-activity-type",
"check-suite-activity-types"
"check-suite-activity-type",
"check-suite-activity-types"
]
},
"check-suite-activity-types": {
@@ -323,13 +323,13 @@
"null": {}
},
"discussion-string": {
"description": "Runs your workflow when a discussion in the workflow's repository is created or modified. For activity related to comments on a discussion, use the discussion_comment event.",
"description": "Runs your workflow when a discussion in the workflow's repository is created or modified. For activity related to comments on a discussion, use the `discussion_comment` event.",
"string": {
"constant": "discussion"
}
},
"discussion": {
"description": "Runs your workflow when a discussion in the workflow's repository is created or modified. For activity related to comments on a discussion, use the discussion_comment event.",
"description": "Runs your workflow when a discussion in the workflow's repository is created or modified. For activity related to comments on a discussion, use the `discussion_comment` event.",
"one-of": [
"null",
"discussion-mapping"
@@ -343,7 +343,7 @@
}
},
"discussion-activity": {
"description": "The types of discussion activity that trigger the workflow. Can be one or more of: created, edited, deleted, transferred, pinned, unpinned, labeled, unlabeled, locked, unlocked, category_changed, answered, or unanswered.",
"description": "The types of discussion activity that trigger the workflow. Supported activity types: `created`, `edited`, `deleted`, `transferred`, `pinned`, `unpinned`, `labeled`, `unlabeled`, `locked`, `unlocked`, `category_changed`, `answered`, `unanswered`.",
"one-of": [
"discussion-activity-type",
"discussion-activity-types"
@@ -372,13 +372,13 @@
]
},
"discussion-comment-string": {
"description": "Runs your workflow when a comment on a discussion in the workflow's repository is created or modified. For activity related to a discussion as opposed to comments on the discussion, use the discussion event.",
"description": "Runs your workflow when a comment on a discussion in the workflow's repository is created or modified. For activity related to a discussion as opposed to comments on the discussion, use the `discussion` event.",
"string": {
"constant": "discussion_comment"
}
},
"discussion-comment": {
"description": "Runs your workflow when a comment on a discussion in the workflow's repository is created or modified. For activity related to a discussion as opposed to comments on the discussion, use the discussion event.",
"description": "Runs your workflow when a comment on a discussion in the workflow's repository is created or modified. For activity related to a discussion as opposed to comments on the discussion, use the `discussion` event.",
"one-of": [
"null",
"discussion-comment-mapping"
@@ -392,7 +392,7 @@
}
},
"discussion-comment-activity": {
"description": "The types of discussion comment activity that trigger the workflow. Can be one or more of: created, edited, or deleted.",
"description": "The types of discussion comment activity that trigger the workflow. Supported activity types: `created`, `edited`, `deleted`.",
"one-of": [
"discussion-comment-activity-type",
"discussion-comment-activity-types"
@@ -451,7 +451,7 @@
}
},
"issue-comment-activity": {
"description": "The types of issue comment activity that trigger the workflow. Can be one or more of: created, edited, or deleted.",
"description": "The types of issue comment activity that trigger the workflow. Supported activity types: `created`, `edited`, `deleted`.",
"one-of": [
"issue-comment-activity-type",
"issue-comment-activity-types"
@@ -470,13 +470,13 @@
]
},
"issues-string": {
"description": "Runs your workflow when an issue or pull request comment is created, edited, or deleted.",
"description": "Runs your workflow when an issue in the workflow's repository is created or modified. For activity related to comments in an issue, use the `issue_comment` event.",
"string": {
"constant": "issues"
}
},
"issues": {
"description": "Runs your workflow when an issue or pull request comment is created, edited, or deleted.",
"description": "Runs your workflow when an issue in the workflow's repository is created or modified. For activity related to comments in an issue, use the `issue_comment` event.",
"one-of": [
"null",
"issues-mapping"
@@ -490,7 +490,7 @@
}
},
"issues-activity": {
"description": "The types of issue activity that trigger the workflow. Can be one or more of: opened, edited, deleted, transferred, pinned, unpinned, closed, reopened, assigned, unassigned, labeled, unlabeled, locked, unlocked, milestoned, or demilestoned.",
"description": "The types of issue activity that trigger the workflow. Supported activity types: `opened`, `edited`, `deleted`, `transferred`, `pinned`, `unpinned`, `closed`, `reopened`, `assigned`, `unassigned`, `labeled`, `unlabeled`, `locked`, `unlocked`, `milestoned`, `demilestoned`.",
"one-of": [
"issues-activity-type",
"issues-activity-types"
@@ -542,7 +542,7 @@
}
},
"label-activity": {
"description": "The types of label activity that trigger the workflow. Can be one or more of: created, edited, or deleted.",
"description": "The types of label activity that trigger the workflow. Supported activity types: `created`, `edited`, `deleted`.",
"one-of": [
"label-activity-type",
"label-activity-types"
@@ -581,7 +581,7 @@
}
},
"merge-group-activity": {
"description": "The types of label activity that trigger the workflow. Currently only checks_requested is supported.",
"description": "The types of merge group activity that trigger the workflow. Supported activity types: `checks_requested`.",
"one-of": [
"merge-group-activity-type",
"merge-group-activity-types"
@@ -618,7 +618,7 @@
}
},
"milestone-activity": {
"description": "The types of milestone activity that trigger the workflow. Can be one or more of: created, edited, opened, closed, or deleted.",
"description": "The types of milestone activity that trigger the workflow. Supported activity types: `created`, `closed`, `opened`, `edited`, `deleted`.",
"one-of": [
"milestone-activity-type",
"milestone-activity-types"
@@ -649,13 +649,13 @@
"null": {}
},
"project-string": {
"description": "Runs your workflow when a project board is created or modified. For activity related to cards or columns in a project board, use the project_card or project_column events instead.",
"description": "Runs your workflow when a project board is created or modified. For activity related to cards or columns in a project board, use the `project_card` or `project_column` events instead.",
"string": {
"constant": "project"
}
},
"project": {
"description": "Runs your workflow when a project board is created or modified. For activity related to cards or columns in a project board, use the project_card or project_column events instead.",
"description": "Runs your workflow when a project board is created or modified. For activity related to cards or columns in a project board, use the `project_card` or `project_column` events instead.",
"one-of": [
"null",
"project-mapping"
@@ -669,7 +669,7 @@
}
},
"project-activity": {
"description": "The types of project activity that trigger the workflow. Can be one or more of: created, edited, opened, closed, or deleted.",
"description": "The types of project activity that trigger the workflow. Supported activity types: `created`, `closed`, `reopened`, `edited`, `deleted`.",
"one-of": [
"project-activity-type",
"project-activity-types"
@@ -684,19 +684,19 @@
"allowed-values": [
"created",
"closed",
"opened",
"reopened",
"edited",
"deleted"
]
},
"project-card-string": {
"description": "Runs your workflow when a card on a project board is created or modified. For activity related to project boards or columns in a project board, use the project or project_column event instead.",
"description": "Runs your workflow when a card on a project board is created or modified. For activity related to project boards or columns in a project board, use the `project` or `project_column` event instead.",
"string": {
"constant": "project_card"
}
},
"project-card": {
"description": "Runs your workflow when a card on a project board is created or modified. For activity related to project boards or columns in a project board, use the project or project_column event instead.",
"description": "Runs your workflow when a card on a project board is created or modified. For activity related to project boards or columns in a project board, use the `project` or `project_column` event instead.",
"one-of": [
"null",
"project-card-mapping"
@@ -710,7 +710,7 @@
}
},
"project-card-activity": {
"description": "The types of project card activity that trigger the workflow. Can be one or more of: created, edited, moved, converted, or deleted.",
"description": "The types of project card activity that trigger the workflow. Supported activity types: `created`, `moved`, `converted`, `edited`, `deleted`.",
"one-of": [
"project-card-activity-type",
"project-card-activity-types"
@@ -731,13 +731,13 @@
]
},
"project-column-string": {
"description": "Runs your workflow when a column on a project board is created or modified. For activity related to project boards or cards in a project board, use the project or project_card event instead.",
"description": "Runs your workflow when a column on a project board is created or modified. For activity related to project boards or cards in a project board, use the `project` or `project_card` event instead.",
"string": {
"constant": "project_column"
}
},
"project-column": {
"description": "Runs your workflow when a column on a project board is created or modified. For activity related to project boards or cards in a project board, use the project or project_card event instead.",
"description": "Runs your workflow when a column on a project board is created or modified. For activity related to project boards or cards in a project board, use the `project` or `project_card` event instead.",
"one-of": [
"null",
"project-column-mapping"
@@ -751,7 +751,7 @@
}
},
"project-column-activity": {
"description": "The types of project column activity that trigger the workflow. Can be one or more of: created, updated, moved, or deleted.",
"description": "The types of project column activity that trigger the workflow. Supported activity types: `created`, `updated`, `moved`, `deleted`.",
"one-of": [
"project-column-activity-type",
"project-column-activity-types"
@@ -781,13 +781,13 @@
"null": {}
},
"pull-request-string": {
"description": "Runs your workflow when activity on a pull request in the workflow's repository occurs. For example, if no activity types are specified, the workflow runs when a pull request is opened or reopened or when the head branch of the pull request is updated. For activity related to pull request reviews, pull request review comments, or pull request comments, use the pull_request_review, pull_request_review_comment, or issue_comment events instead.",
"description": "Runs your workflow when activity on a pull request in the workflow's repository occurs. If no activity types are specified, the workflow runs when a pull request is opened, reopened, or when the head branch of the pull request is updated.",
"string": {
"constant": "pull_request"
}
},
"pull-request": {
"description": "Runs your workflow when activity on a pull request in the workflow's repository occurs. For example, if no activity types are specified, the workflow runs when a pull request is opened or reopened or when the head branch of the pull request is updated. For activity related to pull request reviews, pull request review comments, or pull request comments, use the pull_request_review, pull_request_review_comment, or issue_comment events instead.",
"description": "Runs your workflow when activity on a pull request in the workflow's repository occurs. If no activity types are specified, the workflow runs when a pull request is opened, reopened, or when the head branch of the pull request is updated.",
"one-of": [
"null",
"pull-request-mapping"
@@ -805,7 +805,7 @@
}
},
"pull-request-activity": {
"description": "The types of pull request activity that trigger the workflow. Can be one or more of: created, edited, opened, closed, or deleted.",
"description": "The types of pull request activity that trigger the workflow. Supported activity types: `assigned`, `unassigned`, `labeled`, `unlabeled`, `opened`, `edited`, `closed`, `reopened`, `synchronize`, `converted_to_draft`, `ready_for_review`, `locked`, `unlocked`, `review_requested`, `review_request_removed`, `auto_merge_enabled`, `auto_merge_disabled`.",
"one-of": [
"pull-request-activity-type",
"pull-request-activity-types"
@@ -838,26 +838,26 @@
]
},
"pull-request-comment-string": {
"description": "Please use the issue_comment event instead.",
"description": "Please use the `issue_comment` event instead.",
"string": {
"constant": "pull_request_comment"
}
},
"pull-request-comment": {
"description": "Please use the issue_comment event instead.",
"description": "Please use the `issue_comment` event instead.",
"one-of": [
"null",
"issue-comment-mapping"
]
},
"pull-request-review-string": {
"description": "Runs your workflow when a pull request review is submitted, edited, or dismissed. A pull request review is a group of pull request review comments in addition to a body comment and a state. For activity related to pull request review comments or pull request comments, use the pull_request_review_comment or issue_comment events instead.",
"description": "Runs your workflow when a pull request review is submitted, edited, or dismissed. A pull request review is a group of pull request review comments in addition to a body comment and a state. For activity related to pull request review comments or pull request comments, use the `pull_request_review_comment` or `issue_comment` events instead.",
"string": {
"constant": "pull_request_review"
}
},
"pull-request-review": {
"description": "Runs your workflow when a pull request review is submitted, edited, or dismissed. A pull request review is a group of pull request review comments in addition to a body comment and a state. For activity related to pull request review comments or pull request comments, use the pull_request_review_comment or issue_comment events instead.",
"description": "Runs your workflow when a pull request review is submitted, edited, or dismissed. A pull request review is a group of pull request review comments in addition to a body comment and a state. For activity related to pull request review comments or pull request comments, use the `pull_request_review_comment` or `issue_comment` events instead.",
"one-of": [
"null",
"pull-request-review-mapping"
@@ -871,7 +871,7 @@
}
},
"pull-request-review-activity": {
"description": "The types of pull request review activity that trigger the workflow. Can be one or more of: submitted, edited, or dismissed.",
"description": "The types of pull request review activity that trigger the workflow. Supported activity types: `submitted`, `edited`, `dismissed`.",
"one-of": [
"pull-request-review-activity-type",
"pull-request-review-activity-types"
@@ -910,7 +910,7 @@
}
},
"pull-request-review-comment-activity": {
"description": "The types of pull request review comment activity that trigger the workflow. Can be one or more of: created, edited, or deleted.",
"description": "The types of pull request review comment activity that trigger the workflow. Supported activity types: `created`, `edited`, `deleted`.",
"one-of": [
"pull-request-review-comment-activity-type",
"pull-request-review-comment-activity-types"
@@ -929,13 +929,13 @@
]
},
"pull-request-target-string": {
"description": "Runs your workflow when activity on a pull request in the workflow's repository occurs. For example, if no activity types are specified, the workflow runs when a pull request is opened or reopened or when the head branch of the pull request is updated. This event runs in the context of the base of the pull request, rather than in the context of the merge commit, as the pull_request event does. This prevents execution of unsafe code from the head of the pull request that could alter your repository or steal any secrets you use in your workflow. This event allows your workflow to do things like label or comment on pull requests from forks. Avoid using this event if you need to build or run code from the pull request.",
"description": "Runs your workflow when activity on a pull request in the workflow's repository occurs. If no activity types are specified, the workflow runs when a pull request is opened, reopened, or when the head branch of the pull request is updated.\n\nThis event runs in the context of the base of the pull request, rather than in the context of the merge commit, as the `pull_request` event does. This prevents execution of unsafe code from the head of the pull request that could alter your repository or steal any secrets you use in your workflow. This event allows your workflow to do things like label or comment on pull requests from forks. Avoid using this event if you need to build or run code from the pull request.",
"string": {
"constant": "pull_request_target"
}
},
"pull-request-target": {
"description": "Runs your workflow when activity on a pull request in the workflow's repository occurs. For example, if no activity types are specified, the workflow runs when a pull request is opened or reopened or when the head branch of the pull request is updated. This event runs in the context of the base of the pull request, rather than in the context of the merge commit, as the pull_request event does. This prevents execution of unsafe code from the head of the pull request that could alter your repository or steal any secrets you use in your workflow. This event allows your workflow to do things like label or comment on pull requests from forks. Avoid using this event if you need to build or run code from the pull request.",
"description": "Runs your workflow when activity on a pull request in the workflow's repository occurs. If no activity types are specified, the workflow runs when a pull request is opened, reopened, or when the head branch of the pull request is updated.\n\nThis event runs in the context of the base of the pull request, rather than in the context of the merge commit, as the `pull_request` event does. This prevents execution of unsafe code from the head of the pull request that could alter your repository or steal any secrets you use in your workflow. This event allows your workflow to do things like label or comment on pull requests from forks. Avoid using this event if you need to build or run code from the pull request.",
"one-of": [
"null",
"pull-request-target-mapping"
@@ -953,7 +953,7 @@
}
},
"pull-request-target-activity": {
"description": "The types of pull request activity that trigger the workflow. Can be one or more of: assigned, unassigned, labeled, unlabeled, opened, edited, closed, reopened, synchronize, converted_to_draft, ready_for_review, locked, unlocked, review_requested, review_request_removed, auto_merge_enabled, or auto_merge_disabled.",
"description": "The types of pull request activity that trigger the workflow. Supported activity types: `assigned`, `unassigned`, `labeled`, `unlabeled`, `opened`, `edited`, `closed`, `reopened`, `synchronize`, `converted_to_draft`, `ready_for_review`, `locked`, `unlocked`, `review_requested`, `review_request_removed`, `auto_merge_enabled`, `auto_merge_disabled`.",
"one-of": [
"pull-request-target-activity-type",
"pull-request-target-activity-types"
@@ -1031,7 +1031,7 @@
}
},
"registry-package-activity": {
"description": "The types of registry package activity that trigger the workflow. Can be one or more of: published or updated.",
"description": "The types of registry package activity that trigger the workflow. Supported activity types: `published`, `updated`.",
"one-of": [
"registry-package-activity-type",
"registry-package-activity-types"
@@ -1069,7 +1069,7 @@
}
},
"release-activity": {
"description": "The types of release activity that trigger the workflow. Can be one or more of: published, unpublished, created, edited, deleted, prereleased, or released.",
"description": "The types of release activity that trigger the workflow. Supported activity types: `published`, `unpublished`, `created`, `edited`, `deleted`, `prereleased`, `released`.",
"one-of": [
"release-activity-type",
"release-activity-types"
@@ -1092,25 +1092,25 @@
]
},
"schedule-string": {
"description": "The schedule event allows you to trigger a workflow at a scheduled time. You can schedule a workflow to run at specific UTC times using POSIX cron syntax. Scheduled workflows run on the latest commit on the default or base branch. The shortest interval you can run scheduled workflows is once every 5 minutes. GitHub Actions does not support the non-standard syntax @yearly, @monthly, @weekly, @daily, @hourly, and @reboot.",
"description": "The `schedule` event allows you to trigger a workflow at a scheduled time.\n\nYou can schedule a workflow to run at specific UTC times using POSIX cron syntax. Scheduled workflows run on the latest commit on the default or base branch. The shortest interval you can run scheduled workflows is once every 5 minutes. GitHub Actions does not support the non-standard syntax `@yearly`, `@monthly`, `@weekly`, `@daily`, `@hourly`, and `@reboot`.",
"string": {
"constant": "schedule"
}
},
"schedule": {
"description": "The schedule event allows you to trigger a workflow at a scheduled time. You can schedule a workflow to run at specific UTC times using POSIX cron syntax. Scheduled workflows run on the latest commit on the default or base branch. The shortest interval you can run scheduled workflows is once every 5 minutes. GitHub Actions does not support the non-standard syntax @yearly, @monthly, @weekly, @daily, @hourly, and @reboot.",
"description": "The `schedule` event allows you to trigger a workflow at a scheduled time.\n\nYou can schedule a workflow to run at specific UTC times using POSIX cron syntax. Scheduled workflows run on the latest commit on the default or base branch. The shortest interval you can run scheduled workflows is once every 5 minutes. GitHub Actions does not support the non-standard syntax `@yearly`, `@monthly`, `@weekly`, `@daily`, `@hourly`, and `@reboot`.",
"sequence": {
"item-type": "cron-mapping"
}
},
"status-string": {
"description": "Runs your workflow when the status of a Git commit changes. For example, commits can be marked as error, failure, pending, or success. If you want to provide more details about the status change, you may want to use the check_run event.",
"description": "Runs your workflow when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. If you want to provide more details about the status change, you may want to use the `check_run` event.",
"string": {
"constant": "status"
}
},
"status": {
"description": "Runs your workflow when the status of a Git commit changes. For example, commits can be marked as error, failure, pending, or success. If you want to provide more details about the status change, you may want to use the check_run event.",
"description": "Runs your workflow when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. If you want to provide more details about the status change, you may want to use the `check_run` event.",
"null": {}
},
"watch-string": {
@@ -1134,7 +1134,7 @@
}
},
"watch-activity": {
"description": "The types of watch activity that trigger the workflow. Currently, the only supported type is started.",
"description": "The types of watch activity that trigger the workflow. Supported activity types: `started`.",
"one-of": [
"watch-activity-type",
"watch-activity-types"
@@ -1151,13 +1151,13 @@
]
},
"workflow-run-string": {
"description": "This event occurs when a workflow run is requested or completed. It allows you to execute a workflow based on execution or completion of another workflow. The workflow started by the workflow_run event is able to access secrets and write tokens, even if the previous workflow was not. This is useful in cases where the previous workflow is intentionally not privileged, but you need to take a privileged action in a later workflow.",
"description": "This event occurs when a workflow run is requested or completed. It allows you to execute a workflow based on execution or completion of another workflow. The workflow started by the `workflow_run` event is able to access secrets and write tokens, even if the previous workflow was not. This is useful in cases where the previous workflow is intentionally not privileged, but you need to take a privileged action in a later workflow.",
"string": {
"constant": "workflow_run"
}
},
"workflow-run": {
"description": "This event occurs when a workflow run is requested or completed. It allows you to execute a workflow based on execution or completion of another workflow. The workflow started by the workflow_run event is able to access secrets and write tokens, even if the previous workflow was not. This is useful in cases where the previous workflow is intentionally not privileged, but you need to take a privileged action in a later workflow.",
"description": "This event occurs when a workflow run is requested or completed. It allows you to execute a workflow based on execution or completion of another workflow. The workflow started by the `workflow_run` event is able to access secrets and write tokens, even if the previous workflow was not. This is useful in cases where the previous workflow is intentionally not privileged, but you need to take a privileged action in a later workflow.",
"one-of": [
"null",
"workflow-run-mapping"
@@ -1174,14 +1174,14 @@
}
},
"workflow-run-workflows": {
"description": "The name of the workflow that triggers the workflow_run event. The workflow must be in the same repository as the workflow that uses the workflow_run event.",
"description": "The name of the workflow that triggers the `workflow_run` event. The workflow must be in the same repository as the workflow that uses the `workflow_run` event.",
"one-of": [
"non-empty-string",
"sequence-of-non-empty-string"
]
},
"workflow-run-activity": {
"description": "The types of workflow run activity that trigger the workflow. Can be one or more of: requested or completed.",
"description": "The types of workflow run activity that trigger the workflow. Suupported activity types: `completed`, `requested`, `in_progress`.",
"one-of": [
"workflow-run-activity-type",
"workflow-run-activity-types"
@@ -1200,55 +1200,55 @@
]
},
"event-branches": {
"description": "Use the branches filter to configure your workflow to only run when an event occurs on specific branches. If you use the branches filter and other filters (such as branches-ignore), the workflow will only run when all filters are satisfied.",
"description": "Use the `branches` filter when you want to include branch name patterns or when you want to both include and exclude branch name patterns. You cannot use both the `branches` and `branches-ignore` filters for the same event in a workflow.",
"one-of": [
"non-empty-string",
"sequence-of-non-empty-string"
]
},
"event-branches-ignore": {
"description": "You can use the branches-ignore filter to configure your workflow to not run when an event occurs on specific branches. If you use the branches-ignore filter and other filters (such as branches), the workflow will only run when all filters are satisfied.",
"description": "Use the `branches-ignore` filter when you only want to exclude branch name patterns. You cannot use both the `branches` and `branches-ignore` filters for the same event in a workflow.",
"one-of": [
"non-empty-string",
"sequence-of-non-empty-string"
]
},
"event-tags": {
"description": "Use the tags filter to configure your workflow to only run when an event occurs on specific tags. If you use the tags filter and other filters (such as tags-ignore), the workflow will only run when all filters are satisfied.",
"description": "Use the `tags` filter when you want to include tag name patterns or when you want to both include and exclude tag names patterns. You cannot use both the `tags` and `tags-ignore` filters for the same event in a workflow.",
"one-of": [
"non-empty-string",
"sequence-of-non-empty-string"
]
},
"event-tags-ignore": {
"description": "You can use the tags-ignore filter to configure your workflow to not run when an event occurs on specific tags. If you use the tags-ignore filter and other filters (such as tags), the workflow will only run when all filters are satisfied.",
"description": "Use the `tags-ignore` filter when you only want to exclude tag name patterns. You cannot use both the `tags` and `tags-ignore` filters for the same event in a workflow.",
"one-of": [
"non-empty-string",
"sequence-of-non-empty-string"
]
},
"event-paths": {
"description": "Configure your workflow to only run when an event changes specific files. If you use both the paths filter and other filters (such as paths-ignore), the workflow will only run when all filters are satisfied.",
"description": "Use the `paths` filter when you want to include file path patterns or when you want to both include and exclude file path patterns. You cannot use both the `paths` and `paths-ignore` filters for the same event in a workflow.",
"one-of": [
"non-empty-string",
"sequence-of-non-empty-string"
]
},
"event-paths-ignore": {
"description": "You can use the paths-ignore filter to configure your workflow to not run when an event changes specific files. If you use both the paths-ignore filter and other filters (such as paths), the workflow will only run when all filters are satisfied.",
"description": "Use the `paths-ignore` filter when you only want to exclude file path patterns. You cannot use both the `paths` and `paths-ignore` filters for the same event in a workflow.",
"one-of": [
"non-empty-string",
"sequence-of-non-empty-string"
]
},
"repository-dispatch-string": {
"description": "You can use the GitHub API to trigger a webhook event called repository_dispatch when you want to trigger a workflow for activity that happens outside of GitHub. For more information, see https://developer.github.com/v3/repos/#create-a-repository-dispatch-event. To trigger the custom repository_dispatch webhook event, you must send a POST request to a GitHub API endpoint and provide an event_type name to describe the activity type. To trigger a workflow run, you must also configure your workflow to use the repository_dispatch event.",
"description": "You can use the GitHub API to trigger a webhook event called `repository_dispatch` when you want to trigger a workflow for activity that happens outside of GitHub. For more information, visit the [online documentation](https://docs.github.com/en/rest/repos/repos#create-a-repository-dispatch-event).",
"string": {
"constant": "branch_protection_rule"
}
},
"repository-dispatch": {
"description": "You can use the GitHub API to trigger a webhook event called repository_dispatch when you want to trigger a workflow for activity that happens outside of GitHub. For more information, see https://developer.github.com/v3/repos/#create-a-repository-dispatch-event. To trigger the custom repository_dispatch webhook event, you must send a POST request to a GitHub API endpoint and provide an event_type name to describe the activity type. To trigger a workflow run, you must also configure your workflow to use the repository_dispatch event.",
"description": "You can use the GitHub API to trigger a webhook event called `repository_dispatch` when you want to trigger a workflow for activity that happens outside of GitHub. For more information, visit the [online documentation](https://docs.github.com/en/rest/repos/repos#create-a-repository-dispatch-event).",
"one-of": [
"null",
"repository-dispatch-mapping"
@@ -1262,13 +1262,13 @@
}
},
"workflow-call-string": {
"description": "Allows workflows to be reused by other workflows.",
"description": "The `workflow_call` event is used to indicate that a workflow can be called by another workflow. When a workflow is triggered with the `workflow_call` event, the event payload in the called workflow is the same event payload from the calling workflow.",
"string": {
"constant": "workflow_call"
}
},
"workflow-call": {
"description": "Allows workflows to be reused by other workflows.",
"description": "The `workflow_call` event is used to indicate that a workflow can be called by another workflow. When a workflow is triggered with the `workflow_call` event, the event payload in the called workflow is the same event payload from the calling workflow.",
"one-of": [
"null",
"workflow-call-mapping"
@@ -1284,7 +1284,7 @@
}
},
"workflow-call-inputs": {
"description": "When using the workflow_call keyword, you can optionally specify inputs that are passed to the called workflow from the caller workflow.",
"description": "Inputs that are passed to the called workflow from the caller workflow.",
"mapping": {
"loose-key-type": "non-empty-string",
"loose-value-type": "workflow-call-input-definition"
@@ -1303,14 +1303,14 @@
},
"required": {
"type": "boolean",
"description": "A boolean to indicate whether the action requires the input parameter. Set to true when the parameter is required."
"description": "A boolean to indicate whether the action requires the input parameter. Set to `true` when the parameter is required."
},
"default": "workflow-call-input-default"
}
}
},
"workflow-call-input-type": {
"description": "Required if input is defined for the on.workflow_call keyword. The value of this parameter is a string specifying the data type of the input. This must be one of: boolean, number, or string.",
"description": "Required if input is defined for the `on.workflow_call` keyword. The value of this parameter is a string specifying the data type of the input. This must be one of: `boolean`, `number`, or `string`.",
"one-of": [
"input-type-string",
"input-type-boolean",
@@ -1343,7 +1343,7 @@
}
},
"workflow-call-input-default": {
"description": "The default value is used when an input parameter isn't specified in a workflow file.",
"description": "If a `default` parameter is not set, the default value of the input is `false` for boolean, `0` for a number, and `\"\"` for a string.",
"context": [
"github",
"inputs",
@@ -1356,7 +1356,7 @@
]
},
"workflow-call-secrets": {
"description": "A map of the secrets that can be used in the called workflow. Within the called workflow, you can use the secrets context to refer to a secret.",
"description": "A map of the secrets that can be used in the called workflow. Within the called workflow, you can use the `secrets` context to refer to a secret.",
"mapping": {
"loose-key-type": "workflow-call-secret-name",
"loose-value-type": "workflow-call-secret-definition"
@@ -1389,7 +1389,7 @@
}
},
"workflow-call-outputs": {
"description": "When using the workflow_call keyword, you can optionally specify outputs that are provided by the called workflow to the caller workflow.",
"description": "A reusable workflow may generate data that you want to use in the caller workflow. To use these outputs, you must specify them as the outputs of the reusable workflow.",
"mapping": {
"loose-key-type": "workflow-call-output-name",
"loose-value-type": "workflow-call-output-definition"
@@ -1399,7 +1399,7 @@
"string": {
"require-non-empty": true
},
"description": "A string identifier to associate with the output. The value of <output_id> is a map of the input's metadata. The <output_id> must be a unique identifier within the outputs object. The <output_id> must start with a letter or _ and contain only alphanumeric characters, -, or _."
"description": "A string identifier to associate with the output."
},
"workflow-call-output-definition": {
"mapping": {
@@ -1426,13 +1426,13 @@
"string": {}
},
"workflow-dispatch-string": {
"description": "You can now create workflows that are manually triggered with the new workflow_dispatch event. You will then see a 'Run workflow' button on the Actions tab, enabling you to easily trigger a run.",
"description": "The `workflow_dispatch` event allows you to manually trigger a workflow run. A workflow can be manually triggered using the GitHub API, GitHub CLI, or GitHub browser interface.",
"string": {
"constant": "workflow_dispatch"
}
},
"workflow-dispatch": {
"description": "You can now create workflows that are manually triggered with the new workflow_dispatch event. You will then see a 'Run workflow' button on the Actions tab, enabling you to easily trigger a run.",
"description": "The `workflow_dispatch` event allows you to manually trigger a workflow run. A workflow can be manually triggered using the GitHub API, GitHub CLI, or GitHub browser interface.",
"one-of": [
"null",
"workflow-dispatch-mapping"
@@ -1446,7 +1446,7 @@
}
},
"workflow-dispatch-inputs": {
"description": "Input parameters allow you to specify data that the action expects to use during runtime. GitHub stores input parameters as environment variables. Input ids with uppercase letters are converted to lowercase during runtime. We recommended using lowercase input ids.",
"description": "You can configure custom-defined input properties, default input values, and required inputs for the event directly in your workflow. When you trigger the event, you can provide the `ref` and any `inputs`. When the workflow runs, you can access the input values in the `inputs` context.",
"mapping": {
"loose-key-type": "workflow-dispatch-input-name",
"loose-value-type": "workflow-dispatch-input"
@@ -1481,7 +1481,7 @@
}
},
"workflow-dispatch-input-type": {
"description": "A string representing the type of the input. This must be one of: boolean, number, string, choice, or environment.",
"description": "A string representing the type of the input. This must be one of: `boolean`, `number`, `string`, `choice`, or `environment`.",
"one-of": [
"input-type-string",
"input-type-boolean",
@@ -1499,7 +1499,7 @@
]
},
"permissions": {
"description": "You can modify the default permissions granted to the GITHUB_TOKEN, adding or removing access as required, so that you only allow the minimum required access.",
"description": "You can use `permissions` to modify the default permissions granted to the `GITHUB_TOKEN`, adding or removing access as required, so that you only allow the minimum required access.\n\n[Documentation](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#permissions)",
"one-of": [
"permissions-mapping",
"permission-level-shorthand-read-all",
@@ -1526,7 +1526,7 @@
}
},
"permission-level-any": {
"description": "The permission level for the GITHUB_TOKEN.",
"description": "The permission level for the `GITHUB_TOKEN`.",
"one-of": [
"permission-level-read",
"permission-level-write",
@@ -1546,36 +1546,37 @@
]
},
"permission-level-read": {
"description": "The permission level for the GITHUB_TOKEN. Grants write permission for the specified scope.",
"description": "The permission level for the `GITHUB_TOKEN`. Grants `read` permission for the specified scope.",
"string": {
"constant": "read"
}
},
"permission-level-write": {
"description": "The permission level for the GITHUB_TOKEN. Grants write permission for the specified scope.",
"description": "The permission level for the `GITHUB_TOKEN`. Grants `write` permission for the specified scope.",
"string": {
"constant": "write"
}
},
"permission-level-no-access": {
"description": "The permission level for the GITHUB_TOKEN. Restricts all access for the specified scope.",
"description": "The permission level for the `GITHUB_TOKEN`. Restricts all access for the specified scope.",
"string": {
"constant": "none"
}
},
"permission-level-shorthand-read-all": {
"description": "The permission level for the GITHUB_TOKEN. Grants read access for all scopes.",
"description": "The permission level for the `GITHUB_TOKEN`. Grants `read` access for all scopes.",
"string": {
"constant": "read-all"
}
},
"permission-level-shorthand-write-all": {
"description": "The permission level for the GITHUB_TOKEN. Grants write access for all scopes.",
"description": "The permission level for the `GITHUB_TOKEN`. Grants `write` access for all scopes.",
"string": {
"constant": "write-all"
}
},
"workflow-defaults": {
"description": "Use `defaults` to create a map of default settings that will apply to all jobs in the workflow. You can also set default settings that are only available to a job.\n\n[Documentation](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#defaults)",
"mapping": {
"properties": {
"run": "workflow-defaults-run"
@@ -1591,7 +1592,7 @@
}
},
"workflow-env": {
"description": "To set custom environment variables, you need to specify the variables in the workflow file. You can define environment variables for a step, job, or entire workflow using the jobs.<job_id>.steps[*].env, jobs.<job_id>.env, and env keywords. For more information, see https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsenv",
"description": "A map of environment variables that are available to the steps of all jobs in the workflow. You can also set environment variables that are only available to the steps of a single job or to a single step.\n\n[Documentation](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#env)",
"context": [
"github",
"inputs",
@@ -1604,7 +1605,7 @@
}
},
"jobs": {
"description": "A workflow run is made up of one or more jobs. Jobs run in parallel by default. To run jobs sequentially, you can define dependencies on other jobs using the jobs.<job_id>.needs keyword. Each job runs in a fresh instance of the virtual environment specified by runs-on. You can run an unlimited number of jobs as long as you are within the workflow usage limits. For more information, see https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#usage-limits.",
"description": "A workflow run is made up of one or more `jobs`, which run in parallel by default. To run jobs sequentially, you can define dependencies on other jobs using the `jobs.<job_id>.needs` keyword. Each job runs in a runner environment specified by `runs-on`.\n\n[Documentation](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobs)",
"mapping": {
"loose-key-type": "job-id",
"loose-value-type": "job"
@@ -1614,10 +1615,10 @@
"string": {
"require-non-empty": true
},
"description": "A string identifier to associate with the job. The value of <job_id> is a map of the input's metadata. The <job_id> must be a unique identifier within the inputs object. The <job_id> must start with a letter or _ and contain only alphanumeric characters, -, or _."
"description": "A unique identifier for the job. The identifier must start with a letter or _ and contain only alphanumeric characters, -, or _."
},
"job": {
"description": "Each job must have an id to associate with the job. The key job_id is a string and its value is a map of the job's configuration data. You must replace <job_id> with a string that is unique to the jobs object. The <job_id> must start with a letter or _ and contain only alphanumeric characters, -, or _.",
"description": "Each job must have an id to associate with the job. The key `job_id` is a string and its value is a map of the job's configuration data. You must replace `<job_id>` with a string that is unique to the jobs object. The `<job_id>` must start with a letter or _ and contain only alphanumeric characters, -, or _.",
"one-of": [
"job-factory",
"workflow-job"
@@ -1666,7 +1667,7 @@
"description": "The name of the job displayed on GitHub."
},
"uses": {
"description": "The location and version of a reusable workflow file to run as a job, of the form './{path/to}/{localfile}.yml' or '{owner}/{repo}/{path}/{filename}@{ref}'. {ref} can be a SHA, a release tag, or a branch name. Using the commit SHA is the safest for stability and security.",
"description": "The location and version of a reusable workflow file to run as a job. Use one of the following syntaxes:\n\n* `{owner}/{repo}/.github/workflows/{filename}@{ref}` for reusable workflows in public and private repositories.\n* `./.github/workflows/{filename}` for reusable workflows in the same repository.\n\n{ref} can be a SHA, a release tag, or a branch name. Using the commit SHA is the safest for stability and security.",
"type": "non-empty-string",
"required": true
},
@@ -1681,14 +1682,14 @@
}
},
"workflow-job-with": {
"description": "A map of inputs that are passed to the called workflow. Any inputs that you pass must match the input specifications defined in the called workflow. Unlike 'jobs.<job_id>.steps[*].with', the inputs you pass with 'jobs.<job_id>.with' are not be available as environment variables in the called workflow. Instead, you can reference the inputs by using the inputs context.",
"description": "When a job is used to call a reusable workflow, you can use `with` to provide a map of inputs that are passed to the called workflow.\n\nAny inputs that you pass must match the input specifications defined in the called workflow.",
"mapping": {
"loose-key-type": "non-empty-string",
"loose-value-type": "scalar-needs-context"
}
},
"workflow-job-secrets": {
"description": "When a job is used to call a reusable workflow, you can use 'secrets' to provide a map of secrets that are passed to the called workflow. Any secrets that you pass must match the names defined in the called workflow.",
"description": "When a job is used to call a reusable workflow, you can use `secrets` to provide a map of secrets that are passed to the called workflow.\n\nAny secrets that you pass must match the names defined in the called workflow.",
"one-of": [
"workflow-job-secrets-mapping",
"workflow-job-secrets-inherit"
@@ -1706,14 +1707,14 @@
}
},
"needs": {
"description": "Identifies any jobs that must complete successfully before this job will run. It can be a string or array of strings. If a job fails, all jobs that need it are skipped unless the jobs use a conditional statement that causes the job to continue.",
"description": "Use `needs` to identify any jobs that must complete successfully before this job will run. It can be a string or array of strings. If a job fails, all jobs that need it are skipped unless the jobs use a conditional expression that causes the job to continue. If a run contains a series of jobs that need each other, a failure applies to all jobs in the dependency chain from the point of failure onwards.",
"one-of": [
"sequence-of-non-empty-string",
"non-empty-string"
]
},
"job-if": {
"description": "You can use the if conditional to prevent a job from running unless a condition is met. You can use any supported context and expression to create a conditional. Expressions in an if conditional do not require the bracketed expression syntax. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions.",
"description": "You can use the `if` conditional to prevent a job from running unless a condition is met. You can use any supported context and expression to create a conditional.",
"context": [
"github",
"inputs",
@@ -1749,7 +1750,7 @@
]
},
"strategy": {
"description": "A strategy creates a build matrix for your jobs. You can define different variations of an environment to run each job in.",
"description": "Use `strategy` to use a matrix strategy for your jobs. A matrix strategy lets you use variables in a single job definition to automatically create multiple job runs that are based on the combinations of the variables. ",
"context": [
"github",
"inputs",
@@ -1760,27 +1761,27 @@
"properties": {
"fail-fast": {
"type": "boolean",
"description": "When set to true, GitHub cancels all in-progress jobs if any matrix job fails. Default: true"
"description": "Setting `fail-fast` to `false` prevents GitHub from canceling all in-progress jobs if any matrix job fails. Default: `true`"
},
"max-parallel": {
"type": "number",
"description": "The maximum number of jobs that can run simultaneously when using a matrix job strategy. By default, GitHub will maximize the number of jobs run in parallel depending on the available runners on GitHub-hosted virtual machines."
"description": "The maximum number of jobs that can run simultaneously when using a matrix job strategy. By default, GitHub will maximize the number of jobs run in parallel depending on runner availability."
},
"matrix": "matrix"
}
}
},
"matrix": {
"description": "A build matrix is a set of different configurations of the virtual environment. For example you might run a job against more than one supported version of a language, operating system, or tool. Each configuration is a copy of the job that runs and reports a status. You can specify a matrix by supplying an array for the configuration options. For example, if the GitHub virtual environment supports Node.js versions 6, 8, and 10 you could specify an array of those versions in the matrix. When you define a matrix of operating systems, you must set the required runs-on keyword to the operating system of the current job, rather than hard-coding the operating system name. To access the operating system name, you can use the matrix.os context parameter to set runs-on. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions.",
"description": "Use `matrix` to define a matrix of different job configurations. Within your matrix, define one or more variables followed by an array of values.",
"mapping": {
"properties": {
"include": {
"type": "matrix-filter",
"description": "Use include to expand existing matrix configurations or to add new configurations. The value of include is a list of objects."
"description": "Use `include` to expand existing matrix configurations or to add new configurations. The value of `include` is a list of objects.\n\nFor each object in the `include` list, the key:value pairs in the object will be added to each of the matrix combinations if none of the key:value pairs overwrite any of the original matrix values. If the object cannot be added to any of the matrix combinations, a new matrix combination will be created instead. Note that the original matrix values will not be overwritten, but added matrix values can be overwritten."
},
"exclude": {
"type": "matrix-filter",
"description": "To remove specific configurations defined in the matrix, use exclude. An excluded configuration only has to be a partial match for it to be excluded."
"description": "To remove specific configurations defined in the matrix, use `exclude`. An excluded configuration only has to be a partial match for it to be excluded."
}
},
"loose-key-type": "non-empty-string",
@@ -1799,7 +1800,7 @@
}
},
"runs-on": {
"description": "The type of machine to run the job on. The machine can be either a GitHub-hosted runner, or a self-hosted runner.",
"description": "Use `runs-on` to define the type of machine to run the job on.\n* The destination machine can be either a GitHub-hosted runner, larger runner, or a self-hosted runner.\n* You can target runners based on the labels assigned to them, or their group membership, or a combination of these.\n* You can provide `runs-on` as a single string or as an array of strings.\n* If you specify an array of strings, your workflow will execute on any runner that matches all of the specified `runs-on` values.\n* If you would like to run your workflow on multiple machines, use `jobs.<job_id>.strategy`.",
"context": [
"github",
"inputs",
@@ -1833,7 +1834,7 @@
]
},
"job-env": {
"description": "A map of environment variables that are available to all steps in the job.",
"description": "A map of variables that are available to all steps in the job.",
"context": [
"github",
"inputs",
@@ -1849,7 +1850,7 @@
}
},
"workflow-concurrency": {
"description": "Concurrency ensures that only a single workflow using the same concurrency group will run at a time. A concurrency group can be any string or expression. The expression can use any context except for the secrets context. You can also specify concurrency at the workflow level.",
"description": "Concurrency ensures that only a single job or workflow using the same concurrency group will run at a time. A concurrency group can be any string or expression.\n\nYou can also specify `concurrency` at the job level.\n\n[Documentation](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#concurrency)",
"context": [
"github",
"inputs",
@@ -1861,7 +1862,7 @@
]
},
"job-concurrency": {
"description": "Concurrency ensures that only a single job using the same concurrency group will run at a time. A concurrency group can be any string or expression. The expression can use any context except for the secrets context. You can also specify concurrency at the workflow level.",
"description": "Concurrency ensures that only a single job using the same concurrency group will run at a time. A concurrency group can be any string or expression. The expression can use any context except for the `secrets` context.\n\nYou can also specify `concurrency` at the workflow level.",
"context": [
"github",
"inputs",
@@ -1876,13 +1877,13 @@
]
},
"concurrency-mapping": {
"description": "Concurrency ensures that only a single job or workflow using the same concurrency group will run at a time. A concurrency group can be any string or expression. The expression can use any context except for the secrets context. You can also specify concurrency at the workflow level.",
"description": "Concurrency ensures that only a single job or workflow using the same concurrency group will run at a time. A concurrency group can be any string or expression.\n\nYou can also specify `concurrency` at the job level.\n\n[Documentation](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#concurrency)",
"mapping": {
"properties": {
"group": {
"type": "non-empty-string",
"required": true,
"description": "When a concurrent job or workflow is queued, if another job or workflow using the same concurrency group in the repository is in progress, the queued job or workflow will be pending. Any previously pending job or workflow in the concurrency group will be canceled."
"description": "When a concurrent job or workflow is queued, if another job or workflow using the same concurrency group in the repository is in progress, the queued job or workflow will be `pending`. Any previously pending job or workflow in the concurrency group will be canceled. To also cancel any currently running job or workflow in the same concurrency group, specify `cancel-in-progress: true`."
},
"cancel-in-progress": {
"type": "boolean",
@@ -1921,7 +1922,7 @@
}
},
"job-environment-name": {
"description": "The name of the environment.",
"description": "The name of the environment used by the job.",
"context": [
"github",
"inputs",
@@ -1933,7 +1934,7 @@
"string": {}
},
"job-defaults": {
"description": "A map of default settings that will apply to all steps in the job.",
"description": "A map of default settings that will apply to all steps in the job. You can also set default settings for the entire workflow.",
"mapping": {
"properties": {
"run": "job-defaults-run"
@@ -1958,14 +1959,14 @@
}
},
"job-outputs": {
"description": "A map of outputs for a job. Job outputs are available to all downstream jobs that depend on this job.",
"description": "A map of outputs for a called workflow. Called workflow outputs are available to all downstream jobs in the caller workflow. Each output has an identifier, an optional `description,` and a `value`. The `value` must be set to the value of an output from a job within the called workflow.",
"mapping": {
"loose-key-type": "non-empty-string",
"loose-value-type": "string-runner-context"
}
},
"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 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 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. Must contain either `uses` or `run`.",
"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 run as a step. Each step runs in its own process in the runner environment and has access to the workspace and filesystem. Because steps 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. Must contain either `uses` or `run`.",
"sequence": {
"item-type": "steps-item"
}
@@ -1985,7 +1986,7 @@
"timeout-minutes": "step-timeout-minutes",
"run": {
"type": "string-steps-context",
"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 text specified in the run command. Commands run using non-login shells by default. You can choose a different shell and customize the shell used to run commands. Each run keyword represents a new process and shell in the virtual environment. When you provide multi-line commands, each line runs in the same shell.",
"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 text specified in the `run` command. Commands run using non-login shells by default. You can choose a different shell and customize the shell used to run commands. Each `run` keyword represents a new process and shell in the virtual environment. When you provide multi-line commands, each line runs in the same shell.",
"required": true
},
"continue-on-error": "step-continue-on-error",
@@ -2004,7 +2005,7 @@
"continue-on-error": "step-continue-on-error",
"timeout-minutes": "step-timeout-minutes",
"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 (https://hub.docker.com/).",
"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": "non-empty-string",
"required": true
},
@@ -2029,13 +2030,13 @@
"hashFiles(1,255)"
],
"boolean": {},
"description": "Prevents a job from failing when a step fails. Set to true to allow a job to pass when this step fails."
"description": "Prevents a job from failing when a step fails. Set to `true` to allow a job to pass when this step fails."
},
"step-id": {
"string": {
"require-non-empty": true
},
"description": "A unique identifier for the step. You can use the id to reference the step in contexts."
"description": "A unique identifier for the step. You can use the `id` to reference the step in contexts."
},
"step-if": {
"context": [
@@ -2055,7 +2056,7 @@
"success(0,0)",
"hashFiles(1,255)"
],
"description": "You can use the if conditional to prevent a step from running unless a condition is met. You can use any supported context and expression to create a conditional. Expressions in an if conditional do not require the bracketed expression syntax.",
"description": "Use the `if` conditional to prevent a step from running unless a condition is met. Any supported context and expression can be used to create a conditional. Expressions in an `if` conditional do not require the bracketed expression syntax. When you use expressions in an `if` conditional, you may omit the expression syntax because GitHub automatically evaluates the `if` conditional as an expression.",
"string": {
"is-expression": true
}
@@ -2087,7 +2088,7 @@
]
},
"step-env": {
"description": "Sets environment variables for steps to use in the virtual environment. You can also set environment variables for the entire workflow or a job.",
"description": "Sets variables for steps to use in the runner environment. You can also set variables for the entire workflow or a job.",
"context": [
"github",
"inputs",
@@ -2144,7 +2145,7 @@
"description": "The maximum number of minutes to run the step before killing the process."
},
"step-with": {
"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.",
"description": "A map of the input parameters defined by the action. Each input parameter is a key/value pair. Input parameters are set as variables. When you specify an input in a workflow file or use a default input value, GitHub creates a variable for the input with the name `INPUT_<VARIABLE_NAME>`. The variable created converts input names to uppercase letters and replaces spaces with `_`.",
"context": [
"github",
"inputs",
@@ -2165,7 +2166,7 @@
}
},
"container": {
"description": "A container to run any steps in a job that don't already specify a container. If you have steps that use both script and container actions, the container actions will run as sibling containers on the same network with the same volume mounts. If you do not set a container, all steps will run directly on the host specified by runs-on unless a step refers to an action configured to run in a container.",
"description": "A container to run any steps in a job that don't already specify a container. If you have steps that use both script and container actions, the container actions will run as sibling containers on the same network with the same volume mounts.\n\nIf you do not set a container, all steps will run directly on the host specified by runs-on unless a step refers to an action configured to run in a container.",
"context": [
"github",
"inputs",
@@ -2184,20 +2185,20 @@
"properties": {
"image": {
"type": "non-empty-string",
"description": "The Docker image to use as the container to run the job. The value can be the Docker Hub image name or a registry name."
"description": "Use `jobs.<job_id>.container.image` to define the Docker image to use as the container to run the action. The value can be the Docker Hub image or a registry name."
},
"options": {
"type": "non-empty-string",
"description": "Additional Docker container resource options. For a list of options, see https://docs.docker.com/engine/reference/commandline/create/#options."
"description": "Use `jobs.<job_id>.container.options` to configure additional Docker container resource options."
},
"env": "container-env",
"ports": {
"type": "sequence-of-non-empty-string",
"description": "Sets an array of ports to expose on the container."
"description": "Use `jobs.<job_id>.container.ports` to set an array of ports to expose on the container."
},
"volumes": {
"type": "sequence-of-non-empty-string",
"description": "Sets an array of volumes for the container to use. You can use volumes to share data between services or other steps in a job. You can specify named Docker volumes, anonymous Docker volumes, or bind mounts on the host.\nTo specify a volume, you specify the source and destination path: <source>:<destinationPath>\nThe <source> is a volume name or an absolute path on the host machine, and <destinationPath> is an absolute path in the container."
"description": "Use `jobs.<job_id>.container.volumes` to set an array of volumes for the container to use. You can use volumes to share data between services or other steps in a job. You can specify named Docker volumes, anonymous Docker volumes, or bind mounts on the host."
},
"credentials": "container-registry-credentials"
}
@@ -2233,7 +2234,7 @@
]
},
"container-registry-credentials": {
"description": "If the image's container registry requires authentication to pull the image, you can use credentials to set a map of the username and password. The credentials are the same values that you would provide to the `docker login` command.",
"description": "If the image's container registry requires authentication to pull the image, you can use `jobs.<job_id>.container.credentials` to set a map of the username and password. The credentials are the same values that you would provide to the `docker login` command.",
"context": [
"github",
"inputs",
@@ -2249,7 +2250,7 @@
}
},
"container-env": {
"description": "Sets an array of environment variables in the container.",
"description": "Use `jobs.<job_id>.container.env` to set a map of variables in the container.",
"mapping": {
"loose-key-type": "non-empty-string",
"loose-value-type": "string-runner-context"
@@ -2442,13 +2443,13 @@
"string": {
"require-non-empty": true
},
"description": "You can override the default shell settings in the runner's operating system using the shell keyword. You can use built-in shell keywords, or you can define a custom set of shell options."
"description": "Use `shell` to override the default shell settings in the runner's operating system. You can use built-in shell keywords, or you can define a custom set of shell options. The shell command that is run internally executes a temporary file that contains the comands specified in `run`."
},
"working-directory": {
"string": {
"require-non-empty": true
},
"description": "Using the working-directory keyword, you can specify the working directory of where to run the command."
"description": "The `working-directory` keyword specifies the working directory where the command is run."
},
"cron-mapping": {
"mapping": {