schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
nest-cli.json | configuration | Generate spec file for configuration schematics or not. | {"type": "boolean"} |
nest-cli.json | config | Alias for configuration | {"type": "boolean"} |
nest-cli.json | controller | Generate spec file for controller schematics or not. | {"type": "boolean"} |
nest-cli.json | co | Alias for controller | {"type": "boolean"} |
nest-cli.json | decorator | Generate spec file for decorator schematics or not. | {"type": "boolean"} |
nest-cli.json | d | Alias fro decorator | {"type": "boolean"} |
nest-cli.json | filter | Generate spec file for filter schematics or not. | {"type": "boolean"} |
nest-cli.json | f | Alias for filter | {"type": "boolean"} |
nest-cli.json | gateway | Generate spec file for gateway schematics or not. | {"type": "boolean"} |
nest-cli.json | ga | Alias for gateway | {"type": "boolean"} |
nest-cli.json | guard | Generate spec file for guard schematics or not. | {"type": "boolean"} |
nest-cli.json | gu | Alias for guard | {"type": "boolean"} |
nest-cli.json | interceptor | Generate spec file for interceptor schematics or not. | {"type": "boolean"} |
nest-cli.json | in | Alias for interceptor | {"type": "boolean"} |
nest-cli.json | interface | Generate spec file for interface schematics or not. | {"type": "boolean"} |
nest-cli.json | middleware | Generate spec file for middleware schematics or not. | {"type": "boolean"} |
nest-cli.json | mi | Alias for middleware | {"type": "boolean"} |
nest-cli.json | module | Generate spec file for module schematics or not. | {"type": "boolean"} |
nest-cli.json | mo | Alias for module | {"type": "boolean"} |
nest-cli.json | pipe | Generate spec file for pipe schematics or not. | {"type": "boolean"} |
nest-cli.json | pi | Alias for pipe | {"type": "boolean"} |
nest-cli.json | provider | Generate spec file for provider schematics or not. | {"type": "boolean"} |
nest-cli.json | pr | Alias for provider | {"type": "boolean"} |
nest-cli.json | resolver | Generate spec file for resolver schematics or not. | {"type": "boolean"} |
nest-cli.json | r | Alias for resolver | {"type": "boolean"} |
nest-cli.json | service | Generate spec file for service schematics or not. | {"type": "boolean"} |
nest-cli.json | s | Alias for resolver | {"type": "boolean"} |
nest-cli.json | library | Generate spec file for library schematics or not. | {"type": "boolean"} |
nest-cli.json | lib | Alias for library | {"type": "boolean"} |
nest-cli.json | sub-app | Generate spec file for sub-app schematics or not. | {"type": "boolean"} |
nest-cli.json | app | Alias for sub-app | {"type": "boolean"} |
nest-cli.json | resource | Generate spec file for resource schematics or not. | {"type": "boolean"} |
nest-cli.json | res | Alias for resource | {"type": "boolean"} |
nest-cli.json | GenerateBaseDirOptions | Base directory | {"type": "string", "default": ""} |
nest-cli.json | name | The npm package name of the cli plugin, eg @nestjs/swagger. | {"type": "string"} |
nest-cli.json | introspectComments | If set to true, plugin will generate descriptions and example values for properties based on comments. | {"type": "boolean", "default": true} |
nest-cli.json | typeFileNameSuffix | (GraphQL Only) GraphQL types files suffix. Default value: ['.input.ts', '.args.ts', '.entity.ts', '.model.ts']. See https://docs.nestjs.com/graphql/cli-plugin#using-the-cli-plugin for details. | {"type": "array", "default": [".input.ts", ".args.ts", ".entity.ts", ".model.ts"]} |
nest-cli.json | dtoFileNameSuffix | (Swagger Only) DTO (Data Transfer Object) files suffix. Default value: ['.dto.ts', '.entity.ts']. See https://docs.nestjs.com/openapi/cli-plugin#using-the-cli-plugin for details | {"type": "array", "items": {"type": "string"}, "default": [".dto.ts", ".entity.ts"]} |
nest-cli.json | controllerFileNameSuffix | (Swagger Only) Controller files suffix. See https://docs.nestjs.com/openapi/cli-plugin#using-the-cli-plugin for details | {"type": "string", "default": ".controller.ts"} |
nest-cli.json | classValidatorShim | (Swagger Only) If set to true, the module will reuse class-validator validation decorators (e.g. @Max(10) will add max: 10 to schema definition). See https://docs.nestjs.com/openapi/cli-plugin#using-the-cli-plugin for details | {"type": "boolean", "default": true} |
nest-cli.json | dtoKeyOfComment | (Swagger Only) The property key to set the comment text to on ApiProperty. See https://docs.nestjs.com/openapi/cli-plugin#using-the-cli-plugin for details | {"type": "string", "default": "description"} |
nest-cli.json | controllerKeyOfComment | (Swagger Only) The property key to set the comment text to on ApiOperation. See https://docs.nestjs.com/openapi/cli-plugin#using-the-cli-plugin for details | {"type": "string", "default": "description"} |
nest-cli.json | collection | Points at the collection of schematics used to generate components. you generally should not change this value. | {"type": "string", "default": "@nestjs/schematics"} |
nest-cli.json | sourceRoot | Points at the root of the source code for the single project in standard mode structures, or the default project in monorepo mode structures. | {"type": "string", "default": "src"} |
nest-cli.json | entryFile | The entry file where 'nest start' work with. Default to 'main'. | {"type": "string", "default": "main"} |
nest-cli.json | monorepo | (monorepo only) For a monorepo mode structure, this value is always true. | {"type": "boolean", "default": false} |
nest-cli.json | root | (monorepo only) Points at the project root of the default project. | {"type": "string", "default": ""} |
github-workflow.json | branch | When using the push and pull_request events, you can configure a workflow to run on specific branches or tags. If you only define only tags or only branches, the workflow won't run for events affecting the undefined Git ref.
The branches, branches-ignore, tags, and tags-ignore keywords accept glob patterns that use the * and ** wildcard characters to match more than one branch or tag name. For more information, see https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet.
The patterns defined in branches and tags are evaluated against the Git ref's name. For example, defining the pattern mona/octocat in branches will match the refs/heads/mona/octocat Git ref. The pattern releases/** will match the refs/heads/releases/10 Git ref.
You can use two types of filters to prevent a workflow from running on pushes and pull requests to tags and branches:
- branches or branches-ignore - You cannot use both the branches and branches-ignore filters for the same event in a workflow. Use the branches filter when you need to filter branches for positive matches and exclude branches. Use the branches-ignore filter when you only need to exclude branch names.
- tags or tags-ignore - You cannot use both the tags and tags-ignore filters for the same event in a workflow. Use the tags filter when you need to filter tags for positive matches and exclude tags. Use the tags-ignore filter when you only need to exclude tag names.
You can exclude tags and branches using the ! character. The order that you define patterns matters.
- A matching negative pattern (prefixed with !) after a positive match will exclude the Git ref.
- A matching positive pattern after a negative match will include the Git ref again. | {} |
github-workflow.json | group | 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. | {"type": "string"} |
github-workflow.json | cancel-in-progress | To cancel any currently running job or workflow in the same concurrency group, specify cancel-in-progress: true. | {"oneOf": [{"type": "boolean"}, {}]} |
github-workflow.json | image | The Docker image to use as the container to run the action. The value can be the Docker Hub image name or a registry name. | {"type": "string"} |
github-workflow.json | credentials | 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. | {"type": "object", "properties": {"username": {"type": "string"}, "password": {"type": "string"}}} |
github-workflow.json | env | Sets an array of environment variables in the container. | {} |
github-workflow.json | ports | Sets an array of ports to expose on the container. | {"type": "array", "items": {"oneOf": [{"type": "number"}, {"type": "string"}]}, "minItems": 1} |
github-workflow.json | volumes | 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.
To specify a volume, you specify the source and destination path: <source>:<destinationPath>
The <source> is a volume name or an absolute path on the host machine, and <destinationPath> is an absolute path in the container. | {"type": "array", "items": {"type": "string", "pattern": "^[^:]+:[^:]+$"}, "minItems": 1} |
github-workflow.json | options | Additional Docker container resource options. For a list of options, see https://docs.docker.com/engine/reference/commandline/create/#options. | {"type": "string"} |
github-workflow.json | permissions | 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. | {"oneOf": [{"type": "string", "enum": ["read-all", "write-all"]}, {}]} |
github-workflow.json | env | 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 | {"oneOf": [{"type": "object", "additionalProperties": {"oneOf": [{"type": "string"}, {"type": "number"}, {"type": "boolean"}]}}, {}]} |
github-workflow.json | environment | The environment that the job references | {"type": "object", "properties": {"name": {"type": "string"}, "url": {"type": "string"}}, "required": ["name"], "additionalProperties": false} |
github-workflow.json | name | The name of the environment configured in the repo. | {"type": "string"} |
github-workflow.json | url | A deployment URL | {"type": "string"} |
github-workflow.json | path | When using the push and pull_request events, you can configure a workflow to run when at least one file does not match paths-ignore or at least one modified file matches the configured paths. Path filters are not evaluated for pushes to tags.
The paths-ignore and paths keywords accept glob patterns that use the * and ** wildcard characters to match more than one path name. For more information, see https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet.
You can exclude paths using two types of filters. You cannot use both of these filters for the same event in a workflow.
- paths-ignore - Use the paths-ignore filter when you only need to exclude path names.
- paths - Use the paths filter when you need to filter paths for positive matches and exclude paths. | {} |
github-workflow.json | shell | 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. | {"anyOf": [{"type": "string"}, {"type": "string", "enum": ["bash", "pwsh", "python", "sh", "cmd", "powershell"]}]} |
github-workflow.json | types | Selects the types of activity that will trigger a workflow run. Most GitHub events are triggered by more than one type of activity. For example, the event for the release resource is triggered when a release is published, unpublished, created, edited, deleted, or prereleased. The types keyword enables you to narrow down activity that causes the workflow to run. When only one activity type triggers a webhook event, the types keyword is unnecessary.
You can use an array of event types. For more information about each event and their activity types, see https://help.github.com/en/articles/events-that-trigger-workflows#webhook-events. | {"type": "array", "minItems": 1} |
github-workflow.json | working-directory | Using the working-directory keyword, you can specify the working directory of where to run the command. | {"type": "string"} |
github-workflow.json | jobNeeds | 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. | {"oneOf": [{"type": "array", "items": {}, "minItems": 1}, {}]} |
github-workflow.json | reusableWorkflowCallJob | 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 _. | {"type": "object", "properties": {"name": {"type": "string"}, "needs": {}, "permissions": {}, "if": {"type": ["boolean", "number", "string"]}, "uses": {"type": "string", "pattern": "^(.+/)+(.+)\\.(ya?ml)(@.+)?$"}, "with": {}, "secrets": {"oneOf": [{}, {"type": "string", "enum": ["inherit"]}]}, "strategy": {"type": "object", "properties": {"matrix": {"oneOf": [{"type": "object"}, {}], "patternProperties": {"^(in|ex)clude$": {"type": "array", "items": {"type": "object", "additionalProperties": {}}, "minItems": 1}}, "additionalProperties": {"oneOf": [{"type": "array", "items": {}, "minItems": 1}, {}]}, "minProperties": 1}, "fail-fast": {"type": "boolean", "default": true}, "max-parallel": {"type": ["number", "string"]}}, "required": ["matrix"], "additionalProperties": false}, "concurrency": {"oneOf": [{"type": "string"}, {}]}}, "required": ["uses"], "additionalProperties": false} |
github-workflow.json | name | The name of the job displayed on GitHub. | {"type": "string"} |
github-workflow.json | if | 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 ${{ }} syntax. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions. | {"type": ["boolean", "number", "string"]} |
github-workflow.json | uses | 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. | {"type": "string", "pattern": "^(.+/)+(.+)\\.(ya?ml)(@.+)?$"} |
github-workflow.json | with | 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. | {} |
github-workflow.json | secrets | 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. | {"oneOf": [{}, {"type": "string", "enum": ["inherit"]}]} |
github-workflow.json | strategy | A strategy creates a build matrix for your jobs. You can define different variations of an environment to run each job in. | {"type": "object", "properties": {"matrix": {"oneOf": [{"type": "object"}, {}], "patternProperties": {"^(in|ex)clude$": {"type": "array", "items": {"type": "object", "additionalProperties": {}}, "minItems": 1}}, "additionalProperties": {"oneOf": [{"type": "array", "items": {}, "minItems": 1}, {}]}, "minProperties": 1}, "fail-fast": {"type": "boolean", "default": true}, "max-parallel": {"type": ["number", "string"]}}, "required": ["matrix"], "additionalProperties": false} |
github-workflow.json | matrix | 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. | {"oneOf": [{"type": "object"}, {}], "patternProperties": {"^(in|ex)clude$": {"type": "array", "items": {"type": "object", "additionalProperties": {}}, "minItems": 1}}, "additionalProperties": {"oneOf": [{"type": "array", "items": {}, "minItems": 1}, {}]}, "minProperties": 1} |
github-workflow.json | fail-fast | When set to true, GitHub cancels all in-progress jobs if any matrix job fails. Default: true | {"type": "boolean", "default": true} |
github-workflow.json | max-parallel | 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. | {"type": ["number", "string"]} |
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 | normalJob | 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 _. | {"type": "object", "properties": {"name": {"type": "string"}, "needs": {}, "permissions": {}, "runs-on": {"oneOf": [{"type": "string", "enum": ["macos-10.15", "macos-11", "macos-12", "macos-12-xl", "macos-13", "macos-13-xl", "macos-latest", "macos-latest-xl", "self-hosted", "ubuntu-18.04", "ubuntu-20.04", "ubuntu-22.04", "ubuntu-latest", "ubuntu-latest-4-cores", "ubuntu-latest-8-cores", "ubuntu-latest-16-cores", "windows-2019", "windows-2022", "windows-latest", "windows-latest-8-cores"]}, {"type": "array", "anyOf": [{"items": [{"const": "self-hosted"}], "minItems": 1, "additionalItems": {"type": "string"}}, {"items": [{"const": "self-hosted"}, {}], "minItems": 2, "additionalItems": {"type": "string"}}, {"items": [{"const": "self-hosted"}, {}], "minItems": 2, "additionalItems": {"type": "string"}}, {"items": [{"const": "self-hosted"}, {}, {}], "minItems": 3, "additionalItems": {"type": "string"}}, {"items": [{"const": "self-hosted"}, {}, {}], "minItems": 3, "additionalItems": {"type": "string"}}, {"items": [{"const": "linux"}], "minItems": 2, "maxItems": 2, "additionalItems": {"type": "string"}}, {"items": [{"const": "windows"}], "minItems": 2, "maxItems": 2, "additionalItems": {"type": "string"}}]}, {"type": "object", "properties": {"group": {"type": "string"}, "labels": {"oneOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}]}}}, {}]}, "environment": {"oneOf": [{"type": "string"}, {}]}, "outputs": {"type": "object", "additionalProperties": {"type": "string"}, "minProperties": 1}, "env": {}, "defaults": {}, "if": {"type": ["boolean", "number", "string"]}, "steps": {"type": "array", "items": {"allOf": [{"oneOf": [{"type": "object", "properties": {"uses": {"type": "string"}}, "required": ["uses"]}, {"type": "object", "properties": {"run": {"type": "string"}}, "required": ["run"]}]}, {"type": "object", "properties": {"id": {"type": "string"}, "if": {"type": ["boolean", "number", "string"]}, "name": {"type": "string"}, "uses": {"type": "string"}, "run": {"type": "string"}, "working-directory": {}, "shell": {}, "with": {"properties": {"args": {"type": "string"}, "entrypoint": {"type": "string"}}}, "env": {}, "continue-on-error": {"oneOf": [{"type": "boolean"}, {}], "default": false}, "timeout-minutes": {"oneOf": [{"type": "number"}, {}]}}, "dependencies": {"working-directory": ["run"], "shell": ["run"]}, "additionalProperties": false}]}, "minItems": 1}, "timeout-minutes": {"oneOf": [{"type": "number"}, {}], "default": 360}, "strategy": {"type": "object", "properties": {"matrix": {"oneOf": [{"type": "object"}, {}], "patternProperties": {"^(in|ex)clude$": {"type": "array", "items": {"type": "object", "additionalProperties": {}}, "minItems": 1}}, "additionalProperties": {"oneOf": [{"type": "array", "items": {}, "minItems": 1}, {}]}, "minProperties": 1}, "fail-fast": {"type": "boolean", "default": true}, "max-parallel": {"type": ["number", "string"]}}, "required": ["matrix"], "additionalProperties": false}, "continue-on-error": {"oneOf": [{"type": "boolean"}, {}]}, "container": {"oneOf": [{"type": "string"}, {}]}, "services": {"type": "object", "additionalProperties": {}}, "concurrency": {"oneOf": [{"type": "string"}, {}]}}, "required": ["runs-on"], "additionalProperties": false} |
github-workflow.json | name | The name of the job displayed on GitHub. | {"type": "string"} |
github-workflow.json | runs-on | The type of machine to run the job on. The machine can be either a GitHub-hosted runner, or a self-hosted runner. | {"oneOf": [{"type": "string", "enum": ["macos-10.15", "macos-11", "macos-12", "macos-12-xl", "macos-13", "macos-13-xl", "macos-latest", "macos-latest-xl", "self-hosted", "ubuntu-18.04", "ubuntu-20.04", "ubuntu-22.04", "ubuntu-latest", "ubuntu-latest-4-cores", "ubuntu-latest-8-cores", "ubuntu-latest-16-cores", "windows-2019", "windows-2022", "windows-latest", "windows-latest-8-cores"]}, {"type": "array", "anyOf": [{"items": [{"const": "self-hosted"}], "minItems": 1, "additionalItems": {"type": "string"}}, {"items": [{"const": "self-hosted"}, {}], "minItems": 2, "additionalItems": {"type": "string"}}, {"items": [{"const": "self-hosted"}, {}], "minItems": 2, "additionalItems": {"type": "string"}}, {"items": [{"const": "self-hosted"}, {}, {}], "minItems": 3, "additionalItems": {"type": "string"}}, {"items": [{"const": "self-hosted"}, {}, {}], "minItems": 3, "additionalItems": {"type": "string"}}, {"items": [{"const": "linux"}], "minItems": 2, "maxItems": 2, "additionalItems": {"type": "string"}}, {"items": [{"const": "windows"}], "minItems": 2, "maxItems": 2, "additionalItems": {"type": "string"}}]}, {"type": "object", "properties": {"group": {"type": "string"}, "labels": {"oneOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}]}}}, {}]} |
github-workflow.json | environment | The environment that the job references. | {"oneOf": [{"type": "string"}, {}]} |
github-workflow.json | outputs | A map of outputs for a job. Job outputs are available to all downstream jobs that depend on this job. | {"type": "object", "additionalProperties": {"type": "string"}, "minProperties": 1} |
github-workflow.json | env | A map of environment variables that are available to all steps in the job. | {} |
github-workflow.json | defaults | A map of default settings that will apply to all steps in the job. | {} |
github-workflow.json | if | 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 ${{ }} syntax. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions. | {"type": ["boolean", "number", "string"]} |
github-workflow.json | steps | 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`
| {"type": "array", "items": {"allOf": [{"oneOf": [{"type": "object", "properties": {"uses": {"type": "string"}}, "required": ["uses"]}, {"type": "object", "properties": {"run": {"type": "string"}}, "required": ["run"]}]}, {"type": "object", "properties": {"id": {"type": "string"}, "if": {"type": ["boolean", "number", "string"]}, "name": {"type": "string"}, "uses": {"type": "string"}, "run": {"type": "string"}, "working-directory": {}, "shell": {}, "with": {"properties": {"args": {"type": "string"}, "entrypoint": {"type": "string"}}}, "env": {}, "continue-on-error": {"oneOf": [{"type": "boolean"}, {}], "default": false}, "timeout-minutes": {"oneOf": [{"type": "number"}, {}]}}, "dependencies": {"working-directory": ["run"], "shell": ["run"]}, "additionalProperties": false}]}, "minItems": 1} |
github-workflow.json | id | A unique identifier for the step. You can use the id to reference the step in contexts. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions. | {"type": "string"} |
github-workflow.json | if | 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 ${{ }} syntax. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions. | {"type": ["boolean", "number", "string"]} |
github-workflow.json | name | A name for your step to display on GitHub. | {"type": "string"} |
github-workflow.json | uses | 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/).
We strongly recommend that you include the version of the action you are using by specifying a Git ref, SHA, or Docker tag number. If you don't specify a version, it could break your workflows or cause unexpected behavior when the action owner publishes an update.
- Using the commit SHA of a released action version is the safest for stability and security.
- Using the specific major action version allows you to receive critical fixes and security patches while still maintaining compatibility. It also assures that your workflow should still work.
- Using the master branch of an action may be convenient, but if someone releases a new major version with a breaking change, your workflow could break.
Some actions require inputs that you must set using the with keyword. Review the action's README file to determine the inputs required.
Actions are either JavaScript files or Docker containers. If the action you're using is a Docker container you must run the job in a Linux virtual environment. For more details, see https://help.github.com/en/articles/virtual-environments-for-github-actions. | {"type": "string"} |
github-workflow.json | run | 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. For more information, see https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#using-a-specific-shell.
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. | {"type": "string"} |
github-workflow.json | with | 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. | {"properties": {"args": {"type": "string"}, "entrypoint": {"type": "string"}}} |
github-workflow.json | env | Sets environment variables for steps to use in the virtual environment. You can also set environment variables for the entire workflow or a job. | {} |
github-workflow.json | continue-on-error | Prevents a job from failing when a step fails. Set to true to allow a job to pass when this step fails. | {"oneOf": [{"type": "boolean"}, {}], "default": false} |
github-workflow.json | timeout-minutes | The maximum number of minutes to run the step before killing the process. | {"oneOf": [{"type": "number"}, {}]} |
github-workflow.json | timeout-minutes | The maximum number of minutes to let a workflow run before GitHub automatically cancels it. Default: 360 | {"oneOf": [{"type": "number"}, {}], "default": 360} |
github-workflow.json | strategy | A strategy creates a build matrix for your jobs. You can define different variations of an environment to run each job in. | {"type": "object", "properties": {"matrix": {"oneOf": [{"type": "object"}, {}], "patternProperties": {"^(in|ex)clude$": {"type": "array", "items": {"type": "object", "additionalProperties": {}}, "minItems": 1}}, "additionalProperties": {"oneOf": [{"type": "array", "items": {}, "minItems": 1}, {}]}, "minProperties": 1}, "fail-fast": {"type": "boolean", "default": true}, "max-parallel": {"type": ["number", "string"]}}, "required": ["matrix"], "additionalProperties": false} |
github-workflow.json | matrix | 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. | {"oneOf": [{"type": "object"}, {}], "patternProperties": {"^(in|ex)clude$": {"type": "array", "items": {"type": "object", "additionalProperties": {}}, "minItems": 1}}, "additionalProperties": {"oneOf": [{"type": "array", "items": {}, "minItems": 1}, {}]}, "minProperties": 1} |
github-workflow.json | fail-fast | When set to true, GitHub cancels all in-progress jobs if any matrix job fails. Default: true | {"type": "boolean", "default": true} |
github-workflow.json | max-parallel | 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. | {"type": ["number", "string"]} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.