schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
github-workflow.json | continue-on-error | Prevents a workflow run from failing when a job fails. Set to true to allow a workflow run to pass when this job fails. | {"oneOf": [{"type": "boolean"}, {}]} |
github-workflow.json | container | 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. | {"oneOf": [{"type": "string"}, {}]} |
github-workflow.json | services | Additional containers to host services for a job in a workflow. These are useful for creating databases or cache services like redis. The runner on the virtual machine will automatically create a network and manage the life cycle of the service containers.
When you use a service container for a job or your step uses container actions, you don't need to set port information to access the service. Docker automatically exposes all ports between containers on the same network.
When both the job and the action run in a container, you can directly reference the container by its hostname. The hostname is automatically mapped to the service name.
When a step does not use a container action, you must access the service using localhost and bind the ports. | {"type": "object", "additionalProperties": {}} |
github-workflow.json | concurrency | 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.
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. | {"oneOf": [{"type": "string"}, {}]} |
github-workflow.json | name | 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"} |
github-workflow.json | on | 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. | {"oneOf": [{}, {"type": "array", "items": {}, "minItems": 1}, {"type": "object", "properties": {"branch_protection_rule": {"properties": {"types": {"items": {"type": "string", "enum": ["created", "edited", "deleted"]}, "default": ["created", "edited", "deleted"]}}}, "check_run": {"properties": {"types": {"items": {"type": "string", "enum": ["created", "rerequested", "completed", "requested_action"]}, "default": ["created", "rerequested", "completed", "requested_action"]}}}, "check_suite": {"properties": {"types": {"items": {"type": "string", "enum": ["completed", "requested", "rerequested"]}, "default": ["completed", "requested", "rerequested"]}}}, "create": {}, "delete": {}, "deployment": {}, "deployment_status": {}, "discussion": {"properties": {"types": {"items": {"type": "string", "enum": ["created", "edited", "deleted", "transferred", "pinned", "unpinned", "labeled", "unlabeled", "locked", "unlocked", "category_changed", "answered", "unanswered"]}, "default": ["created", "edited", "deleted", "transferred", "pinned", "unpinned", "labeled", "unlabeled", "locked", "unlocked", "category_changed", "answered", "unanswered"]}}}, "discussion_comment": {"properties": {"types": {"items": {"type": "string", "enum": ["created", "edited", "deleted"]}, "default": ["created", "edited", "deleted"]}}}, "fork": {}, "gollum": {}, "issue_comment": {"properties": {"types": {"items": {"type": "string", "enum": ["created", "edited", "deleted"]}, "default": ["created", "edited", "deleted"]}}}, "issues": {"properties": {"types": {"items": {"type": "string", "enum": ["opened", "edited", "deleted", "transferred", "pinned", "unpinned", "closed", "reopened", "assigned", "unassigned", "labeled", "unlabeled", "locked", "unlocked", "milestoned", "demilestoned"]}, "default": ["opened", "edited", "deleted", "transferred", "pinned", "unpinned", "closed", "reopened", "assigned", "unassigned", "labeled", "unlabeled", "locked", "unlocked", "milestoned", "demilestoned"]}}}, "label": {"properties": {"types": {"items": {"type": "string", "enum": ["created", "edited", "deleted"]}, "default": ["created", "edited", "deleted"]}}}, "member": {"properties": {"types": {"items": {"type": "string", "enum": ["added", "edited", "deleted"]}, "default": ["added", "edited", "deleted"]}}}, "merge_group": {"properties": {"types": {"items": {"type": "string", "enum": ["checks_requested"]}, "default": ["checks_requested"]}}}, "milestone": {"properties": {"types": {"items": {"type": "string", "enum": ["created", "closed", "opened", "edited", "deleted"]}, "default": ["created", "closed", "opened", "edited", "deleted"]}}}, "page_build": {}, "project": {"properties": {"types": {"items": {"type": "string", "enum": ["created", "updated", "closed", "reopened", "edited", "deleted"]}, "default": ["created", "updated", "closed", "reopened", "edited", "deleted"]}}}, "project_card": {"properties": {"types": {"items": {"type": "string", "enum": ["created", "moved", "converted", "edited", "deleted"]}, "default": ["created", "moved", "converted", "edited", "deleted"]}}}, "project_column": {"properties": {"types": {"items": {"type": "string", "enum": ["created", "updated", "moved", "deleted"]}, "default": ["created", "updated", "moved", "deleted"]}}}, "public": {}, "pull_request": {"properties": {"types": {"items": {"type": "string", "enum": ["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"]}, "default": ["opened", "synchronize", "reopened"]}}, "patternProperties": {"^(branche|tag|path)s(-ignore)?$": {"type": "array"}}, "additionalProperties": false}, "pull_request_review": {"properties": {"types": {"items": {"type": "string", "enum": ["submitted", "edited", "dismissed"]}, "default": ["submitted", "edited", "dismissed"]}}}, "pull_request_review_comment": {"properties": {"types": {"items": {"type": "string", "enum": ["created", "edited", "deleted"]}, "default": ["created", "edited", "deleted"]}}}, "pull_request_target": {"properties": {"types": {"items": {"type": "string", "enum": ["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"]}, "default": ["opened", "synchronize", "reopened"]}}, "patternProperties": {"^(branche|tag|path)s(-ignore)?$": {}}, "additionalProperties": false}, "push": {"patternProperties": {"^(branche|tag|path)s(-ignore)?$": {"items": {"type": "string"}, "type": "array"}}, "additionalProperties": false}, "registry_package": {"properties": {"types": {"items": {"type": "string", "enum": ["published", "updated"]}, "default": ["published", "updated"]}}}, "release": {"properties": {"types": {"items": {"type": "string", "enum": ["published", "unpublished", "created", "edited", "deleted", "prereleased", "released"]}, "default": ["published", "unpublished", "created", "edited", "deleted", "prereleased", "released"]}}}, "status": {}, "watch": {}, "workflow_call": {"properties": {"inputs": {"type": "object", "patternProperties": {"^[_a-zA-Z][a-zA-Z0-9_-]*$": {"type": "object", "properties": {"deprecationMessage": {"type": "string"}, "required": {"type": "boolean"}, "type": {"type": "string", "enum": ["boolean", "number", "string"]}, "default": {"type": ["boolean", "number", "string"]}}, "required": ["type"], "additionalProperties": false}}, "additionalProperties": false}, "secrets": {"patternProperties": {"^[_a-zA-Z][a-zA-Z0-9_-]*$": {"properties": {"required": {"type": "boolean"}}, "required": ["required"], "additionalProperties": false}}, "additionalProperties": false}}}, "workflow_dispatch": {"properties": {"inputs": {"type": "object", "patternProperties": {"^[_a-zA-Z][a-zA-Z0-9_-]*$": {"type": "object", "properties": {"deprecationMessage": {"type": "string"}, "required": {"type": "boolean"}, "default": {}, "type": {"type": "string", "enum": ["string", "choice", "boolean", "number", "environment"]}, "options": {"type": "array", "items": {"type": "string"}, "minItems": 1}}, "allOf": [{"if": {"properties": {"type": {"const": "string"}}, "required": ["type"]}, "then": {"properties": {"default": {"type": "string"}}}}, {"if": {"properties": {"type": {"const": "boolean"}}, "required": ["type"]}, "then": {"properties": {"default": {"type": "boolean"}}}}, {"if": {"properties": {"type": {"const": "number"}}, "required": ["type"]}, "then": {"properties": {"default": {"type": "number"}}}}, {"if": {"properties": {"type": {"const": "environment"}}, "required": ["type"]}, "then": {"properties": {"default": {"type": "string"}}}}, {"if": {"properties": {"type": {"const": "choice"}}, "required": ["type"]}, "then": {"required": ["options"]}}], "required": ["description"], "additionalProperties": false}}, "additionalProperties": false}}}, "workflow_run": {"properties": {"types": {"items": {"type": "string", "enum": ["requested", "completed"]}, "default": ["requested", "completed"]}, "workflows": {"type": "array", "items": {"type": "string"}, "minItems": 1}}, "patternProperties": {"^branches(-ignore)?$": {}}}, "repository_dispatch": {}, "schedule": {"type": "array", "items": {"properties": {"cron": {"type": "string", "pattern": "^(((\\d+,)+\\d+|((\\d+|\\*)/\\d+|((JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC)(-(JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC))?))|(\\d+-\\d+)|\\d+(-\\d+)?/\\d+(-\\d+)?|\\d+|\\*|(MON|TUE|WED|THU|FRI|SAT|SUN)(-(MON|TUE|WED|THU|FRI|SAT|SUN))?) ?){5}$"}}, "additionalProperties": false}, "minItems": 1}}, "additionalProperties": false}]} |
github-workflow.json | branch_protection_rule | Runs your workflow anytime the branch_protection_rule event occurs. More than one activity type triggers this event. | {"properties": {"types": {"items": {"type": "string", "enum": ["created", "edited", "deleted"]}, "default": ["created", "edited", "deleted"]}}} |
github-workflow.json | check_run | Runs your workflow anytime the check_run event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/checks/runs. | {"properties": {"types": {"items": {"type": "string", "enum": ["created", "rerequested", "completed", "requested_action"]}, "default": ["created", "rerequested", "completed", "requested_action"]}}} |
github-workflow.json | check_suite | Runs your workflow anytime the check_suite event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/checks/suites/. | {"properties": {"types": {"items": {"type": "string", "enum": ["completed", "requested", "rerequested"]}, "default": ["completed", "requested", "rerequested"]}}} |
github-workflow.json | create | Runs your workflow anytime someone creates a branch or tag, which triggers the create event. For information about the REST API, see https://developer.github.com/v3/git/refs/#create-a-reference. | {} |
github-workflow.json | delete | Runs your workflow anytime someone deletes a branch or tag, which triggers the delete event. For information about the REST API, see https://developer.github.com/v3/git/refs/#delete-a-reference. | {} |
github-workflow.json | deployment | Runs your workflow anytime someone creates a deployment, which triggers the deployment event. Deployments created with a commit SHA may not have a Git ref. For information about the REST API, see https://developer.github.com/v3/repos/deployments/. | {} |
github-workflow.json | deployment_status | Runs your workflow anytime a third party provides a deployment status, which triggers the deployment_status event. Deployments created with a commit SHA may not have a Git ref. For information about the REST API, see https://developer.github.com/v3/repos/deployments/#create-a-deployment-status. | {} |
github-workflow.json | discussion | Runs your workflow anytime the discussion event occurs. More than one activity type triggers this event. For information about the GraphQL API, see https://docs.github.com/en/graphql/guides/using-the-graphql-api-for-discussions | {"properties": {"types": {"items": {"type": "string", "enum": ["created", "edited", "deleted", "transferred", "pinned", "unpinned", "labeled", "unlabeled", "locked", "unlocked", "category_changed", "answered", "unanswered"]}, "default": ["created", "edited", "deleted", "transferred", "pinned", "unpinned", "labeled", "unlabeled", "locked", "unlocked", "category_changed", "answered", "unanswered"]}}} |
github-workflow.json | discussion_comment | Runs your workflow anytime the discussion_comment event occurs. More than one activity type triggers this event. For information about the GraphQL API, see https://docs.github.com/en/graphql/guides/using-the-graphql-api-for-discussions | {"properties": {"types": {"items": {"type": "string", "enum": ["created", "edited", "deleted"]}, "default": ["created", "edited", "deleted"]}}} |
github-workflow.json | fork | Runs your workflow anytime when someone forks a repository, which triggers the fork event. For information about the REST API, see https://developer.github.com/v3/repos/forks/#create-a-fork. | {} |
github-workflow.json | gollum | Runs your workflow when someone creates or updates a Wiki page, which triggers the gollum event. | {} |
github-workflow.json | issue_comment | Runs your workflow anytime the issue_comment event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/issues/comments/. | {"properties": {"types": {"items": {"type": "string", "enum": ["created", "edited", "deleted"]}, "default": ["created", "edited", "deleted"]}}} |
github-workflow.json | issues | Runs your workflow anytime the issues event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/issues. | {"properties": {"types": {"items": {"type": "string", "enum": ["opened", "edited", "deleted", "transferred", "pinned", "unpinned", "closed", "reopened", "assigned", "unassigned", "labeled", "unlabeled", "locked", "unlocked", "milestoned", "demilestoned"]}, "default": ["opened", "edited", "deleted", "transferred", "pinned", "unpinned", "closed", "reopened", "assigned", "unassigned", "labeled", "unlabeled", "locked", "unlocked", "milestoned", "demilestoned"]}}} |
github-workflow.json | label | Runs your workflow anytime the label event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/issues/labels/. | {"properties": {"types": {"items": {"type": "string", "enum": ["created", "edited", "deleted"]}, "default": ["created", "edited", "deleted"]}}} |
github-workflow.json | member | 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": {"items": {"type": "string", "enum": ["added", "edited", "deleted"]}, "default": ["added", "edited", "deleted"]}}} |
github-workflow.json | merge_group | Runs your workflow when a pull request is added to a merge queue, which adds the pull request to a merge group. For information about the merge queue, see https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request-with-a-merge-queue . | {"properties": {"types": {"items": {"type": "string", "enum": ["checks_requested"]}, "default": ["checks_requested"]}}} |
github-workflow.json | milestone | Runs your workflow anytime the milestone event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/issues/milestones/. | {"properties": {"types": {"items": {"type": "string", "enum": ["created", "closed", "opened", "edited", "deleted"]}, "default": ["created", "closed", "opened", "edited", "deleted"]}}} |
github-workflow.json | page_build | Runs your workflow anytime someone pushes to a GitHub Pages-enabled branch, which triggers the page_build event. For information about the REST API, see https://developer.github.com/v3/repos/pages/. | {} |
github-workflow.json | project | Runs your workflow anytime the project event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/projects/. | {"properties": {"types": {"items": {"type": "string", "enum": ["created", "updated", "closed", "reopened", "edited", "deleted"]}, "default": ["created", "updated", "closed", "reopened", "edited", "deleted"]}}} |
github-workflow.json | project_card | Runs your workflow anytime the project_card event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/projects/cards. | {"properties": {"types": {"items": {"type": "string", "enum": ["created", "moved", "converted", "edited", "deleted"]}, "default": ["created", "moved", "converted", "edited", "deleted"]}}} |
github-workflow.json | project_column | Runs your workflow anytime the project_column event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/projects/columns. | {"properties": {"types": {"items": {"type": "string", "enum": ["created", "updated", "moved", "deleted"]}, "default": ["created", "updated", "moved", "deleted"]}}} |
github-workflow.json | public | Runs your workflow anytime someone makes a private repository public, which triggers the public event. For information about the REST API, see https://developer.github.com/v3/repos/#edit. | {} |
github-workflow.json | pull_request | Runs your workflow anytime the pull_request event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/pulls.
Note: Workflows do not run on private base repositories when you open a pull request from a forked repository.
When you create a pull request from a forked repository to the base repository, GitHub sends the pull_request event to the base repository and no pull request events occur on the forked repository.
Workflows don't run on forked repositories by default. You must enable GitHub Actions in the Actions tab of the forked repository.
The permissions for the GITHUB_TOKEN in forked repositories is read-only. For more information about the GITHUB_TOKEN, see https://help.github.com/en/articles/virtual-environments-for-github-actions. | {"properties": {"types": {"items": {"type": "string", "enum": ["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"]}, "default": ["opened", "synchronize", "reopened"]}}, "patternProperties": {"^(branche|tag|path)s(-ignore)?$": {"type": "array"}}, "additionalProperties": false} |
github-workflow.json | pull_request_review | Runs your workflow anytime the pull_request_review event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/pulls/reviews.
Note: Workflows do not run on private base repositories when you open a pull request from a forked repository.
When you create a pull request from a forked repository to the base repository, GitHub sends the pull_request event to the base repository and no pull request events occur on the forked repository.
Workflows don't run on forked repositories by default. You must enable GitHub Actions in the Actions tab of the forked repository.
The permissions for the GITHUB_TOKEN in forked repositories is read-only. For more information about the GITHUB_TOKEN, see https://help.github.com/en/articles/virtual-environments-for-github-actions. | {"properties": {"types": {"items": {"type": "string", "enum": ["submitted", "edited", "dismissed"]}, "default": ["submitted", "edited", "dismissed"]}}} |
github-workflow.json | pull_request_review_comment | Runs your workflow anytime a comment on a pull request's unified diff is modified, which triggers the pull_request_review_comment event. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/pulls/comments.
Note: Workflows do not run on private base repositories when you open a pull request from a forked repository.
When you create a pull request from a forked repository to the base repository, GitHub sends the pull_request event to the base repository and no pull request events occur on the forked repository.
Workflows don't run on forked repositories by default. You must enable GitHub Actions in the Actions tab of the forked repository.
The permissions for the GITHUB_TOKEN in forked repositories is read-only. For more information about the GITHUB_TOKEN, see https://help.github.com/en/articles/virtual-environments-for-github-actions. | {"properties": {"types": {"items": {"type": "string", "enum": ["created", "edited", "deleted"]}, "default": ["created", "edited", "deleted"]}}} |
github-workflow.json | pull_request_target | This event is similar to pull_request, except that it runs in the context of the base repository of the pull request, rather than in the merge commit. This means that you can more safely make your secrets available to the workflows triggered by the pull request, because only workflows defined in the commit on the base repository are run. For example, this event allows you to create workflows that label and comment on pull requests, based on the contents of the event payload. | {"properties": {"types": {"items": {"type": "string", "enum": ["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"]}, "default": ["opened", "synchronize", "reopened"]}}, "patternProperties": {"^(branche|tag|path)s(-ignore)?$": {}}, "additionalProperties": false} |
github-workflow.json | push | Runs your workflow when someone pushes to a repository branch, which triggers the push event.
Note: The webhook payload available to GitHub Actions does not include the added, removed, and modified attributes in the commit object. You can retrieve the full commit object using the REST API. For more information, see https://developer.github.com/v3/repos/commits/#get-a-single-commit. | {"patternProperties": {"^(branche|tag|path)s(-ignore)?$": {"items": {"type": "string"}, "type": "array"}}, "additionalProperties": false} |
github-workflow.json | registry_package | Runs your workflow anytime a package is published or updated. For more information, see https://help.github.com/en/github/managing-packages-with-github-packages. | {"properties": {"types": {"items": {"type": "string", "enum": ["published", "updated"]}, "default": ["published", "updated"]}}} |
github-workflow.json | release | Runs your workflow anytime the release event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/repos/releases/ in the GitHub Developer documentation. | {"properties": {"types": {"items": {"type": "string", "enum": ["published", "unpublished", "created", "edited", "deleted", "prereleased", "released"]}, "default": ["published", "unpublished", "created", "edited", "deleted", "prereleased", "released"]}}} |
github-workflow.json | status | Runs your workflow anytime the status of a Git commit changes, which triggers the status event. For information about the REST API, see https://developer.github.com/v3/repos/statuses/. | {} |
github-workflow.json | watch | Runs your workflow anytime the watch event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/activity/starring/. | {} |
github-workflow.json | workflow_call | Allows workflows to be reused by other workflows. | {"properties": {"inputs": {"type": "object", "patternProperties": {"^[_a-zA-Z][a-zA-Z0-9_-]*$": {"type": "object", "properties": {"deprecationMessage": {"type": "string"}, "required": {"type": "boolean"}, "type": {"type": "string", "enum": ["boolean", "number", "string"]}, "default": {"type": ["boolean", "number", "string"]}}, "required": ["type"], "additionalProperties": false}}, "additionalProperties": false}, "secrets": {"patternProperties": {"^[_a-zA-Z][a-zA-Z0-9_-]*$": {"properties": {"required": {"type": "boolean"}}, "required": ["required"], "additionalProperties": false}}, "additionalProperties": false}}} |
github-workflow.json | inputs | When using the workflow_call keyword, you can optionally specify inputs that are passed to the called workflow from the caller workflow. | {"type": "object", "patternProperties": {"^[_a-zA-Z][a-zA-Z0-9_-]*$": {"type": "object", "properties": {"deprecationMessage": {"type": "string"}, "required": {"type": "boolean"}, "type": {"type": "string", "enum": ["boolean", "number", "string"]}, "default": {"type": ["boolean", "number", "string"]}}, "required": ["type"], "additionalProperties": false}}, "additionalProperties": false} |
github-workflow.json | ^[_a-zA-Z][a-zA-Z0-9_-]*$ | A string identifier to associate with the input. The value of <input_id> is a map of the input's metadata. The <input_id> must be a unique identifier within the inputs object. The <input_id> must start with a letter or _ and contain only alphanumeric characters, -, or _. | {"type": "object", "properties": {"deprecationMessage": {"type": "string"}, "required": {"type": "boolean"}, "type": {"type": "string", "enum": ["boolean", "number", "string"]}, "default": {"type": ["boolean", "number", "string"]}}, "required": ["type"], "additionalProperties": false} |
github-workflow.json | description | A string description of the input parameter. | {"type": "string"} |
github-workflow.json | deprecationMessage | A string shown to users using the deprecated input. | {"type": "string"} |
github-workflow.json | required | A boolean to indicate whether the action requires the input parameter. Set to true when the parameter is required. | {"type": "boolean"} |
github-workflow.json | type | 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. | {"type": "string", "enum": ["boolean", "number", "string"]} |
github-workflow.json | default | The default value is used when an input parameter isn't specified in a workflow file. | {"type": ["boolean", "number", "string"]} |
github-workflow.json | secrets | 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. | {"patternProperties": {"^[_a-zA-Z][a-zA-Z0-9_-]*$": {"properties": {"required": {"type": "boolean"}}, "required": ["required"], "additionalProperties": false}}, "additionalProperties": false} |
github-workflow.json | ^[_a-zA-Z][a-zA-Z0-9_-]*$ | A string identifier to associate with the secret. | {"properties": {"required": {"type": "boolean"}}, "required": ["required"], "additionalProperties": false} |
github-workflow.json | description | A string description of the secret parameter. | {"type": "string"} |
github-workflow.json | required | A boolean specifying whether the secret must be supplied. | {"type": "boolean"} |
github-workflow.json | workflow_dispatch | 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. | {"properties": {"inputs": {"type": "object", "patternProperties": {"^[_a-zA-Z][a-zA-Z0-9_-]*$": {"type": "object", "properties": {"deprecationMessage": {"type": "string"}, "required": {"type": "boolean"}, "default": {}, "type": {"type": "string", "enum": ["string", "choice", "boolean", "number", "environment"]}, "options": {"type": "array", "items": {"type": "string"}, "minItems": 1}}, "allOf": [{"if": {"properties": {"type": {"const": "string"}}, "required": ["type"]}, "then": {"properties": {"default": {"type": "string"}}}}, {"if": {"properties": {"type": {"const": "boolean"}}, "required": ["type"]}, "then": {"properties": {"default": {"type": "boolean"}}}}, {"if": {"properties": {"type": {"const": "number"}}, "required": ["type"]}, "then": {"properties": {"default": {"type": "number"}}}}, {"if": {"properties": {"type": {"const": "environment"}}, "required": ["type"]}, "then": {"properties": {"default": {"type": "string"}}}}, {"if": {"properties": {"type": {"const": "choice"}}, "required": ["type"]}, "then": {"required": ["options"]}}], "required": ["description"], "additionalProperties": false}}, "additionalProperties": false}}} |
github-workflow.json | inputs | 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. | {"type": "object", "patternProperties": {"^[_a-zA-Z][a-zA-Z0-9_-]*$": {"type": "object", "properties": {"deprecationMessage": {"type": "string"}, "required": {"type": "boolean"}, "default": {}, "type": {"type": "string", "enum": ["string", "choice", "boolean", "number", "environment"]}, "options": {"type": "array", "items": {"type": "string"}, "minItems": 1}}, "allOf": [{"if": {"properties": {"type": {"const": "string"}}, "required": ["type"]}, "then": {"properties": {"default": {"type": "string"}}}}, {"if": {"properties": {"type": {"const": "boolean"}}, "required": ["type"]}, "then": {"properties": {"default": {"type": "boolean"}}}}, {"if": {"properties": {"type": {"const": "number"}}, "required": ["type"]}, "then": {"properties": {"default": {"type": "number"}}}}, {"if": {"properties": {"type": {"const": "environment"}}, "required": ["type"]}, "then": {"properties": {"default": {"type": "string"}}}}, {"if": {"properties": {"type": {"const": "choice"}}, "required": ["type"]}, "then": {"required": ["options"]}}], "required": ["description"], "additionalProperties": false}}, "additionalProperties": false} |
github-workflow.json | ^[_a-zA-Z][a-zA-Z0-9_-]*$ | A string identifier to associate with the input. The value of <input_id> is a map of the input's metadata. The <input_id> must be a unique identifier within the inputs object. The <input_id> must start with a letter or _ and contain only alphanumeric characters, -, or _. | {"type": "object", "properties": {"deprecationMessage": {"type": "string"}, "required": {"type": "boolean"}, "default": {}, "type": {"type": "string", "enum": ["string", "choice", "boolean", "number", "environment"]}, "options": {"type": "array", "items": {"type": "string"}, "minItems": 1}}, "allOf": [{"if": {"properties": {"type": {"const": "string"}}, "required": ["type"]}, "then": {"properties": {"default": {"type": "string"}}}}, {"if": {"properties": {"type": {"const": "boolean"}}, "required": ["type"]}, "then": {"properties": {"default": {"type": "boolean"}}}}, {"if": {"properties": {"type": {"const": "number"}}, "required": ["type"]}, "then": {"properties": {"default": {"type": "number"}}}}, {"if": {"properties": {"type": {"const": "environment"}}, "required": ["type"]}, "then": {"properties": {"default": {"type": "string"}}}}, {"if": {"properties": {"type": {"const": "choice"}}, "required": ["type"]}, "then": {"required": ["options"]}}], "required": ["description"], "additionalProperties": false} |
github-workflow.json | description | A string description of the input parameter. | {"type": "string"} |
github-workflow.json | deprecationMessage | A string shown to users using the deprecated input. | {"type": "string"} |
github-workflow.json | required | A boolean to indicate whether the action requires the input parameter. Set to true when the parameter is required. | {"type": "boolean"} |
github-workflow.json | default | A string representing the default value. The default value is used when an input parameter isn't specified in a workflow file. | {} |
github-workflow.json | type | A string representing the type of the input. | {"type": "string", "enum": ["string", "choice", "boolean", "number", "environment"]} |
github-workflow.json | options | The options of the dropdown list, if the type is a choice. | {"type": "array", "items": {"type": "string"}, "minItems": 1} |
github-workflow.json | workflow_run | This event occurs when a workflow run is requested or completed, and allows you to execute a workflow based on the finished result of another workflow. For example, if your pull_request workflow generates build artifacts, you can create a new workflow that uses workflow_run to analyze the results and add a comment to the original pull request. | {"properties": {"types": {"items": {"type": "string", "enum": ["requested", "completed"]}, "default": ["requested", "completed"]}, "workflows": {"type": "array", "items": {"type": "string"}, "minItems": 1}}, "patternProperties": {"^branches(-ignore)?$": {}}} |
github-workflow.json | repository_dispatch | 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. | {} |
github-workflow.json | schedule | You can schedule a workflow to run at specific UTC times using POSIX cron syntax (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/crontab.html#tag_20_25_07). 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.
Note: GitHub Actions does not support the non-standard syntax @yearly, @monthly, @weekly, @daily, @hourly, and @reboot.
You can use crontab guru (https://crontab.guru/). to help generate your cron syntax and confirm what time it will run. To help you get started, there is also a list of crontab guru examples (https://crontab.guru/examples.html). | {"type": "array", "items": {"properties": {"cron": {"type": "string", "pattern": "^(((\\d+,)+\\d+|((\\d+|\\*)/\\d+|((JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC)(-(JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC))?))|(\\d+-\\d+)|\\d+(-\\d+)?/\\d+(-\\d+)?|\\d+|\\*|(MON|TUE|WED|THU|FRI|SAT|SUN)(-(MON|TUE|WED|THU|FRI|SAT|SUN))?) ?){5}$"}}, "additionalProperties": false}, "minItems": 1} |
github-workflow.json | env | A map of environment variables that are available to all jobs and steps in the workflow. | {} |
github-workflow.json | defaults | A map of default settings that will apply to all jobs in the workflow. | {} |
github-workflow.json | concurrency | 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.
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. | {"oneOf": [{"type": "string"}, {}]} |
github-workflow.json | jobs | 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. | {"type": "object", "patternProperties": {"^[_a-zA-Z][a-zA-Z0-9_-]*$": {"oneOf": [{}, {}]}}, "minProperties": 1, "additionalProperties": false} |
github-workflow.json | run-name | 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. | {"type": "string"} |
jsonld.json | @context | Used to define the short-hand names that are used throughout a JSON-LD document. | {"type": ["object", "string", "array", "null"]} |
jsonld.json | @graph | Used to express a graph. | {"anyOf": [{"type": "array", "items": {}}, {"type": "object"}]} |
jsonld.json | @id | Used to uniquely identify things that are being described in the document with IRIs or blank node identifiers. | {"type": "string", "format": "uri"} |
jsonld.json | @value | Used to specify the data that is associated with a particular property in the graph. | {"type": ["string", "boolean", "number", "null"]} |
jsonld.json | @language | Used to specify the language for a particular string value or the default language of a JSON-LD document. | {"type": ["string", "null"]} |
jsonld.json | @type | Used to set the data type of a node or typed value. | {"type": ["string", "null", "array"]} |
jsonld.json | @container | Used to set the default container type for a term. | {"type": ["string", "null"], "enum": ["@language", "@list", "@index", "@set"]} |
jsonld.json | @list | Used to express an ordered set of data. | {} |
jsonld.json | @set | Used to express an unordered set of data and to ensure that values are always represented as arrays. | {} |
jsonld.json | @reverse | Used to express reverse properties. | {"type": ["string", "object", "null"], "additionalProperties": {"anyOf": [{}]}} |
jsonld.json | @base | Used to set the base IRI against which relative IRIs are resolved | {"type": ["string", "null"], "format": "uri"} |
jsonld.json | @vocab | Used to expand properties and values in @type with a common prefix IRI | {"type": ["string", "null"], "format": "uri"} |
meta-runtime.json | See https://docs.ansible.com/ansible/devel/dev_guide/developing_collections_structure.html#meta-directory | {"$defs": {"ActionGroup": {"items": {"oneOf": [{"type": "string"}, {}]}, "type": "array"}, "Metadata": {"properties": {"metadata": {"properties": {"extend_group": {"items": {"type": "string"}, "type": "array"}}, "type": "object"}}, "type": "object"}, "Redirect": {"properties": {"redirect": {"type": "string"}}, "type": "object"}}, "$schema": "http://json-schema.org/draft-07/schema", "additionalProperties": false, "examples": ["**/meta/runtime.yml"], "properties": {"action_groups": {"additionalProperties": {}, "type": "object"}, "import_redirection": {"additionalProperties": {}, "type": "object"}, "plugin_routing": {"properties": {"inventory": {}, "module_utils": {}, "modules": {}}, "type": "object"}, "requires_ansible": {"examples": [">=2.10,<2.11"], "pattern": "^[^\\s]*$", "type": "string"}}, "type": "object"} |
|
meta-runtime.json | action_groups | A mapping of groups and the list of action plugin and module names they contain. They may also have a special ‘metadata’ dictionary in the list, which can be used to include actions from other groups. | {"additionalProperties": {}, "type": "object"} |
meta-runtime.json | import_redirection | A mapping of names for Python import statements and their redirected locations. | {"additionalProperties": {}, "type": "object"} |
coffeelint.json | level | Determines the error level | {"type": "string", "enum": ["error", "warn", "ignore"]} |
coffeelint.json | arrow_spacing | This rule checks to see that there is spacing before and after the arrow operator that declares a function. [default level: ignore] | {"allOf": [{}]} |
coffeelint.json | braces_spacing | This rule checks to see that there is the proper spacing inside curly braces. The spacing amount is specified by `spaces`. The spacing amount for empty objects is specified by `empty_object_spaces`. [default level: ignore] | {"allOf": [{}], "properties": {"empty_object_spaces": {"type": "integer", "enum": [0, 1]}, "spaces": {"type": "integer", "enum": [0, 1]}}} |
coffeelint.json | camel_case_classes | This rule mandates that all class names are CamelCased. Camel casing class names is a generally accepted way of distinguishing constructor functions - which require the `new` prefix to behave properly - from plain old functions. [default level: error] | {"allOf": [{}]} |
coffeelint.json | coffeescript_error | [default level: error] | {"allOf": [{}]} |
coffeelint.json | colon_assignment_spacing | This rule checks to see that there is spacing before and after the colon in a colon assignment (i.e., classes, objects). [default level: ignore] | {"allOf": [{}], "properties": {"spacing": {"type": "object", "properties": {"left": {"type": "integer", "enum": [0, 1]}, "right": {"type": "integer", "enum": [0, 1]}}}}} |
coffeelint.json | cyclomatic_complexity | Examine the complexity of your application. [default level: ignore] | {"allOf": [{}], "properties": {"value": {"type": "integer"}}} |
coffeelint.json | duplicate_key | Prevents defining duplicate keys in object literals and classes. [default level: error] | {"allOf": [{}]} |
coffeelint.json | empty_constructor_needs_parens | Requires constructors with no parameters to include the parens. [default level: ignore] | {"allOf": [{}]} |
coffeelint.json | ensure_comprehensions | This rule makes sure that parentheses are around comprehensions. [default level: warn] | {"allOf": [{}]} |
coffeelint.json | eol_last | Checks that the file ends with a single newline. [default level: ignore] | {"allOf": [{}]} |
coffeelint.json | indentation | This rule imposes a standard number of spaces to be used for indentation. Since whitespace is significant in CoffeeScript, it's critical that a project chooses a standard indentation format and stays consistent. Other roads lead to darkness. [default level: error] | {"allOf": [{}], "properties": {"value": {"type": "integer", "enum": [2, 4]}}} |
coffeelint.json | line_endings | This rule ensures your project uses only windows or unix line endings. [default level: ignore] | {"allOf": [{}], "properties": {"value": {"type": "string", "enum": ["unix", "windows"]}}} |
coffeelint.json | max_line_length | This rule imposes a maximum line length on your code. [default level: error] | {"allOf": [{}], "properties": {"value": {"type": "integer"}, "limitComments": {"type": "boolean"}}} |
coffeelint.json | missing_fat_arrows | Warns when you use `this` inside a function that wasn't defined with a fat arrow. This rule does not apply to methods defined in a class, since they have `this` bound to the class instance (or the class itself, for class methods). [default level: ignore] | {"allOf": [{}]} |
coffeelint.json | newlines_after_classes | Checks the number of newlines between classes and other code. [default level: ignore] | {"allOf": [{}], "properties": {"value": {"type": "integer"}}} |
coffeelint.json | no_backticks | Backticks allow snippets of JavaScript to be embedded in CoffeeScript. While some folks consider backticks useful in a few niche circumstances, they should be avoided because so none of JavaScript's 'bad parts', like with and eval, sneak into CoffeeScript. [default level: error] | {"allOf": [{}]} |
coffeelint.json | no_debugger | This rule detects the `debugger` statement. [default level: warn] | {"allOf": [{}]} |
coffeelint.json | no_empty_functions | Disallows declaring empty functions. The goal of this rule is that unintentional empty callbacks can be detected. [default level: ignore] | {"allOf": [{}]} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.