diff --git a/.gitignore b/.gitignore index ced060f..f9bf6ba 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,2 @@ -vendor jsonnetfile.lock.json +vendor diff --git a/Makefile b/Makefile index 01e43ba..e137e76 100644 --- a/Makefile +++ b/Makefile @@ -1,3 +1,32 @@ -generate: - jsonnet -m gen -S -J vendor main.libsonnet | xargs -n 1 -- jsonnetfmt --no-use-implicit-plus -i - +JSONNET_BIN ?= jsonnet + +jsonnetfile.json: + jb init + +vendor jsonnetfile.lock.json: jsonnetfile.json + jb install + +.PHONY: test +test: vendor jsonnetfile.lock.json + @cd test/ && make test + +.PHONY: fmt +fmt: + @find . \ + -path './.git' -prune \ + -o -name 'vendor' -prune \ + -o -name '*.libsonnet' -print \ + -o -name '*.jsonnet' -print \ + | xargs -n 1 -- jsonnetfmt --no-use-implicit-plus -i + +.PHONY: docs +docs: jsonnetfile.json + @rm -rf docs/ + @$(JSONNET_BIN) \ + -J generator/vendor \ + -S -c -m docs \ + -e '(import "github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet").render(import "main.libsonnet")' + +.PHONY: generate +generate: jsonnetfile.json + jsonnet -J generator/vendor -S generator/generate.jsonnet | jsonnetfmt - > raw.libsonnet diff --git a/docs/README.md b/docs/README.md index 7fcde82..f4efd0d 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,35 @@ # github-actions-libsonnet -Jsonnet library for github-actions-libsonnet +Jsonnet library to create GitHub actions workflows. +## Install -> [!CAUTION] -> Incomplete library, very experimental +``` +jb install github.com/crdsonnet/github-actions-libsonnet@main +``` + +## Usage + +```jsonnet +local ga = import 'github.com/crdsonnet/github-actions-libsonnet/main.libsonnet'; + +local exampleWorkflow = + ga.workflow.withName('example workflow') + + ga.workflow.on.pull_request.withBranches(['main']) + + ga.workflow.withJobs({ + example: + ga.job.withRunsOn('ubuntu-latest') + + ga.job.withSteps( + ga.job.step.withName('Checkout') + + ga.job.step.withUses('actions/checkout@v4') + ), + }); + +std.manifestYamlDoc(exampleWorkflow, indent_array_in_object=true, quote_keys=false) + +``` + + +## Subpackages + +* [job](job/index.md) +* [workflow](workflow.md) diff --git a/docs/job/index.md b/docs/job/index.md new file mode 100644 index 0000000..b46c75d --- /dev/null +++ b/docs/job/index.md @@ -0,0 +1,1326 @@ +# job + + + +## Subpackages + +* [step](step.md) + +## Index + +* [`fn withConcurrency(value)`](#fn-withconcurrency) +* [`fn withConcurrencyMixin(value)`](#fn-withconcurrencymixin) +* [`fn withContainer(value)`](#fn-withcontainer) +* [`fn withContainerMixin(value)`](#fn-withcontainermixin) +* [`fn withContinueOnError(value)`](#fn-withcontinueonerror) +* [`fn withContinueOnErrorMixin(value)`](#fn-withcontinueonerrormixin) +* [`fn withDefaults(value)`](#fn-withdefaults) +* [`fn withDefaultsMixin(value)`](#fn-withdefaultsmixin) +* [`fn withEnv(value)`](#fn-withenv) +* [`fn withEnvMixin(value)`](#fn-withenvmixin) +* [`fn withEnvironment(value)`](#fn-withenvironment) +* [`fn withEnvironmentMixin(value)`](#fn-withenvironmentmixin) +* [`fn withIf(value)`](#fn-withif) +* [`fn withName(value)`](#fn-withname) +* [`fn withNeeds(value)`](#fn-withneeds) +* [`fn withNeedsMixin(value)`](#fn-withneedsmixin) +* [`fn withOutputs(value)`](#fn-withoutputs) +* [`fn withOutputsMixin(value)`](#fn-withoutputsmixin) +* [`fn withPermissions(value)`](#fn-withpermissions) +* [`fn withPermissionsMixin(value)`](#fn-withpermissionsmixin) +* [`fn withRunsOn(value)`](#fn-withrunson) +* [`fn withRunsOnMixin(value)`](#fn-withrunsonmixin) +* [`fn withServices(value)`](#fn-withservices) +* [`fn withServicesMixin(value)`](#fn-withservicesmixin) +* [`fn withSteps(value)`](#fn-withsteps) +* [`fn withStepsMixin(value)`](#fn-withstepsmixin) +* [`fn withStrategy(value)`](#fn-withstrategy) +* [`fn withStrategyMixin(value)`](#fn-withstrategymixin) +* [`fn withTimeoutMinutes(value=360)`](#fn-withtimeoutminutes) +* [`fn withTimeoutMinutesMixin(value=360)`](#fn-withtimeoutminutesmixin) +* [`obj concurrency`](#obj-concurrency) + * [`fn withCancelInProgress(value)`](#fn-concurrencywithcancelinprogress) + * [`fn withCancelInProgressMixin(value)`](#fn-concurrencywithcancelinprogressmixin) + * [`fn withGroup(value)`](#fn-concurrencywithgroup) + * [`obj cancel-in-progress`](#obj-concurrencycancel-in-progress) + * [`fn withExpressionSyntax(value)`](#fn-concurrencycancel-in-progresswithexpressionsyntax) +* [`obj container`](#obj-container) + * [`fn withContainer(value)`](#fn-containerwithcontainer) + * [`fn withContainerMixin(value)`](#fn-containerwithcontainermixin) + * [`fn withCredentials(value)`](#fn-containerwithcredentials) + * [`fn withCredentialsMixin(value)`](#fn-containerwithcredentialsmixin) + * [`fn withEnv(value)`](#fn-containerwithenv) + * [`fn withEnvMixin(value)`](#fn-containerwithenvmixin) + * [`fn withImage(value)`](#fn-containerwithimage) + * [`fn withOptions(value)`](#fn-containerwithoptions) + * [`fn withPorts(value)`](#fn-containerwithports) + * [`fn withPortsMixin(value)`](#fn-containerwithportsmixin) + * [`fn withVolumes(value)`](#fn-containerwithvolumes) + * [`fn withVolumesMixin(value)`](#fn-containerwithvolumesmixin) + * [`obj container`](#obj-containercontainer) + * [`fn withCredentials(value)`](#fn-containercontainerwithcredentials) + * [`fn withCredentialsMixin(value)`](#fn-containercontainerwithcredentialsmixin) + * [`fn withEnv(value)`](#fn-containercontainerwithenv) + * [`fn withEnvMixin(value)`](#fn-containercontainerwithenvmixin) + * [`fn withImage(value)`](#fn-containercontainerwithimage) + * [`fn withOptions(value)`](#fn-containercontainerwithoptions) + * [`fn withPorts(value)`](#fn-containercontainerwithports) + * [`fn withPortsMixin(value)`](#fn-containercontainerwithportsmixin) + * [`fn withVolumes(value)`](#fn-containercontainerwithvolumes) + * [`fn withVolumesMixin(value)`](#fn-containercontainerwithvolumesmixin) + * [`obj credentials`](#obj-containercontainercredentials) + * [`fn withPassword(value)`](#fn-containercontainercredentialswithpassword) + * [`fn withUsername(value)`](#fn-containercontainercredentialswithusername) + * [`obj env`](#obj-containercontainerenv) + * [`fn withStringContainingExpressionSyntax(value)`](#fn-containercontainerenvwithstringcontainingexpressionsyntax) + * [`obj credentials`](#obj-containercredentials) + * [`fn withPassword(value)`](#fn-containercredentialswithpassword) + * [`fn withUsername(value)`](#fn-containercredentialswithusername) + * [`obj env`](#obj-containerenv) + * [`fn withStringContainingExpressionSyntax(value)`](#fn-containerenvwithstringcontainingexpressionsyntax) +* [`obj continue-on-error`](#obj-continue-on-error) + * [`fn withExpressionSyntax(value)`](#fn-continue-on-errorwithexpressionsyntax) +* [`obj defaults`](#obj-defaults) + * [`fn withRun(value)`](#fn-defaultswithrun) + * [`fn withRunMixin(value)`](#fn-defaultswithrunmixin) + * [`obj run`](#obj-defaultsrun) + * [`fn withShell(value)`](#fn-defaultsrunwithshell) + * [`fn withShellMixin(value)`](#fn-defaultsrunwithshellmixin) + * [`fn withWorkingDirectory(value)`](#fn-defaultsrunwithworkingdirectory) +* [`obj env`](#obj-env) + * [`fn withStringContainingExpressionSyntax(value)`](#fn-envwithstringcontainingexpressionsyntax) +* [`obj environment`](#obj-environment) + * [`fn withEnvironment(value)`](#fn-environmentwithenvironment) + * [`fn withEnvironmentMixin(value)`](#fn-environmentwithenvironmentmixin) + * [`obj environment`](#obj-environmentenvironment) + * [`fn withName(value)`](#fn-environmentenvironmentwithname) + * [`fn withUrl(value)`](#fn-environmentenvironmentwithurl) +* [`obj needs`](#obj-needs) + * [`fn withName(value)`](#fn-needswithname) +* [`obj permissions`](#obj-permissions) + * [`fn withActions(value)`](#fn-permissionswithactions) + * [`fn withAttestations(value)`](#fn-permissionswithattestations) + * [`fn withChecks(value)`](#fn-permissionswithchecks) + * [`fn withContents(value)`](#fn-permissionswithcontents) + * [`fn withDeployments(value)`](#fn-permissionswithdeployments) + * [`fn withDiscussions(value)`](#fn-permissionswithdiscussions) + * [`fn withIdToken(value)`](#fn-permissionswithidtoken) + * [`fn withIssues(value)`](#fn-permissionswithissues) + * [`fn withPackages(value)`](#fn-permissionswithpackages) + * [`fn withPages(value)`](#fn-permissionswithpages) + * [`fn withPullRequests(value)`](#fn-permissionswithpullrequests) + * [`fn withRepositoryProjects(value)`](#fn-permissionswithrepositoryprojects) + * [`fn withSecurityEvents(value)`](#fn-permissionswithsecurityevents) + * [`fn withStatuses(value)`](#fn-permissionswithstatuses) +* [`obj runs-on`](#obj-runs-on) + * [`fn withExpressionSyntax(value)`](#fn-runs-onwithexpressionsyntax) + * [`fn withGroup(value)`](#fn-runs-onwithgroup) + * [`fn withLabels(value)`](#fn-runs-onwithlabels) + * [`fn withLabelsMixin(value)`](#fn-runs-onwithlabelsmixin) + * [`fn withStringContainingExpressionSyntax(value)`](#fn-runs-onwithstringcontainingexpressionsyntax) +* [`obj strategy`](#obj-strategy) + * [`fn withFailFast(value=true)`](#fn-strategywithfailfast) + * [`fn withMatrix(value)`](#fn-strategywithmatrix) + * [`fn withMatrixMixin(value)`](#fn-strategywithmatrixmixin) + * [`fn withMaxParallel(value)`](#fn-strategywithmaxparallel) + * [`obj matrix`](#obj-strategymatrix) + * [`fn withExpressionSyntax(value)`](#fn-strategymatrixwithexpressionsyntax) +* [`obj timeout-minutes`](#obj-timeout-minutes) + * [`fn withExpressionSyntax(value)`](#fn-timeout-minuteswithexpressionsyntax) + +## Fields + +### fn withConcurrency + +```jsonnet +withConcurrency(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + +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. +### fn withConcurrencyMixin + +```jsonnet +withConcurrencyMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + +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. +### fn withContainer + +```jsonnet +withContainer(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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. +### fn withContainerMixin + +```jsonnet +withContainerMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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. +### fn withContinueOnError + +```jsonnet +withContinueOnError(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`string`) + +Prevents a workflow run from failing when a job fails. Set to true to allow a workflow run to pass when this job fails. +### fn withContinueOnErrorMixin + +```jsonnet +withContinueOnErrorMixin(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`string`) + +Prevents a workflow run from failing when a job fails. Set to true to allow a workflow run to pass when this job fails. +### fn withDefaults + +```jsonnet +withDefaults(value) +``` + +PARAMETERS: + +* **value** (`object`) + +A map of default settings that will apply to all steps in the job. +### fn withDefaultsMixin + +```jsonnet +withDefaultsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +A map of default settings that will apply to all steps in the job. +### fn withEnv + +```jsonnet +withEnv(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + +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..steps[*].env, jobs..env, and env keywords. For more information, see https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsenv +### fn withEnvMixin + +```jsonnet +withEnvMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + +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..steps[*].env, jobs..env, and env keywords. For more information, see https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsenv +### fn withEnvironment + +```jsonnet +withEnvironment(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + +The environment that the job references. +### fn withEnvironmentMixin + +```jsonnet +withEnvironmentMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + +The environment that the job references. +### fn withIf + +```jsonnet +withIf(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`,`string`) + +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. +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The name of the job displayed on GitHub. +### fn withNeeds + +```jsonnet +withNeeds(value) +``` + +PARAMETERS: + +* **value** (`array`,`string`) + +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. +### fn withNeedsMixin + +```jsonnet +withNeedsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`,`string`) + +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. +### fn withOutputs + +```jsonnet +withOutputs(value) +``` + +PARAMETERS: + +* **value** (`object`) + +A map of outputs for a job. Job outputs are available to all downstream jobs that depend on this job. +### fn withOutputsMixin + +```jsonnet +withOutputsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +A map of outputs for a job. Job outputs are available to all downstream jobs that depend on this job. +### fn withPermissions + +```jsonnet +withPermissions(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + +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. +### fn withPermissionsMixin + +```jsonnet +withPermissionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + +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. +### fn withRunsOn + +```jsonnet +withRunsOn(value) +``` + +PARAMETERS: + +* **value** (`array`,`object`,`string`) + +The type of machine to run the job on. The machine can be either a GitHub-hosted runner, or a self-hosted runner. +### fn withRunsOnMixin + +```jsonnet +withRunsOnMixin(value) +``` + +PARAMETERS: + +* **value** (`array`,`object`,`string`) + +The type of machine to run the job on. The machine can be either a GitHub-hosted runner, or a self-hosted runner. +### fn withServices + +```jsonnet +withServices(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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. +### fn withServicesMixin + +```jsonnet +withServicesMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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. +### fn withSteps + +```jsonnet +withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +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` + +### fn withStepsMixin + +```jsonnet +withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +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` + +### fn withStrategy + +```jsonnet +withStrategy(value) +``` + +PARAMETERS: + +* **value** (`object`) + +A strategy creates a build matrix for your jobs. You can define different variations of an environment to run each job in. +### fn withStrategyMixin + +```jsonnet +withStrategyMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +A strategy creates a build matrix for your jobs. You can define different variations of an environment to run each job in. +### fn withTimeoutMinutes + +```jsonnet +withTimeoutMinutes(value=360) +``` + +PARAMETERS: + +* **value** (`number`,`string`) + - default value: `360` + +The maximum number of minutes to let a workflow run before GitHub automatically cancels it. Default: 360 +### fn withTimeoutMinutesMixin + +```jsonnet +withTimeoutMinutesMixin(value=360) +``` + +PARAMETERS: + +* **value** (`number`,`string`) + - default value: `360` + +The maximum number of minutes to let a workflow run before GitHub automatically cancels it. Default: 360 +### obj concurrency + + +#### fn concurrency.withCancelInProgress + +```jsonnet +concurrency.withCancelInProgress(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`string`) + +To cancel any currently running job or workflow in the same concurrency group, specify cancel-in-progress: true. +#### fn concurrency.withCancelInProgressMixin + +```jsonnet +concurrency.withCancelInProgressMixin(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`string`) + +To cancel any currently running job or workflow in the same concurrency group, specify cancel-in-progress: true. +#### fn concurrency.withGroup + +```jsonnet +concurrency.withGroup(value) +``` + +PARAMETERS: + +* **value** (`string`) + +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. +#### obj concurrency.cancel-in-progress + + +##### fn concurrency.cancel-in-progress.withExpressionSyntax + +```jsonnet +concurrency.cancel-in-progress.withExpressionSyntax(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj container + + +#### fn container.withContainer + +```jsonnet +container.withContainer(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn container.withContainerMixin + +```jsonnet +container.withContainerMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn container.withCredentials + +```jsonnet +container.withCredentials(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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. +#### fn container.withCredentialsMixin + +```jsonnet +container.withCredentialsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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. +#### fn container.withEnv + +```jsonnet +container.withEnv(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + +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..steps[*].env, jobs..env, and env keywords. For more information, see https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsenv +#### fn container.withEnvMixin + +```jsonnet +container.withEnvMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + +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..steps[*].env, jobs..env, and env keywords. For more information, see https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsenv +#### fn container.withImage + +```jsonnet +container.withImage(value) +``` + +PARAMETERS: + +* **value** (`string`) + +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. +#### fn container.withOptions + +```jsonnet +container.withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Additional Docker container resource options. For a list of options, see https://docs.docker.com/engine/reference/commandline/create/#options. +#### fn container.withPorts + +```jsonnet +container.withPorts(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Sets an array of ports to expose on the container. +#### fn container.withPortsMixin + +```jsonnet +container.withPortsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Sets an array of ports to expose on the container. +#### fn container.withVolumes + +```jsonnet +container.withVolumes(value) +``` + +PARAMETERS: + +* **value** (`array`) + +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: : +The is a volume name or an absolute path on the host machine, and is an absolute path in the container. +#### fn container.withVolumesMixin + +```jsonnet +container.withVolumesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +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: : +The is a volume name or an absolute path on the host machine, and is an absolute path in the container. +#### obj container.container + + +##### fn container.container.withCredentials + +```jsonnet +container.container.withCredentials(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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. +##### fn container.container.withCredentialsMixin + +```jsonnet +container.container.withCredentialsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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. +##### fn container.container.withEnv + +```jsonnet +container.container.withEnv(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + +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..steps[*].env, jobs..env, and env keywords. For more information, see https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsenv +##### fn container.container.withEnvMixin + +```jsonnet +container.container.withEnvMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + +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..steps[*].env, jobs..env, and env keywords. For more information, see https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsenv +##### fn container.container.withImage + +```jsonnet +container.container.withImage(value) +``` + +PARAMETERS: + +* **value** (`string`) + +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. +##### fn container.container.withOptions + +```jsonnet +container.container.withOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Additional Docker container resource options. For a list of options, see https://docs.docker.com/engine/reference/commandline/create/#options. +##### fn container.container.withPorts + +```jsonnet +container.container.withPorts(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Sets an array of ports to expose on the container. +##### fn container.container.withPortsMixin + +```jsonnet +container.container.withPortsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Sets an array of ports to expose on the container. +##### fn container.container.withVolumes + +```jsonnet +container.container.withVolumes(value) +``` + +PARAMETERS: + +* **value** (`array`) + +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: : +The is a volume name or an absolute path on the host machine, and is an absolute path in the container. +##### fn container.container.withVolumesMixin + +```jsonnet +container.container.withVolumesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +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: : +The is a volume name or an absolute path on the host machine, and is an absolute path in the container. +##### obj container.container.credentials + + +###### fn container.container.credentials.withPassword + +```jsonnet +container.container.credentials.withPassword(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn container.container.credentials.withUsername + +```jsonnet +container.container.credentials.withUsername(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj container.container.env + + +###### fn container.container.env.withStringContainingExpressionSyntax + +```jsonnet +container.container.env.withStringContainingExpressionSyntax(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj container.credentials + + +##### fn container.credentials.withPassword + +```jsonnet +container.credentials.withPassword(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn container.credentials.withUsername + +```jsonnet +container.credentials.withUsername(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj container.env + + +##### fn container.env.withStringContainingExpressionSyntax + +```jsonnet +container.env.withStringContainingExpressionSyntax(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj continue-on-error + + +#### fn continue-on-error.withExpressionSyntax + +```jsonnet +continue-on-error.withExpressionSyntax(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj defaults + + +#### fn defaults.withRun + +```jsonnet +defaults.withRun(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn defaults.withRunMixin + +```jsonnet +defaults.withRunMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### obj defaults.run + + +##### fn defaults.run.withShell + +```jsonnet +defaults.run.withShell(value) +``` + +PARAMETERS: + +* **value** (`string`) + +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. +##### fn defaults.run.withShellMixin + +```jsonnet +defaults.run.withShellMixin(value) +``` + +PARAMETERS: + +* **value** (`string`) + +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. +##### fn defaults.run.withWorkingDirectory + +```jsonnet +defaults.run.withWorkingDirectory(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Using the working-directory keyword, you can specify the working directory of where to run the command. +### obj env + + +#### fn env.withStringContainingExpressionSyntax + +```jsonnet +env.withStringContainingExpressionSyntax(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj environment + + +#### fn environment.withEnvironment + +```jsonnet +environment.withEnvironment(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The environment that the job references +#### fn environment.withEnvironmentMixin + +```jsonnet +environment.withEnvironmentMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The environment that the job references +#### obj environment.environment + + +##### fn environment.environment.withName + +```jsonnet +environment.environment.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The name of the environment configured in the repo. +##### fn environment.environment.withUrl + +```jsonnet +environment.environment.withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A deployment URL +### obj needs + + +#### fn needs.withName + +```jsonnet +needs.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj permissions + + +#### fn permissions.withActions + +```jsonnet +permissions.withActions(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"read"`, `"write"`, `"none"` + + +#### fn permissions.withAttestations + +```jsonnet +permissions.withAttestations(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"read"`, `"write"`, `"none"` + + +#### fn permissions.withChecks + +```jsonnet +permissions.withChecks(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"read"`, `"write"`, `"none"` + + +#### fn permissions.withContents + +```jsonnet +permissions.withContents(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"read"`, `"write"`, `"none"` + + +#### fn permissions.withDeployments + +```jsonnet +permissions.withDeployments(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"read"`, `"write"`, `"none"` + + +#### fn permissions.withDiscussions + +```jsonnet +permissions.withDiscussions(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"read"`, `"write"`, `"none"` + + +#### fn permissions.withIdToken + +```jsonnet +permissions.withIdToken(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"read"`, `"write"`, `"none"` + + +#### fn permissions.withIssues + +```jsonnet +permissions.withIssues(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"read"`, `"write"`, `"none"` + + +#### fn permissions.withPackages + +```jsonnet +permissions.withPackages(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"read"`, `"write"`, `"none"` + + +#### fn permissions.withPages + +```jsonnet +permissions.withPages(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"read"`, `"write"`, `"none"` + + +#### fn permissions.withPullRequests + +```jsonnet +permissions.withPullRequests(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"read"`, `"write"`, `"none"` + + +#### fn permissions.withRepositoryProjects + +```jsonnet +permissions.withRepositoryProjects(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"read"`, `"write"`, `"none"` + + +#### fn permissions.withSecurityEvents + +```jsonnet +permissions.withSecurityEvents(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"read"`, `"write"`, `"none"` + + +#### fn permissions.withStatuses + +```jsonnet +permissions.withStatuses(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"read"`, `"write"`, `"none"` + + +### obj runs-on + + +#### fn runs-on.withExpressionSyntax + +```jsonnet +runs-on.withExpressionSyntax(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn runs-on.withGroup + +```jsonnet +runs-on.withGroup(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn runs-on.withLabels + +```jsonnet +runs-on.withLabels(value) +``` + +PARAMETERS: + +* **value** (`array`,`string`) + + +#### fn runs-on.withLabelsMixin + +```jsonnet +runs-on.withLabelsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`,`string`) + + +#### fn runs-on.withStringContainingExpressionSyntax + +```jsonnet +runs-on.withStringContainingExpressionSyntax(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj strategy + + +#### fn strategy.withFailFast + +```jsonnet +strategy.withFailFast(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`,`string`) + - default value: `true` + +When set to true, GitHub cancels all in-progress jobs if any matrix job fails. Default: true +#### fn strategy.withMatrix + +```jsonnet +strategy.withMatrix(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + +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. +#### fn strategy.withMatrixMixin + +```jsonnet +strategy.withMatrixMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + +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. +#### fn strategy.withMaxParallel + +```jsonnet +strategy.withMaxParallel(value) +``` + +PARAMETERS: + +* **value** (`number`,`string`) + +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. +#### obj strategy.matrix + + +##### fn strategy.matrix.withExpressionSyntax + +```jsonnet +strategy.matrix.withExpressionSyntax(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj timeout-minutes + + +#### fn timeout-minutes.withExpressionSyntax + +```jsonnet +timeout-minutes.withExpressionSyntax(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/docs/job/step.md b/docs/job/step.md new file mode 100644 index 0000000..3a9223d --- /dev/null +++ b/docs/job/step.md @@ -0,0 +1,275 @@ +# step + + + +## Index + +* [`fn withContinueOnError(value=false)`](#fn-withcontinueonerror) +* [`fn withContinueOnErrorMixin(value=false)`](#fn-withcontinueonerrormixin) +* [`fn withEnv(value)`](#fn-withenv) +* [`fn withEnvMixin(value)`](#fn-withenvmixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withIf(value)`](#fn-withif) +* [`fn withName(value)`](#fn-withname) +* [`fn withRun(value)`](#fn-withrun) +* [`fn withShell(value)`](#fn-withshell) +* [`fn withShellMixin(value)`](#fn-withshellmixin) +* [`fn withTimeoutMinutes(value)`](#fn-withtimeoutminutes) +* [`fn withTimeoutMinutesMixin(value)`](#fn-withtimeoutminutesmixin) +* [`fn withUses(value)`](#fn-withuses) +* [`fn withWith(value)`](#fn-withwith) +* [`fn withWithMixin(value)`](#fn-withwithmixin) +* [`fn withWorkingDirectory(value)`](#fn-withworkingdirectory) +* [`obj continue-on-error`](#obj-continue-on-error) + * [`fn withExpressionSyntax(value)`](#fn-continue-on-errorwithexpressionsyntax) +* [`obj env`](#obj-env) + * [`fn withStringContainingExpressionSyntax(value)`](#fn-envwithstringcontainingexpressionsyntax) +* [`obj timeout-minutes`](#obj-timeout-minutes) + * [`fn withExpressionSyntax(value)`](#fn-timeout-minuteswithexpressionsyntax) +* [`obj with`](#obj-with) + * [`fn withStringContainingExpressionSyntax(value)`](#fn-withwithstringcontainingexpressionsyntax) + +## Fields + +### fn withContinueOnError + +```jsonnet +withContinueOnError(value=false) +``` + +PARAMETERS: + +* **value** (`boolean`,`string`) + - default value: `false` + +Prevents a job from failing when a step fails. Set to true to allow a job to pass when this step fails. +### fn withContinueOnErrorMixin + +```jsonnet +withContinueOnErrorMixin(value=false) +``` + +PARAMETERS: + +* **value** (`boolean`,`string`) + - default value: `false` + +Prevents a job from failing when a step fails. Set to true to allow a job to pass when this step fails. +### fn withEnv + +```jsonnet +withEnv(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + +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..steps[*].env, jobs..env, and env keywords. For more information, see https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsenv +### fn withEnvMixin + +```jsonnet +withEnvMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + +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..steps[*].env, jobs..env, and env keywords. For more information, see https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsenv +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +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. +### fn withIf + +```jsonnet +withIf(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`,`string`) + +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. +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A name for your step to display on GitHub. +### fn withRun + +```jsonnet +withRun(value) +``` + +PARAMETERS: + +* **value** (`string`) + +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. +### fn withShell + +```jsonnet +withShell(value) +``` + +PARAMETERS: + +* **value** (`string`) + +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. +### fn withShellMixin + +```jsonnet +withShellMixin(value) +``` + +PARAMETERS: + +* **value** (`string`) + +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. +### fn withTimeoutMinutes + +```jsonnet +withTimeoutMinutes(value) +``` + +PARAMETERS: + +* **value** (`number`,`string`) + +The maximum number of minutes to run the step before killing the process. +### fn withTimeoutMinutesMixin + +```jsonnet +withTimeoutMinutesMixin(value) +``` + +PARAMETERS: + +* **value** (`number`,`string`) + +The maximum number of minutes to run the step before killing the process. +### fn withUses + +```jsonnet +withUses(value) +``` + +PARAMETERS: + +* **value** (`string`) + +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. +### fn withWith + +```jsonnet +withWith(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + +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..steps[*].env, jobs..env, and env keywords. For more information, see https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsenv +### fn withWithMixin + +```jsonnet +withWithMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + +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..steps[*].env, jobs..env, and env keywords. For more information, see https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsenv +### fn withWorkingDirectory + +```jsonnet +withWorkingDirectory(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Using the working-directory keyword, you can specify the working directory of where to run the command. +### obj continue-on-error + + +#### fn continue-on-error.withExpressionSyntax + +```jsonnet +continue-on-error.withExpressionSyntax(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj env + + +#### fn env.withStringContainingExpressionSyntax + +```jsonnet +env.withStringContainingExpressionSyntax(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj timeout-minutes + + +#### fn timeout-minutes.withExpressionSyntax + +```jsonnet +timeout-minutes.withExpressionSyntax(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj with + + +#### fn with.withStringContainingExpressionSyntax + +```jsonnet +with.withStringContainingExpressionSyntax(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/docs/workflow.md b/docs/workflow.md new file mode 100644 index 0000000..339c90b --- /dev/null +++ b/docs/workflow.md @@ -0,0 +1,2715 @@ +# workflow + + + +## Index + +* [`fn withConcurrency(value)`](#fn-withconcurrency) +* [`fn withConcurrencyMixin(value)`](#fn-withconcurrencymixin) +* [`fn withDefaults(value)`](#fn-withdefaults) +* [`fn withDefaultsMixin(value)`](#fn-withdefaultsmixin) +* [`fn withEnv(value)`](#fn-withenv) +* [`fn withEnvMixin(value)`](#fn-withenvmixin) +* [`fn withJobs(value)`](#fn-withjobs) +* [`fn withJobsMixin(value)`](#fn-withjobsmixin) +* [`fn withName(value)`](#fn-withname) +* [`fn withOn(value)`](#fn-withon) +* [`fn withOnMixin(value)`](#fn-withonmixin) +* [`fn withPermissions(value)`](#fn-withpermissions) +* [`fn withPermissionsMixin(value)`](#fn-withpermissionsmixin) +* [`fn withRunName(value)`](#fn-withrunname) +* [`obj concurrency`](#obj-concurrency) + * [`fn withCancelInProgress(value)`](#fn-concurrencywithcancelinprogress) + * [`fn withCancelInProgressMixin(value)`](#fn-concurrencywithcancelinprogressmixin) + * [`fn withGroup(value)`](#fn-concurrencywithgroup) + * [`obj cancel-in-progress`](#obj-concurrencycancel-in-progress) + * [`fn withExpressionSyntax(value)`](#fn-concurrencycancel-in-progresswithexpressionsyntax) +* [`obj defaults`](#obj-defaults) + * [`fn withRun(value)`](#fn-defaultswithrun) + * [`fn withRunMixin(value)`](#fn-defaultswithrunmixin) + * [`obj run`](#obj-defaultsrun) + * [`fn withShell(value)`](#fn-defaultsrunwithshell) + * [`fn withShellMixin(value)`](#fn-defaultsrunwithshellmixin) + * [`fn withWorkingDirectory(value)`](#fn-defaultsrunwithworkingdirectory) +* [`obj env`](#obj-env) + * [`fn withStringContainingExpressionSyntax(value)`](#fn-envwithstringcontainingexpressionsyntax) +* [`obj on`](#obj-on) + * [`fn withBranchProtectionRule(value)`](#fn-onwithbranchprotectionrule) + * [`fn withBranchProtectionRuleMixin(value)`](#fn-onwithbranchprotectionrulemixin) + * [`fn withCheckRun(value)`](#fn-onwithcheckrun) + * [`fn withCheckRunMixin(value)`](#fn-onwithcheckrunmixin) + * [`fn withCheckSuite(value)`](#fn-onwithchecksuite) + * [`fn withCheckSuiteMixin(value)`](#fn-onwithchecksuitemixin) + * [`fn withCreate(value)`](#fn-onwithcreate) + * [`fn withCreateMixin(value)`](#fn-onwithcreatemixin) + * [`fn withDelete(value)`](#fn-onwithdelete) + * [`fn withDeleteMixin(value)`](#fn-onwithdeletemixin) + * [`fn withDeployment(value)`](#fn-onwithdeployment) + * [`fn withDeploymentMixin(value)`](#fn-onwithdeploymentmixin) + * [`fn withDeploymentStatus(value)`](#fn-onwithdeploymentstatus) + * [`fn withDeploymentStatusMixin(value)`](#fn-onwithdeploymentstatusmixin) + * [`fn withDiscussion(value)`](#fn-onwithdiscussion) + * [`fn withDiscussionComment(value)`](#fn-onwithdiscussioncomment) + * [`fn withDiscussionCommentMixin(value)`](#fn-onwithdiscussioncommentmixin) + * [`fn withDiscussionMixin(value)`](#fn-onwithdiscussionmixin) + * [`fn withEvent(value)`](#fn-onwithevent) + * [`fn withFork(value)`](#fn-onwithfork) + * [`fn withForkMixin(value)`](#fn-onwithforkmixin) + * [`fn withGollum(value)`](#fn-onwithgollum) + * [`fn withGollumMixin(value)`](#fn-onwithgollummixin) + * [`fn withIssueComment(value)`](#fn-onwithissuecomment) + * [`fn withIssueCommentMixin(value)`](#fn-onwithissuecommentmixin) + * [`fn withIssues(value)`](#fn-onwithissues) + * [`fn withIssuesMixin(value)`](#fn-onwithissuesmixin) + * [`fn withLabel(value)`](#fn-onwithlabel) + * [`fn withLabelMixin(value)`](#fn-onwithlabelmixin) + * [`fn withMergeGroup(value)`](#fn-onwithmergegroup) + * [`fn withMergeGroupMixin(value)`](#fn-onwithmergegroupmixin) + * [`fn withMilestone(value)`](#fn-onwithmilestone) + * [`fn withMilestoneMixin(value)`](#fn-onwithmilestonemixin) + * [`fn withPageBuild(value)`](#fn-onwithpagebuild) + * [`fn withPageBuildMixin(value)`](#fn-onwithpagebuildmixin) + * [`fn withProject(value)`](#fn-onwithproject) + * [`fn withProjectCard(value)`](#fn-onwithprojectcard) + * [`fn withProjectCardMixin(value)`](#fn-onwithprojectcardmixin) + * [`fn withProjectColumn(value)`](#fn-onwithprojectcolumn) + * [`fn withProjectColumnMixin(value)`](#fn-onwithprojectcolumnmixin) + * [`fn withProjectMixin(value)`](#fn-onwithprojectmixin) + * [`fn withPublic(value)`](#fn-onwithpublic) + * [`fn withPublicMixin(value)`](#fn-onwithpublicmixin) + * [`fn withPullRequest(value)`](#fn-onwithpullrequest) + * [`fn withPullRequestMixin(value)`](#fn-onwithpullrequestmixin) + * [`fn withPullRequestReview(value)`](#fn-onwithpullrequestreview) + * [`fn withPullRequestReviewComment(value)`](#fn-onwithpullrequestreviewcomment) + * [`fn withPullRequestReviewCommentMixin(value)`](#fn-onwithpullrequestreviewcommentmixin) + * [`fn withPullRequestReviewMixin(value)`](#fn-onwithpullrequestreviewmixin) + * [`fn withPullRequestTarget(value)`](#fn-onwithpullrequesttarget) + * [`fn withPullRequestTargetMixin(value)`](#fn-onwithpullrequesttargetmixin) + * [`fn withPush(value)`](#fn-onwithpush) + * [`fn withPushMixin(value)`](#fn-onwithpushmixin) + * [`fn withRegistryPackage(value)`](#fn-onwithregistrypackage) + * [`fn withRegistryPackageMixin(value)`](#fn-onwithregistrypackagemixin) + * [`fn withRelease(value)`](#fn-onwithrelease) + * [`fn withReleaseMixin(value)`](#fn-onwithreleasemixin) + * [`fn withRepositoryDispatch(value)`](#fn-onwithrepositorydispatch) + * [`fn withRepositoryDispatchMixin(value)`](#fn-onwithrepositorydispatchmixin) + * [`fn withSchedule(value)`](#fn-onwithschedule) + * [`fn withScheduleMixin(value)`](#fn-onwithschedulemixin) + * [`fn withStatus(value)`](#fn-onwithstatus) + * [`fn withStatusMixin(value)`](#fn-onwithstatusmixin) + * [`fn withWatch(value)`](#fn-onwithwatch) + * [`fn withWatchMixin(value)`](#fn-onwithwatchmixin) + * [`fn withWorkflowCall(value)`](#fn-onwithworkflowcall) + * [`fn withWorkflowDispatch(value)`](#fn-onwithworkflowdispatch) + * [`fn withWorkflowRun(value)`](#fn-onwithworkflowrun) + * [`fn withWorkflowRunMixin(value)`](#fn-onwithworkflowrunmixin) + * [`obj branch_protection_rule`](#obj-onbranch_protection_rule) + * [`fn withTypes(value=["created","edited","deleted"])`](#fn-onbranch_protection_rulewithtypes) + * [`fn withTypesMixin(value=["created","edited","deleted"])`](#fn-onbranch_protection_rulewithtypesmixin) + * [`obj check_run`](#obj-oncheck_run) + * [`fn withTypes(value=["created","rerequested","completed","requested_action"])`](#fn-oncheck_runwithtypes) + * [`fn withTypesMixin(value=["created","rerequested","completed","requested_action"])`](#fn-oncheck_runwithtypesmixin) + * [`obj check_suite`](#obj-oncheck_suite) + * [`fn withTypes(value=["completed","requested","rerequested"])`](#fn-oncheck_suitewithtypes) + * [`fn withTypesMixin(value=["completed","requested","rerequested"])`](#fn-oncheck_suitewithtypesmixin) + * [`obj discussion`](#obj-ondiscussion) + * [`fn withTypes(value=["created","edited","deleted","transferred","pinned","unpinned","labeled","unlabeled","locked","unlocked","category_changed","answered","unanswered"])`](#fn-ondiscussionwithtypes) + * [`fn withTypesMixin(value=["created","edited","deleted","transferred","pinned","unpinned","labeled","unlabeled","locked","unlocked","category_changed","answered","unanswered"])`](#fn-ondiscussionwithtypesmixin) + * [`obj discussion_comment`](#obj-ondiscussion_comment) + * [`fn withTypes(value=["created","edited","deleted"])`](#fn-ondiscussion_commentwithtypes) + * [`fn withTypesMixin(value=["created","edited","deleted"])`](#fn-ondiscussion_commentwithtypesmixin) + * [`obj issue_comment`](#obj-onissue_comment) + * [`fn withTypes(value=["created","edited","deleted"])`](#fn-onissue_commentwithtypes) + * [`fn withTypesMixin(value=["created","edited","deleted"])`](#fn-onissue_commentwithtypesmixin) + * [`obj issues`](#obj-onissues) + * [`fn withTypes(value=["opened","edited","deleted","transferred","pinned","unpinned","closed","reopened","assigned","unassigned","labeled","unlabeled","locked","unlocked","milestoned","demilestoned"])`](#fn-onissueswithtypes) + * [`fn withTypesMixin(value=["opened","edited","deleted","transferred","pinned","unpinned","closed","reopened","assigned","unassigned","labeled","unlabeled","locked","unlocked","milestoned","demilestoned"])`](#fn-onissueswithtypesmixin) + * [`obj label`](#obj-onlabel) + * [`fn withTypes(value=["created","edited","deleted"])`](#fn-onlabelwithtypes) + * [`fn withTypesMixin(value=["created","edited","deleted"])`](#fn-onlabelwithtypesmixin) + * [`obj merge_group`](#obj-onmerge_group) + * [`fn withTypes(value=["checks_requested"])`](#fn-onmerge_groupwithtypes) + * [`fn withTypesMixin(value=["checks_requested"])`](#fn-onmerge_groupwithtypesmixin) + * [`obj milestone`](#obj-onmilestone) + * [`fn withTypes(value=["created","closed","opened","edited","deleted"])`](#fn-onmilestonewithtypes) + * [`fn withTypesMixin(value=["created","closed","opened","edited","deleted"])`](#fn-onmilestonewithtypesmixin) + * [`obj project`](#obj-onproject) + * [`fn withTypes(value=["created","updated","closed","reopened","edited","deleted"])`](#fn-onprojectwithtypes) + * [`fn withTypesMixin(value=["created","updated","closed","reopened","edited","deleted"])`](#fn-onprojectwithtypesmixin) + * [`obj project_card`](#obj-onproject_card) + * [`fn withTypes(value=["created","moved","converted","edited","deleted"])`](#fn-onproject_cardwithtypes) + * [`fn withTypesMixin(value=["created","moved","converted","edited","deleted"])`](#fn-onproject_cardwithtypesmixin) + * [`obj project_column`](#obj-onproject_column) + * [`fn withTypes(value=["created","updated","moved","deleted"])`](#fn-onproject_columnwithtypes) + * [`fn withTypesMixin(value=["created","updated","moved","deleted"])`](#fn-onproject_columnwithtypesmixin) + * [`obj pull_request`](#obj-onpull_request) + * [`fn withBranches(value)`](#fn-onpull_requestwithbranches) + * [`fn withBranchesIgnore(value)`](#fn-onpull_requestwithbranchesignore) + * [`fn withBranchesIgnoreMixin(value)`](#fn-onpull_requestwithbranchesignoremixin) + * [`fn withBranchesMixin(value)`](#fn-onpull_requestwithbranchesmixin) + * [`fn withPaths(value)`](#fn-onpull_requestwithpaths) + * [`fn withPathsIgnore(value)`](#fn-onpull_requestwithpathsignore) + * [`fn withPathsIgnoreMixin(value)`](#fn-onpull_requestwithpathsignoremixin) + * [`fn withPathsMixin(value)`](#fn-onpull_requestwithpathsmixin) + * [`fn withTags(value)`](#fn-onpull_requestwithtags) + * [`fn withTagsIgnore(value)`](#fn-onpull_requestwithtagsignore) + * [`fn withTagsIgnoreMixin(value)`](#fn-onpull_requestwithtagsignoremixin) + * [`fn withTagsMixin(value)`](#fn-onpull_requestwithtagsmixin) + * [`fn withTypes(value=["opened","synchronize","reopened"])`](#fn-onpull_requestwithtypes) + * [`fn withTypesMixin(value=["opened","synchronize","reopened"])`](#fn-onpull_requestwithtypesmixin) + * [`obj pull_request_review`](#obj-onpull_request_review) + * [`fn withTypes(value=["submitted","edited","dismissed"])`](#fn-onpull_request_reviewwithtypes) + * [`fn withTypesMixin(value=["submitted","edited","dismissed"])`](#fn-onpull_request_reviewwithtypesmixin) + * [`obj pull_request_review_comment`](#obj-onpull_request_review_comment) + * [`fn withTypes(value=["created","edited","deleted"])`](#fn-onpull_request_review_commentwithtypes) + * [`fn withTypesMixin(value=["created","edited","deleted"])`](#fn-onpull_request_review_commentwithtypesmixin) + * [`obj pull_request_target`](#obj-onpull_request_target) + * [`fn withBranches(value)`](#fn-onpull_request_targetwithbranches) + * [`fn withBranchesIgnore(value)`](#fn-onpull_request_targetwithbranchesignore) + * [`fn withBranchesIgnoreMixin(value)`](#fn-onpull_request_targetwithbranchesignoremixin) + * [`fn withBranchesMixin(value)`](#fn-onpull_request_targetwithbranchesmixin) + * [`fn withPaths(value)`](#fn-onpull_request_targetwithpaths) + * [`fn withPathsIgnore(value)`](#fn-onpull_request_targetwithpathsignore) + * [`fn withPathsIgnoreMixin(value)`](#fn-onpull_request_targetwithpathsignoremixin) + * [`fn withPathsMixin(value)`](#fn-onpull_request_targetwithpathsmixin) + * [`fn withTags(value)`](#fn-onpull_request_targetwithtags) + * [`fn withTagsIgnore(value)`](#fn-onpull_request_targetwithtagsignore) + * [`fn withTagsIgnoreMixin(value)`](#fn-onpull_request_targetwithtagsignoremixin) + * [`fn withTagsMixin(value)`](#fn-onpull_request_targetwithtagsmixin) + * [`fn withTypes(value=["opened","synchronize","reopened"])`](#fn-onpull_request_targetwithtypes) + * [`fn withTypesMixin(value=["opened","synchronize","reopened"])`](#fn-onpull_request_targetwithtypesmixin) + * [`obj push`](#obj-onpush) + * [`fn withBranches(value)`](#fn-onpushwithbranches) + * [`fn withBranchesIgnore(value)`](#fn-onpushwithbranchesignore) + * [`fn withBranchesIgnoreMixin(value)`](#fn-onpushwithbranchesignoremixin) + * [`fn withBranchesMixin(value)`](#fn-onpushwithbranchesmixin) + * [`fn withPaths(value)`](#fn-onpushwithpaths) + * [`fn withPathsIgnore(value)`](#fn-onpushwithpathsignore) + * [`fn withPathsIgnoreMixin(value)`](#fn-onpushwithpathsignoremixin) + * [`fn withPathsMixin(value)`](#fn-onpushwithpathsmixin) + * [`fn withTags(value)`](#fn-onpushwithtags) + * [`fn withTagsIgnore(value)`](#fn-onpushwithtagsignore) + * [`fn withTagsIgnoreMixin(value)`](#fn-onpushwithtagsignoremixin) + * [`fn withTagsMixin(value)`](#fn-onpushwithtagsmixin) + * [`obj registry_package`](#obj-onregistry_package) + * [`fn withTypes(value=["published","updated"])`](#fn-onregistry_packagewithtypes) + * [`fn withTypesMixin(value=["published","updated"])`](#fn-onregistry_packagewithtypesmixin) + * [`obj release`](#obj-onrelease) + * [`fn withTypes(value=["published","unpublished","created","edited","deleted","prereleased","released"])`](#fn-onreleasewithtypes) + * [`fn withTypesMixin(value=["published","unpublished","created","edited","deleted","prereleased","released"])`](#fn-onreleasewithtypesmixin) + * [`obj workflow_run`](#obj-onworkflow_run) + * [`fn withTypes(value=["requested","completed"])`](#fn-onworkflow_runwithtypes) + * [`fn withTypesMixin(value=["requested","completed"])`](#fn-onworkflow_runwithtypesmixin) + * [`fn withWorkflows(value)`](#fn-onworkflow_runwithworkflows) + * [`fn withWorkflowsMixin(value)`](#fn-onworkflow_runwithworkflowsmixin) +* [`obj permissions`](#obj-permissions) + * [`fn withActions(value)`](#fn-permissionswithactions) + * [`fn withAttestations(value)`](#fn-permissionswithattestations) + * [`fn withChecks(value)`](#fn-permissionswithchecks) + * [`fn withContents(value)`](#fn-permissionswithcontents) + * [`fn withDeployments(value)`](#fn-permissionswithdeployments) + * [`fn withDiscussions(value)`](#fn-permissionswithdiscussions) + * [`fn withIdToken(value)`](#fn-permissionswithidtoken) + * [`fn withIssues(value)`](#fn-permissionswithissues) + * [`fn withPackages(value)`](#fn-permissionswithpackages) + * [`fn withPages(value)`](#fn-permissionswithpages) + * [`fn withPullRequests(value)`](#fn-permissionswithpullrequests) + * [`fn withRepositoryProjects(value)`](#fn-permissionswithrepositoryprojects) + * [`fn withSecurityEvents(value)`](#fn-permissionswithsecurityevents) + * [`fn withStatuses(value)`](#fn-permissionswithstatuses) + +## Fields + +### fn withConcurrency + +```jsonnet +withConcurrency(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + +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. +### fn withConcurrencyMixin + +```jsonnet +withConcurrencyMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + +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. +### fn withDefaults + +```jsonnet +withDefaults(value) +``` + +PARAMETERS: + +* **value** (`object`) + +A map of default settings that will apply to all jobs in the workflow. +### fn withDefaultsMixin + +```jsonnet +withDefaultsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +A map of default settings that will apply to all jobs in the workflow. +### fn withEnv + +```jsonnet +withEnv(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + +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..steps[*].env, jobs..env, and env keywords. For more information, see https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsenv +### fn withEnvMixin + +```jsonnet +withEnvMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + +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..steps[*].env, jobs..env, and env keywords. For more information, see https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsenv +### fn withJobs + +```jsonnet +withJobs(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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..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. +### fn withJobsMixin + +```jsonnet +withJobsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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..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. +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +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. +### fn withOn + +```jsonnet +withOn(value) +``` + +PARAMETERS: + +* **value** (`array`,`object`,`string`) + +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. +### fn withOnMixin + +```jsonnet +withOnMixin(value) +``` + +PARAMETERS: + +* **value** (`array`,`object`,`string`) + +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. +### fn withPermissions + +```jsonnet +withPermissions(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + +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. +### fn withPermissionsMixin + +```jsonnet +withPermissionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + +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. +### fn withRunName + +```jsonnet +withRunName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +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. +### obj concurrency + + +#### fn concurrency.withCancelInProgress + +```jsonnet +concurrency.withCancelInProgress(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`string`) + +To cancel any currently running job or workflow in the same concurrency group, specify cancel-in-progress: true. +#### fn concurrency.withCancelInProgressMixin + +```jsonnet +concurrency.withCancelInProgressMixin(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`string`) + +To cancel any currently running job or workflow in the same concurrency group, specify cancel-in-progress: true. +#### fn concurrency.withGroup + +```jsonnet +concurrency.withGroup(value) +``` + +PARAMETERS: + +* **value** (`string`) + +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. +#### obj concurrency.cancel-in-progress + + +##### fn concurrency.cancel-in-progress.withExpressionSyntax + +```jsonnet +concurrency.cancel-in-progress.withExpressionSyntax(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj defaults + + +#### fn defaults.withRun + +```jsonnet +defaults.withRun(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn defaults.withRunMixin + +```jsonnet +defaults.withRunMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### obj defaults.run + + +##### fn defaults.run.withShell + +```jsonnet +defaults.run.withShell(value) +``` + +PARAMETERS: + +* **value** (`string`) + +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. +##### fn defaults.run.withShellMixin + +```jsonnet +defaults.run.withShellMixin(value) +``` + +PARAMETERS: + +* **value** (`string`) + +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. +##### fn defaults.run.withWorkingDirectory + +```jsonnet +defaults.run.withWorkingDirectory(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Using the working-directory keyword, you can specify the working directory of where to run the command. +### obj env + + +#### fn env.withStringContainingExpressionSyntax + +```jsonnet +env.withStringContainingExpressionSyntax(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj on + + +#### fn on.withBranchProtectionRule + +```jsonnet +on.withBranchProtectionRule(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Runs your workflow anytime the branch_protection_rule event occurs. More than one activity type triggers this event. +#### fn on.withBranchProtectionRuleMixin + +```jsonnet +on.withBranchProtectionRuleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Runs your workflow anytime the branch_protection_rule event occurs. More than one activity type triggers this event. +#### fn on.withCheckRun + +```jsonnet +on.withCheckRun(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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. +#### fn on.withCheckRunMixin + +```jsonnet +on.withCheckRunMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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. +#### fn on.withCheckSuite + +```jsonnet +on.withCheckSuite(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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/. +#### fn on.withCheckSuiteMixin + +```jsonnet +on.withCheckSuiteMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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/. +#### fn on.withCreate + +```jsonnet +on.withCreate(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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. +#### fn on.withCreateMixin + +```jsonnet +on.withCreateMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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. +#### fn on.withDelete + +```jsonnet +on.withDelete(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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. +#### fn on.withDeleteMixin + +```jsonnet +on.withDeleteMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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. +#### fn on.withDeployment + +```jsonnet +on.withDeployment(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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/. +#### fn on.withDeploymentMixin + +```jsonnet +on.withDeploymentMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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/. +#### fn on.withDeploymentStatus + +```jsonnet +on.withDeploymentStatus(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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. +#### fn on.withDeploymentStatusMixin + +```jsonnet +on.withDeploymentStatusMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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. +#### fn on.withDiscussion + +```jsonnet +on.withDiscussion(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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 +#### fn on.withDiscussionComment + +```jsonnet +on.withDiscussionComment(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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 +#### fn on.withDiscussionCommentMixin + +```jsonnet +on.withDiscussionCommentMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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 +#### fn on.withDiscussionMixin + +```jsonnet +on.withDiscussionMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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 +#### fn on.withEvent + +```jsonnet +on.withEvent(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"branch_protection_rule"`, `"check_run"`, `"check_suite"`, `"create"`, `"delete"`, `"deployment"`, `"deployment_status"`, `"discussion"`, `"discussion_comment"`, `"fork"`, `"gollum"`, `"issue_comment"`, `"issues"`, `"label"`, `"merge_group"`, `"milestone"`, `"page_build"`, `"project"`, `"project_card"`, `"project_column"`, `"public"`, `"pull_request"`, `"pull_request_review"`, `"pull_request_review_comment"`, `"pull_request_target"`, `"push"`, `"registry_package"`, `"release"`, `"status"`, `"watch"`, `"workflow_call"`, `"workflow_dispatch"`, `"workflow_run"`, `"repository_dispatch"` + + +#### fn on.withFork + +```jsonnet +on.withFork(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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. +#### fn on.withForkMixin + +```jsonnet +on.withForkMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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. +#### fn on.withGollum + +```jsonnet +on.withGollum(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Runs your workflow when someone creates or updates a Wiki page, which triggers the gollum event. +#### fn on.withGollumMixin + +```jsonnet +on.withGollumMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Runs your workflow when someone creates or updates a Wiki page, which triggers the gollum event. +#### fn on.withIssueComment + +```jsonnet +on.withIssueComment(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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/. +#### fn on.withIssueCommentMixin + +```jsonnet +on.withIssueCommentMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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/. +#### fn on.withIssues + +```jsonnet +on.withIssues(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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. +#### fn on.withIssuesMixin + +```jsonnet +on.withIssuesMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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. +#### fn on.withLabel + +```jsonnet +on.withLabel(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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/. +#### fn on.withLabelMixin + +```jsonnet +on.withLabelMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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/. +#### fn on.withMergeGroup + +```jsonnet +on.withMergeGroup(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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 . +#### fn on.withMergeGroupMixin + +```jsonnet +on.withMergeGroupMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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 . +#### fn on.withMilestone + +```jsonnet +on.withMilestone(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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/. +#### fn on.withMilestoneMixin + +```jsonnet +on.withMilestoneMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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/. +#### fn on.withPageBuild + +```jsonnet +on.withPageBuild(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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/. +#### fn on.withPageBuildMixin + +```jsonnet +on.withPageBuildMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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/. +#### fn on.withProject + +```jsonnet +on.withProject(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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/. +#### fn on.withProjectCard + +```jsonnet +on.withProjectCard(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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. +#### fn on.withProjectCardMixin + +```jsonnet +on.withProjectCardMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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. +#### fn on.withProjectColumn + +```jsonnet +on.withProjectColumn(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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. +#### fn on.withProjectColumnMixin + +```jsonnet +on.withProjectColumnMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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. +#### fn on.withProjectMixin + +```jsonnet +on.withProjectMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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/. +#### fn on.withPublic + +```jsonnet +on.withPublic(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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. +#### fn on.withPublicMixin + +```jsonnet +on.withPublicMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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. +#### fn on.withPullRequest + +```jsonnet +on.withPullRequest(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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. +#### fn on.withPullRequestMixin + +```jsonnet +on.withPullRequestMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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. +#### fn on.withPullRequestReview + +```jsonnet +on.withPullRequestReview(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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. +#### fn on.withPullRequestReviewComment + +```jsonnet +on.withPullRequestReviewComment(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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. +#### fn on.withPullRequestReviewCommentMixin + +```jsonnet +on.withPullRequestReviewCommentMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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. +#### fn on.withPullRequestReviewMixin + +```jsonnet +on.withPullRequestReviewMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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. +#### fn on.withPullRequestTarget + +```jsonnet +on.withPullRequestTarget(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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. +#### fn on.withPullRequestTargetMixin + +```jsonnet +on.withPullRequestTargetMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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. +#### fn on.withPush + +```jsonnet +on.withPush(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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. +#### fn on.withPushMixin + +```jsonnet +on.withPushMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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. +#### fn on.withRegistryPackage + +```jsonnet +on.withRegistryPackage(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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. +#### fn on.withRegistryPackageMixin + +```jsonnet +on.withRegistryPackageMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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. +#### fn on.withRelease + +```jsonnet +on.withRelease(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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. +#### fn on.withReleaseMixin + +```jsonnet +on.withReleaseMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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. +#### fn on.withRepositoryDispatch + +```jsonnet +on.withRepositoryDispatch(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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. +#### fn on.withRepositoryDispatchMixin + +```jsonnet +on.withRepositoryDispatchMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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. +#### fn on.withSchedule + +```jsonnet +on.withSchedule(value) +``` + +PARAMETERS: + +* **value** (`array`) + +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). +#### fn on.withScheduleMixin + +```jsonnet +on.withScheduleMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +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). +#### fn on.withStatus + +```jsonnet +on.withStatus(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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/. +#### fn on.withStatusMixin + +```jsonnet +on.withStatusMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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/. +#### fn on.withWatch + +```jsonnet +on.withWatch(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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/. +#### fn on.withWatchMixin + +```jsonnet +on.withWatchMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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/. +#### fn on.withWorkflowCall + +```jsonnet +on.withWorkflowCall(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Allows workflows to be reused by other workflows. +#### fn on.withWorkflowDispatch + +```jsonnet +on.withWorkflowDispatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + +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. +#### fn on.withWorkflowRun + +```jsonnet +on.withWorkflowRun(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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. +#### fn on.withWorkflowRunMixin + +```jsonnet +on.withWorkflowRunMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +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. +#### obj on.branch_protection_rule + + +##### fn on.branch_protection_rule.withTypes + +```jsonnet +on.branch_protection_rule.withTypes(value=["created","edited","deleted"]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `["created","edited","deleted"]` + +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. +##### fn on.branch_protection_rule.withTypesMixin + +```jsonnet +on.branch_protection_rule.withTypesMixin(value=["created","edited","deleted"]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `["created","edited","deleted"]` + +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. +#### obj on.check_run + + +##### fn on.check_run.withTypes + +```jsonnet +on.check_run.withTypes(value=["created","rerequested","completed","requested_action"]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `["created","rerequested","completed","requested_action"]` + +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. +##### fn on.check_run.withTypesMixin + +```jsonnet +on.check_run.withTypesMixin(value=["created","rerequested","completed","requested_action"]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `["created","rerequested","completed","requested_action"]` + +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. +#### obj on.check_suite + + +##### fn on.check_suite.withTypes + +```jsonnet +on.check_suite.withTypes(value=["completed","requested","rerequested"]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `["completed","requested","rerequested"]` + +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. +##### fn on.check_suite.withTypesMixin + +```jsonnet +on.check_suite.withTypesMixin(value=["completed","requested","rerequested"]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `["completed","requested","rerequested"]` + +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. +#### obj on.discussion + + +##### fn on.discussion.withTypes + +```jsonnet +on.discussion.withTypes(value=["created","edited","deleted","transferred","pinned","unpinned","labeled","unlabeled","locked","unlocked","category_changed","answered","unanswered"]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `["created","edited","deleted","transferred","pinned","unpinned","labeled","unlabeled","locked","unlocked","category_changed","answered","unanswered"]` + +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. +##### fn on.discussion.withTypesMixin + +```jsonnet +on.discussion.withTypesMixin(value=["created","edited","deleted","transferred","pinned","unpinned","labeled","unlabeled","locked","unlocked","category_changed","answered","unanswered"]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `["created","edited","deleted","transferred","pinned","unpinned","labeled","unlabeled","locked","unlocked","category_changed","answered","unanswered"]` + +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. +#### obj on.discussion_comment + + +##### fn on.discussion_comment.withTypes + +```jsonnet +on.discussion_comment.withTypes(value=["created","edited","deleted"]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `["created","edited","deleted"]` + +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. +##### fn on.discussion_comment.withTypesMixin + +```jsonnet +on.discussion_comment.withTypesMixin(value=["created","edited","deleted"]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `["created","edited","deleted"]` + +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. +#### obj on.issue_comment + + +##### fn on.issue_comment.withTypes + +```jsonnet +on.issue_comment.withTypes(value=["created","edited","deleted"]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `["created","edited","deleted"]` + +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. +##### fn on.issue_comment.withTypesMixin + +```jsonnet +on.issue_comment.withTypesMixin(value=["created","edited","deleted"]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `["created","edited","deleted"]` + +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. +#### obj on.issues + + +##### fn on.issues.withTypes + +```jsonnet +on.issues.withTypes(value=["opened","edited","deleted","transferred","pinned","unpinned","closed","reopened","assigned","unassigned","labeled","unlabeled","locked","unlocked","milestoned","demilestoned"]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `["opened","edited","deleted","transferred","pinned","unpinned","closed","reopened","assigned","unassigned","labeled","unlabeled","locked","unlocked","milestoned","demilestoned"]` + +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. +##### fn on.issues.withTypesMixin + +```jsonnet +on.issues.withTypesMixin(value=["opened","edited","deleted","transferred","pinned","unpinned","closed","reopened","assigned","unassigned","labeled","unlabeled","locked","unlocked","milestoned","demilestoned"]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `["opened","edited","deleted","transferred","pinned","unpinned","closed","reopened","assigned","unassigned","labeled","unlabeled","locked","unlocked","milestoned","demilestoned"]` + +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. +#### obj on.label + + +##### fn on.label.withTypes + +```jsonnet +on.label.withTypes(value=["created","edited","deleted"]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `["created","edited","deleted"]` + +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. +##### fn on.label.withTypesMixin + +```jsonnet +on.label.withTypesMixin(value=["created","edited","deleted"]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `["created","edited","deleted"]` + +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. +#### obj on.merge_group + + +##### fn on.merge_group.withTypes + +```jsonnet +on.merge_group.withTypes(value=["checks_requested"]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `["checks_requested"]` + +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. +##### fn on.merge_group.withTypesMixin + +```jsonnet +on.merge_group.withTypesMixin(value=["checks_requested"]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `["checks_requested"]` + +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. +#### obj on.milestone + + +##### fn on.milestone.withTypes + +```jsonnet +on.milestone.withTypes(value=["created","closed","opened","edited","deleted"]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `["created","closed","opened","edited","deleted"]` + +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. +##### fn on.milestone.withTypesMixin + +```jsonnet +on.milestone.withTypesMixin(value=["created","closed","opened","edited","deleted"]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `["created","closed","opened","edited","deleted"]` + +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. +#### obj on.project + + +##### fn on.project.withTypes + +```jsonnet +on.project.withTypes(value=["created","updated","closed","reopened","edited","deleted"]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `["created","updated","closed","reopened","edited","deleted"]` + +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. +##### fn on.project.withTypesMixin + +```jsonnet +on.project.withTypesMixin(value=["created","updated","closed","reopened","edited","deleted"]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `["created","updated","closed","reopened","edited","deleted"]` + +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. +#### obj on.project_card + + +##### fn on.project_card.withTypes + +```jsonnet +on.project_card.withTypes(value=["created","moved","converted","edited","deleted"]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `["created","moved","converted","edited","deleted"]` + +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. +##### fn on.project_card.withTypesMixin + +```jsonnet +on.project_card.withTypesMixin(value=["created","moved","converted","edited","deleted"]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `["created","moved","converted","edited","deleted"]` + +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. +#### obj on.project_column + + +##### fn on.project_column.withTypes + +```jsonnet +on.project_column.withTypes(value=["created","updated","moved","deleted"]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `["created","updated","moved","deleted"]` + +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. +##### fn on.project_column.withTypesMixin + +```jsonnet +on.project_column.withTypesMixin(value=["created","updated","moved","deleted"]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `["created","updated","moved","deleted"]` + +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. +#### obj on.pull_request + + +##### fn on.pull_request.withBranches + +```jsonnet +on.pull_request.withBranches(value) +``` + +PARAMETERS: + +* **value** (`array`) + +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. +##### fn on.pull_request.withBranchesIgnore + +```jsonnet +on.pull_request.withBranchesIgnore(value) +``` + +PARAMETERS: + +* **value** (`array`) + +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. +##### fn on.pull_request.withBranchesIgnoreMixin + +```jsonnet +on.pull_request.withBranchesIgnoreMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +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. +##### fn on.pull_request.withBranchesMixin + +```jsonnet +on.pull_request.withBranchesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +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. +##### fn on.pull_request.withPaths + +```jsonnet +on.pull_request.withPaths(value) +``` + +PARAMETERS: + +* **value** (`array`) + +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. +##### fn on.pull_request.withPathsIgnore + +```jsonnet +on.pull_request.withPathsIgnore(value) +``` + +PARAMETERS: + +* **value** (`array`) + +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. +##### fn on.pull_request.withPathsIgnoreMixin + +```jsonnet +on.pull_request.withPathsIgnoreMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +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. +##### fn on.pull_request.withPathsMixin + +```jsonnet +on.pull_request.withPathsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +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. +##### fn on.pull_request.withTags + +```jsonnet +on.pull_request.withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +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. +##### fn on.pull_request.withTagsIgnore + +```jsonnet +on.pull_request.withTagsIgnore(value) +``` + +PARAMETERS: + +* **value** (`array`) + +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. +##### fn on.pull_request.withTagsIgnoreMixin + +```jsonnet +on.pull_request.withTagsIgnoreMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +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. +##### fn on.pull_request.withTagsMixin + +```jsonnet +on.pull_request.withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +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. +##### fn on.pull_request.withTypes + +```jsonnet +on.pull_request.withTypes(value=["opened","synchronize","reopened"]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `["opened","synchronize","reopened"]` + +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. +##### fn on.pull_request.withTypesMixin + +```jsonnet +on.pull_request.withTypesMixin(value=["opened","synchronize","reopened"]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `["opened","synchronize","reopened"]` + +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. +#### obj on.pull_request_review + + +##### fn on.pull_request_review.withTypes + +```jsonnet +on.pull_request_review.withTypes(value=["submitted","edited","dismissed"]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `["submitted","edited","dismissed"]` + +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. +##### fn on.pull_request_review.withTypesMixin + +```jsonnet +on.pull_request_review.withTypesMixin(value=["submitted","edited","dismissed"]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `["submitted","edited","dismissed"]` + +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. +#### obj on.pull_request_review_comment + + +##### fn on.pull_request_review_comment.withTypes + +```jsonnet +on.pull_request_review_comment.withTypes(value=["created","edited","deleted"]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `["created","edited","deleted"]` + +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. +##### fn on.pull_request_review_comment.withTypesMixin + +```jsonnet +on.pull_request_review_comment.withTypesMixin(value=["created","edited","deleted"]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `["created","edited","deleted"]` + +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. +#### obj on.pull_request_target + + +##### fn on.pull_request_target.withBranches + +```jsonnet +on.pull_request_target.withBranches(value) +``` + +PARAMETERS: + +* **value** (`array`) + +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. +##### fn on.pull_request_target.withBranchesIgnore + +```jsonnet +on.pull_request_target.withBranchesIgnore(value) +``` + +PARAMETERS: + +* **value** (`array`) + +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. +##### fn on.pull_request_target.withBranchesIgnoreMixin + +```jsonnet +on.pull_request_target.withBranchesIgnoreMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +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. +##### fn on.pull_request_target.withBranchesMixin + +```jsonnet +on.pull_request_target.withBranchesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +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. +##### fn on.pull_request_target.withPaths + +```jsonnet +on.pull_request_target.withPaths(value) +``` + +PARAMETERS: + +* **value** (`array`) + +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. +##### fn on.pull_request_target.withPathsIgnore + +```jsonnet +on.pull_request_target.withPathsIgnore(value) +``` + +PARAMETERS: + +* **value** (`array`) + +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. +##### fn on.pull_request_target.withPathsIgnoreMixin + +```jsonnet +on.pull_request_target.withPathsIgnoreMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +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. +##### fn on.pull_request_target.withPathsMixin + +```jsonnet +on.pull_request_target.withPathsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +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. +##### fn on.pull_request_target.withTags + +```jsonnet +on.pull_request_target.withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +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. +##### fn on.pull_request_target.withTagsIgnore + +```jsonnet +on.pull_request_target.withTagsIgnore(value) +``` + +PARAMETERS: + +* **value** (`array`) + +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. +##### fn on.pull_request_target.withTagsIgnoreMixin + +```jsonnet +on.pull_request_target.withTagsIgnoreMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +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. +##### fn on.pull_request_target.withTagsMixin + +```jsonnet +on.pull_request_target.withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +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. +##### fn on.pull_request_target.withTypes + +```jsonnet +on.pull_request_target.withTypes(value=["opened","synchronize","reopened"]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `["opened","synchronize","reopened"]` + +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. +##### fn on.pull_request_target.withTypesMixin + +```jsonnet +on.pull_request_target.withTypesMixin(value=["opened","synchronize","reopened"]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `["opened","synchronize","reopened"]` + +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. +#### obj on.push + + +##### fn on.push.withBranches + +```jsonnet +on.push.withBranches(value) +``` + +PARAMETERS: + +* **value** (`array`) + +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. +##### fn on.push.withBranchesIgnore + +```jsonnet +on.push.withBranchesIgnore(value) +``` + +PARAMETERS: + +* **value** (`array`) + +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. +##### fn on.push.withBranchesIgnoreMixin + +```jsonnet +on.push.withBranchesIgnoreMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +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. +##### fn on.push.withBranchesMixin + +```jsonnet +on.push.withBranchesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +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. +##### fn on.push.withPaths + +```jsonnet +on.push.withPaths(value) +``` + +PARAMETERS: + +* **value** (`array`) + +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. +##### fn on.push.withPathsIgnore + +```jsonnet +on.push.withPathsIgnore(value) +``` + +PARAMETERS: + +* **value** (`array`) + +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. +##### fn on.push.withPathsIgnoreMixin + +```jsonnet +on.push.withPathsIgnoreMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +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. +##### fn on.push.withPathsMixin + +```jsonnet +on.push.withPathsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +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. +##### fn on.push.withTags + +```jsonnet +on.push.withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +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. +##### fn on.push.withTagsIgnore + +```jsonnet +on.push.withTagsIgnore(value) +``` + +PARAMETERS: + +* **value** (`array`) + +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. +##### fn on.push.withTagsIgnoreMixin + +```jsonnet +on.push.withTagsIgnoreMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +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. +##### fn on.push.withTagsMixin + +```jsonnet +on.push.withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +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. +#### obj on.registry_package + + +##### fn on.registry_package.withTypes + +```jsonnet +on.registry_package.withTypes(value=["published","updated"]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `["published","updated"]` + +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. +##### fn on.registry_package.withTypesMixin + +```jsonnet +on.registry_package.withTypesMixin(value=["published","updated"]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `["published","updated"]` + +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. +#### obj on.release + + +##### fn on.release.withTypes + +```jsonnet +on.release.withTypes(value=["published","unpublished","created","edited","deleted","prereleased","released"]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `["published","unpublished","created","edited","deleted","prereleased","released"]` + +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. +##### fn on.release.withTypesMixin + +```jsonnet +on.release.withTypesMixin(value=["published","unpublished","created","edited","deleted","prereleased","released"]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `["published","unpublished","created","edited","deleted","prereleased","released"]` + +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. +#### obj on.workflow_run + + +##### fn on.workflow_run.withTypes + +```jsonnet +on.workflow_run.withTypes(value=["requested","completed"]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `["requested","completed"]` + +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. +##### fn on.workflow_run.withTypesMixin + +```jsonnet +on.workflow_run.withTypesMixin(value=["requested","completed"]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `["requested","completed"]` + +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. +##### fn on.workflow_run.withWorkflows + +```jsonnet +on.workflow_run.withWorkflows(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn on.workflow_run.withWorkflowsMixin + +```jsonnet +on.workflow_run.withWorkflowsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### obj permissions + + +#### fn permissions.withActions + +```jsonnet +permissions.withActions(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"read"`, `"write"`, `"none"` + + +#### fn permissions.withAttestations + +```jsonnet +permissions.withAttestations(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"read"`, `"write"`, `"none"` + + +#### fn permissions.withChecks + +```jsonnet +permissions.withChecks(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"read"`, `"write"`, `"none"` + + +#### fn permissions.withContents + +```jsonnet +permissions.withContents(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"read"`, `"write"`, `"none"` + + +#### fn permissions.withDeployments + +```jsonnet +permissions.withDeployments(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"read"`, `"write"`, `"none"` + + +#### fn permissions.withDiscussions + +```jsonnet +permissions.withDiscussions(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"read"`, `"write"`, `"none"` + + +#### fn permissions.withIdToken + +```jsonnet +permissions.withIdToken(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"read"`, `"write"`, `"none"` + + +#### fn permissions.withIssues + +```jsonnet +permissions.withIssues(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"read"`, `"write"`, `"none"` + + +#### fn permissions.withPackages + +```jsonnet +permissions.withPackages(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"read"`, `"write"`, `"none"` + + +#### fn permissions.withPages + +```jsonnet +permissions.withPages(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"read"`, `"write"`, `"none"` + + +#### fn permissions.withPullRequests + +```jsonnet +permissions.withPullRequests(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"read"`, `"write"`, `"none"` + + +#### fn permissions.withRepositoryProjects + +```jsonnet +permissions.withRepositoryProjects(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"read"`, `"write"`, `"none"` + + +#### fn permissions.withSecurityEvents + +```jsonnet +permissions.withSecurityEvents(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"read"`, `"write"`, `"none"` + + +#### fn permissions.withStatuses + +```jsonnet +permissions.withStatuses(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"read"`, `"write"`, `"none"` + diff --git a/example.jsonnet b/example.jsonnet new file mode 100644 index 0000000..c8ea874 --- /dev/null +++ b/example.jsonnet @@ -0,0 +1,15 @@ +local ga = import './main.libsonnet'; + +local exampleWorkflow = + ga.workflow.withName('example workflow') + + ga.workflow.on.pull_request.withBranches(['main']) + + ga.workflow.withJobs({ + example: + ga.job.withRunsOn('ubuntu-latest') + + ga.job.withSteps( + ga.job.step.withName('Checkout') + + ga.job.step.withUses('actions/checkout@v4') + ), + }); + +std.manifestYamlDoc(exampleWorkflow, indent_array_in_object=true, quote_keys=false) diff --git a/gen/normalJob.libsonnet b/gen/normalJob.libsonnet deleted file mode 100644 index 308d77d..0000000 --- a/gen/normalJob.libsonnet +++ /dev/null @@ -1,142 +0,0 @@ -{ - '#withConcurrency': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: '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. \nYou can also specify concurrency at the workflow level. \nWhen 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.' } }, - withConcurrency(value): { concurrency: value }, - '#withConcurrencyMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: '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. \nYou can also specify concurrency at the workflow level. \nWhen 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.' } }, - withConcurrencyMixin(value): { concurrency+: value }, - concurrency+: - { - '#withConcurrency': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: '' } }, - withConcurrency(value): { concurrency: value }, - }, - '#withContainer': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: "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.\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." } }, - withContainer(value): { container: value }, - '#withContainerMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: "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.\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." } }, - withContainerMixin(value): { container+: value }, - container+: - { - '#withContainer': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: '' } }, - withContainer(value): { container: value }, - }, - '#withContinueOnError': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'boolean' }], help: 'Prevents a workflow run from failing when a job fails. Set to true to allow a workflow run to pass when this job fails.' } }, - withContinueOnError(value): { 'continue-on-error': value }, - '#withContinueOnErrorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'boolean' }], help: 'Prevents a workflow run from failing when a job fails. Set to true to allow a workflow run to pass when this job fails.' } }, - withContinueOnErrorMixin(value): { 'continue-on-error'+: value }, - 'continue-on-error'+: - { - '#withExpressionSyntax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: '' } }, - withExpressionSyntax(value): { 'continue-on-error'+: { expressionSyntax: value } }, - }, - '#withDefaults': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: '' } }, - withDefaults(value): { defaults: value }, - '#withEnv': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: '' } }, - withEnv(value): { env: value }, - '#withEnvironment': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: 'The environment that the job references.' } }, - withEnvironment(value): { environment: value }, - '#withEnvironmentMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: 'The environment that the job references.' } }, - withEnvironmentMixin(value): { environment+: value }, - environment+: - { - '#withEnvironment': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: '' } }, - withEnvironment(value): { environment: value }, - }, - '#withIf': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number', 'string'] }], help: '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.\nExpressions 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.' } }, - withIf(value): { 'if': value }, - '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: 'The name of the job displayed on GitHub.' } }, - withName(value): { name: value }, - '#withNeeds': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: '' } }, - withNeeds(value): { needs: value }, - '#withOutputs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: 'A map of outputs for a job. Job outputs are available to all downstream jobs that depend on this job.' } }, - withOutputs(value): { outputs: value }, - '#withOutputsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: 'A map of outputs for a job. Job outputs are available to all downstream jobs that depend on this job.' } }, - withOutputsMixin(value): { outputs+: value }, - '#withPermissions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: '' } }, - withPermissions(value): { permissions: value }, - '#withRunsOn': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: 'The type of machine to run the job on. The machine can be either a GitHub-hosted runner, or a self-hosted runner.' } }, - withRunsOn(value): { 'runs-on': value }, - '#withRunsOnMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: 'The type of machine to run the job on. The machine can be either a GitHub-hosted runner, or a self-hosted runner.' } }, - withRunsOnMixin(value): { 'runs-on'+: value }, - 'runs-on'+: - { - '#withGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: '' } }, - withGroup(value): { 'runs-on'+: { group: value } }, - '#withLabels': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: '' } }, - withLabels(value): { 'runs-on'+: { labels: value } }, - '#withLabelsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: '' } }, - withLabelsMixin(value): { 'runs-on'+: { labels+: value } }, - '#withStringContainingExpressionSyntax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: '' } }, - withStringContainingExpressionSyntax(value): { 'runs-on'+: { stringContainingExpressionSyntax: value } }, - }, - '#withServices': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: "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.\nWhen 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.\nWhen 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.\nWhen a step does not use a container action, you must access the service using localhost and bind the ports." } }, - withServices(value): { services: value }, - '#withServicesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: "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.\nWhen 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.\nWhen 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.\nWhen a step does not use a container action, you must access the service using localhost and bind the ports." } }, - withServicesMixin(value): { services+: value }, - '#withSteps': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'array' }], help: '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.\nMust contain either `uses` or `run`\n' } }, - withSteps(value): { steps: (if std.isArray(value) - then value - else [value]) }, - '#withStepsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'array' }], help: '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.\nMust contain either `uses` or `run`\n' } }, - withStepsMixin(value): { steps+: (if std.isArray(value) - then value - else [value]) }, - steps+: - { - '#withContinueOnError': { 'function': { args: [{ default: false, enums: null, name: 'value', type: 'boolean' }], help: 'Prevents a job from failing when a step fails. Set to true to allow a job to pass when this step fails.' } }, - withContinueOnError(value=false): { 'continue-on-error': value }, - '#withContinueOnErrorMixin': { 'function': { args: [{ default: false, enums: null, name: 'value', type: 'boolean' }], help: 'Prevents a job from failing when a step fails. Set to true to allow a job to pass when this step fails.' } }, - withContinueOnErrorMixin(value): { 'continue-on-error'+: value }, - 'continue-on-error'+: - { - '#withExpressionSyntax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: '' } }, - withExpressionSyntax(value): { 'continue-on-error'+: { expressionSyntax: value } }, - }, - '#withEnv': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: '' } }, - withEnv(value): { env: value }, - '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: '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.' } }, - withId(value): { id: value }, - '#withIf': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number', 'string'] }], help: '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.\nExpressions 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.' } }, - withIf(value): { 'if': value }, - '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: 'A name for your step to display on GitHub.' } }, - withName(value): { name: value }, - '#withRun': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: "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.\nCommands 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.\nEach 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." } }, - withRun(value): { run: value }, - '#withShell': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: '' } }, - withShell(value): { shell: value }, - '#withTimeoutMinutes': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'number' }], help: 'The maximum number of minutes to run the step before killing the process.' } }, - withTimeoutMinutes(value): { 'timeout-minutes': value }, - '#withTimeoutMinutesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'number' }], help: 'The maximum number of minutes to run the step before killing the process.' } }, - withTimeoutMinutesMixin(value): { 'timeout-minutes'+: value }, - 'timeout-minutes'+: - { - '#withExpressionSyntax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: '' } }, - withExpressionSyntax(value): { 'timeout-minutes'+: { expressionSyntax: value } }, - }, - '#withUses': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: "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/).\nWe 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.\n- Using the commit SHA of a released action version is the safest for stability and security.\n- 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.\n- 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.\nSome actions require inputs that you must set using the with keyword. Review the action's README file to determine the inputs required.\nActions 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." } }, - withUses(value): { uses: value }, - '#withWith': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: '' } }, - withWith(value): { with: value }, - '#withWorkingDirectory': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: '' } }, - withWorkingDirectory(value): { 'working-directory': value }, - }, - '#withStrategy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: 'A strategy creates a build matrix for your jobs. You can define different variations of an environment to run each job in.' } }, - withStrategy(value): { strategy: value }, - '#withStrategyMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: 'A strategy creates a build matrix for your jobs. You can define different variations of an environment to run each job in.' } }, - withStrategyMixin(value): { strategy+: value }, - strategy+: - { - '#withFailFast': { 'function': { args: [{ default: true, enums: null, name: 'value', type: 'boolean' }], help: 'When set to true, GitHub cancels all in-progress jobs if any matrix job fails. Default: true' } }, - withFailFast(value=true): { strategy+: { 'fail-fast': value } }, - '#withMatrix': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: '' } }, - withMatrix(value): { strategy+: { matrix: value } }, - '#withMaxParallel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number', 'string'] }], help: '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.' } }, - withMaxParallel(value): { strategy+: { 'max-parallel': value } }, - }, - '#withTimeoutMinutes': { 'function': { args: [{ default: 360, enums: null, name: 'value', type: 'number' }], help: 'The maximum number of minutes to let a workflow run before GitHub automatically cancels it. Default: 360' } }, - withTimeoutMinutes(value=360): { 'timeout-minutes': value }, - '#withTimeoutMinutesMixin': { 'function': { args: [{ default: 360, enums: null, name: 'value', type: 'number' }], help: 'The maximum number of minutes to let a workflow run before GitHub automatically cancels it. Default: 360' } }, - withTimeoutMinutesMixin(value): { 'timeout-minutes'+: value }, - 'timeout-minutes'+: - { - '#withExpressionSyntax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: '' } }, - withExpressionSyntax(value): { 'timeout-minutes'+: { expressionSyntax: value } }, - }, -} diff --git a/gen/reusableWorkflowCallJob.libsonnet b/gen/reusableWorkflowCallJob.libsonnet deleted file mode 100644 index 560d971..0000000 --- a/gen/reusableWorkflowCallJob.libsonnet +++ /dev/null @@ -1,45 +0,0 @@ -{ - '#withConcurrency': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: '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. \nYou can also specify concurrency at the workflow level. \nWhen 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.' } }, - withConcurrency(value): { concurrency: value }, - '#withConcurrencyMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: '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. \nYou can also specify concurrency at the workflow level. \nWhen 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.' } }, - withConcurrencyMixin(value): { concurrency+: value }, - concurrency+: - { - '#withConcurrency': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: '' } }, - withConcurrency(value): { concurrency: value }, - }, - '#withIf': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number', 'string'] }], help: '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.\nExpressions 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.' } }, - withIf(value): { 'if': value }, - '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: 'The name of the job displayed on GitHub.' } }, - withName(value): { name: value }, - '#withNeeds': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: '' } }, - withNeeds(value): { needs: value }, - '#withPermissions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: '' } }, - withPermissions(value): { permissions: value }, - '#withSecrets': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: "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." } }, - withSecrets(value): { secrets: value }, - '#withSecretsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: "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." } }, - withSecretsMixin(value): { secrets+: value }, - secrets+: - { - '#withEnv': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: '' } }, - withEnv(value): { secrets+: { env: value } }, - }, - '#withStrategy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: 'A strategy creates a build matrix for your jobs. You can define different variations of an environment to run each job in.' } }, - withStrategy(value): { strategy: value }, - '#withStrategyMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: 'A strategy creates a build matrix for your jobs. You can define different variations of an environment to run each job in.' } }, - withStrategyMixin(value): { strategy+: value }, - strategy+: - { - '#withFailFast': { 'function': { args: [{ default: true, enums: null, name: 'value', type: 'boolean' }], help: 'When set to true, GitHub cancels all in-progress jobs if any matrix job fails. Default: true' } }, - withFailFast(value=true): { strategy+: { 'fail-fast': value } }, - '#withMatrix': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: '' } }, - withMatrix(value): { strategy+: { matrix: value } }, - '#withMaxParallel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number', 'string'] }], help: '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.' } }, - withMaxParallel(value): { strategy+: { 'max-parallel': value } }, - }, - '#withUses': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: "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." } }, - withUses(value): { uses: value }, - '#withWith': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: '' } }, - withWith(value): { with: value }, -} diff --git a/gen/workflow.libsonnet b/gen/workflow.libsonnet deleted file mode 100644 index ce38c03..0000000 --- a/gen/workflow.libsonnet +++ /dev/null @@ -1,257 +0,0 @@ -{ - '#withConcurrency': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: '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. \nYou can also specify concurrency at the workflow level. \nWhen 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.' } }, - withConcurrency(value): { concurrency: value }, - '#withConcurrencyMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: '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. \nYou can also specify concurrency at the workflow level. \nWhen 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.' } }, - withConcurrencyMixin(value): { concurrency+: value }, - concurrency+: - { - '#withConcurrency': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withConcurrency(value): { concurrency: value }, - '#withConcurrencyMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withConcurrencyMixin(value): { concurrency+: value }, - concurrency+: - { - '#withCancelInProgress': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'boolean' }], help: 'To cancel any currently running job or workflow in the same concurrency group, specify cancel-in-progress: true.' } }, - withCancelInProgress(value): { concurrency+: { 'cancel-in-progress': value } }, - '#withCancelInProgressMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'boolean' }], help: 'To cancel any currently running job or workflow in the same concurrency group, specify cancel-in-progress: true.' } }, - withCancelInProgressMixin(value): { concurrency+: { 'cancel-in-progress'+: value } }, - 'cancel-in-progress'+: - { - '#withExpressionSyntax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: '' } }, - withExpressionSyntax(value): { concurrency+: { 'cancel-in-progress'+: { expressionSyntax: value } } }, - }, - '#withGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: '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.' } }, - withGroup(value): { concurrency+: { group: value } }, - }, - }, - '#withDefaults': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withDefaults(value): { defaults: value }, - '#withDefaultsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withDefaultsMixin(value): { defaults+: value }, - defaults+: - { - '#withRun': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withRun(value): { defaults+: { run: value } }, - '#withRunMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withRunMixin(value): { defaults+: { run+: value } }, - run+: - { - '#withShell': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: "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." } }, - withShell(value): { defaults+: { run+: { shell: value } } }, - '#withShellMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: "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." } }, - withShellMixin(value): { defaults+: { run+: { shell+: value } } }, - '#withWorkingDirectory': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: 'Using the working-directory keyword, you can specify the working directory of where to run the command.' } }, - withWorkingDirectory(value): { defaults+: { run+: { 'working-directory': value } } }, - }, - }, - '#withEnv': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '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..steps[*].env, jobs..env, and env keywords. For more information, see https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsenv' } }, - withEnv(value): { env: value }, - '#withEnvMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '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..steps[*].env, jobs..env, and env keywords. For more information, see https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsenv' } }, - withEnvMixin(value): { env+: value }, - env+: - { - '#withStringContainingExpressionSyntax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: '' } }, - withStringContainingExpressionSyntax(value): { env+: { stringContainingExpressionSyntax: value } }, - }, - '#withJobs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '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..needs keyword.\nEach job runs in a fresh instance of the virtual environment specified by runs-on.\nYou 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.' } }, - withJobs(value): { jobs: value }, - '#withJobsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '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..needs keyword.\nEach job runs in a fresh instance of the virtual environment specified by runs-on.\nYou 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.' } }, - withJobsMixin(value): { jobs+: value }, - '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: "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." } }, - withName(value): { name: value }, - '#withOn': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: '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.' } }, - withOn(value): { on: value }, - '#withOnMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: '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.' } }, - withOnMixin(value): { on+: value }, - on+: - { - '#withEvent': { 'function': { args: [{ default: null, enums: ['branch_protection_rule', 'check_run', 'check_suite', 'create', 'delete', 'deployment', 'deployment_status', 'discussion', 'discussion_comment', 'fork', 'gollum', 'issue_comment', 'issues', 'label', 'member', 'milestone', 'page_build', 'project', 'project_card', 'project_column', 'public', 'pull_request', 'pull_request_review', 'pull_request_review_comment', 'pull_request_target', 'push', 'registry_package', 'release', 'status', 'watch', 'workflow_call', 'workflow_dispatch', 'workflow_run', 'repository_dispatch'], name: 'value', type: 'string' }], help: '' } }, - withEvent(value): { on+: { event: value } }, - '#withBranchProtectionRule': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withBranchProtectionRule(value): { on+: { branch_protection_rule: value } }, - '#withBranchProtectionRuleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withBranchProtectionRuleMixin(value): { on+: { branch_protection_rule+: value } }, - '#withCheckRun': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withCheckRun(value): { on+: { check_run: value } }, - '#withCheckRunMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withCheckRunMixin(value): { on+: { check_run+: value } }, - '#withCheckSuite': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withCheckSuite(value): { on+: { check_suite: value } }, - '#withCheckSuiteMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withCheckSuiteMixin(value): { on+: { check_suite+: value } }, - '#withCreate': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withCreate(value): { on+: { create: value } }, - '#withCreateMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withCreateMixin(value): { on+: { create+: value } }, - '#withDelete': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withDelete(value): { on+: { delete: value } }, - '#withDeleteMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withDeleteMixin(value): { on+: { delete+: value } }, - '#withDeployment': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withDeployment(value): { on+: { deployment: value } }, - '#withDeploymentMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withDeploymentMixin(value): { on+: { deployment+: value } }, - '#withDeploymentStatus': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withDeploymentStatus(value): { on+: { deployment_status: value } }, - '#withDeploymentStatusMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withDeploymentStatusMixin(value): { on+: { deployment_status+: value } }, - '#withDiscussion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withDiscussion(value): { on+: { discussion: value } }, - '#withDiscussionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withDiscussionMixin(value): { on+: { discussion+: value } }, - '#withDiscussionComment': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withDiscussionComment(value): { on+: { discussion_comment: value } }, - '#withDiscussionCommentMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withDiscussionCommentMixin(value): { on+: { discussion_comment+: value } }, - '#withFork': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withFork(value): { on+: { fork: value } }, - '#withForkMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withForkMixin(value): { on+: { fork+: value } }, - '#withGollum': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withGollum(value): { on+: { gollum: value } }, - '#withGollumMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withGollumMixin(value): { on+: { gollum+: value } }, - '#withIssueComment': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withIssueComment(value): { on+: { issue_comment: value } }, - '#withIssueCommentMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withIssueCommentMixin(value): { on+: { issue_comment+: value } }, - '#withIssues': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withIssues(value): { on+: { issues: value } }, - '#withIssuesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withIssuesMixin(value): { on+: { issues+: value } }, - '#withLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withLabel(value): { on+: { label: value } }, - '#withLabelMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withLabelMixin(value): { on+: { label+: value } }, - '#withMember': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withMember(value): { on+: { member: value } }, - '#withMemberMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withMemberMixin(value): { on+: { member+: value } }, - '#withMergeGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withMergeGroup(value): { on+: { merge_group: value } }, - '#withMergeGroupMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withMergeGroupMixin(value): { on+: { merge_group+: value } }, - '#withMilestone': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withMilestone(value): { on+: { milestone: value } }, - '#withMilestoneMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withMilestoneMixin(value): { on+: { milestone+: value } }, - '#withPageBuild': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withPageBuild(value): { on+: { page_build: value } }, - '#withPageBuildMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withPageBuildMixin(value): { on+: { page_build+: value } }, - '#withProject': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withProject(value): { on+: { project: value } }, - '#withProjectMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withProjectMixin(value): { on+: { project+: value } }, - '#withProjectCard': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withProjectCard(value): { on+: { project_card: value } }, - '#withProjectCardMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withProjectCardMixin(value): { on+: { project_card+: value } }, - '#withProjectColumn': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withProjectColumn(value): { on+: { project_column: value } }, - '#withProjectColumnMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withProjectColumnMixin(value): { on+: { project_column+: value } }, - '#withPublic': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withPublic(value): { on+: { public: value } }, - '#withPublicMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withPublicMixin(value): { on+: { public+: value } }, - '#withPullRequest': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withPullRequest(value): { on+: { pull_request: value } }, - '#withPullRequestMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withPullRequestMixin(value): { on+: { pull_request+: value } }, - '#withPullRequestReview': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withPullRequestReview(value): { on+: { pull_request_review: value } }, - '#withPullRequestReviewMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withPullRequestReviewMixin(value): { on+: { pull_request_review+: value } }, - '#withPullRequestReviewComment': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withPullRequestReviewComment(value): { on+: { pull_request_review_comment: value } }, - '#withPullRequestReviewCommentMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withPullRequestReviewCommentMixin(value): { on+: { pull_request_review_comment+: value } }, - '#withPullRequestTarget': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withPullRequestTarget(value): { on+: { pull_request_target: value } }, - '#withPullRequestTargetMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withPullRequestTargetMixin(value): { on+: { pull_request_target+: value } }, - '#withPush': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withPush(value): { on+: { push: value } }, - '#withPushMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withPushMixin(value): { on+: { push+: value } }, - '#withRegistryPackage': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withRegistryPackage(value): { on+: { registry_package: value } }, - '#withRegistryPackageMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withRegistryPackageMixin(value): { on+: { registry_package+: value } }, - '#withRelease': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withRelease(value): { on+: { release: value } }, - '#withReleaseMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withReleaseMixin(value): { on+: { release+: value } }, - '#withRepositoryDispatch': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withRepositoryDispatch(value): { on+: { repository_dispatch: value } }, - '#withRepositoryDispatchMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withRepositoryDispatchMixin(value): { on+: { repository_dispatch+: value } }, - '#withSchedule': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'array' }], help: '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.\nNote: GitHub Actions does not support the non-standard syntax @yearly, @monthly, @weekly, @daily, @hourly, and @reboot.\nYou 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).' } }, - withSchedule(value): { on+: { schedule: (if std.isArray(value) - then value - else [value]) } }, - '#withScheduleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'array' }], help: '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.\nNote: GitHub Actions does not support the non-standard syntax @yearly, @monthly, @weekly, @daily, @hourly, and @reboot.\nYou 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).' } }, - withScheduleMixin(value): { on+: { schedule+: (if std.isArray(value) - then value - else [value]) } }, - '#withStatus': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withStatus(value): { on+: { status: value } }, - '#withStatusMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withStatusMixin(value): { on+: { status+: value } }, - '#withWatch': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withWatch(value): { on+: { watch: value } }, - '#withWatchMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withWatchMixin(value): { on+: { watch+: value } }, - '#withWorkflowCall': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: 'Allows workflows to be reused by other workflows.' } }, - withWorkflowCall(value): { on+: { workflow_call: value } }, - '#withWorkflowDispatch': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: "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." } }, - withWorkflowDispatch(value): { on+: { workflow_dispatch: value } }, - '#withWorkflowRun': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withWorkflowRun(value): { on+: { workflow_run: value } }, - '#withWorkflowRunMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withWorkflowRunMixin(value): { on+: { workflow_run+: value } }, - }, - '#withPermissions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: '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.' } }, - withPermissions(value): { permissions: value }, - '#withPermissionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: '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.' } }, - withPermissionsMixin(value): { permissions+: value }, - permissions+: - { - '#withPermissionsEvent': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withPermissionsEvent(value): { permissions+: { 'permissions-event': value } }, - '#withPermissionsEventMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'object' }], help: '' } }, - withPermissionsEventMixin(value): { permissions+: { 'permissions-event'+: value } }, - 'permissions-event'+: - { - '#withActions': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: 'string' }], help: '' } }, - withActions(value): { permissions+: { actions: value } }, - '#withChecks': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: 'string' }], help: '' } }, - withChecks(value): { permissions+: { checks: value } }, - '#withContents': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: 'string' }], help: '' } }, - withContents(value): { permissions+: { contents: value } }, - '#withDeployments': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: 'string' }], help: '' } }, - withDeployments(value): { permissions+: { deployments: value } }, - '#withDiscussions': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: 'string' }], help: '' } }, - withDiscussions(value): { permissions+: { discussions: value } }, - '#withIdToken': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: 'string' }], help: '' } }, - withIdToken(value): { permissions+: { 'id-token': value } }, - '#withIssues': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: 'string' }], help: '' } }, - withIssues(value): { permissions+: { issues: value } }, - '#withPackages': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: 'string' }], help: '' } }, - withPackages(value): { permissions+: { packages: value } }, - '#withPages': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: 'string' }], help: '' } }, - withPages(value): { permissions+: { pages: value } }, - '#withPullRequests': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: 'string' }], help: '' } }, - withPullRequests(value): { permissions+: { 'pull-requests': value } }, - '#withRepositoryProjects': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: 'string' }], help: '' } }, - withRepositoryProjects(value): { permissions+: { 'repository-projects': value } }, - '#withSecurityEvents': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: 'string' }], help: '' } }, - withSecurityEvents(value): { permissions+: { 'security-events': value } }, - '#withStatuses': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: 'string' }], help: '' } }, - withStatuses(value): { permissions+: { statuses: value } }, - }, - }, - '#withRunName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: 'string' }], help: "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." } }, - withRunName(value): { 'run-name': value }, -} diff --git a/generator/generate.jsonnet b/generator/generate.jsonnet new file mode 100644 index 0000000..f743fd1 --- /dev/null +++ b/generator/generate.jsonnet @@ -0,0 +1,97 @@ +local a = import 'github.com/crdsonnet/astsonnet/main.libsonnet'; +local autils = import 'github.com/crdsonnet/astsonnet/utils.libsonnet'; +local helpers = import 'github.com/crdsonnet/crdsonnet/crdsonnet/helpers.libsonnet'; +local crdsonnet = import 'github.com/crdsonnet/crdsonnet/crdsonnet/main.libsonnet'; +local astRenderEngine = import 'github.com/crdsonnet/crdsonnet/crdsonnet/renderEngines/ast.libsonnet'; +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +local schema = + (import './vendor/github.com/SchemaStore/schemastore/src/schemas/json/github-workflow.json') + + { + properties+: { + concurrency+: { + oneOf: [ + super.oneOf[0], + // reduce level + schema.definitions.concurrency, + ], + }, + }, + definitions+: { + // CRDsonnet fix: remove oneOf validation as not relevant to the generation process + ref: std.mergePatch(super.ref, { type: 'object', oneOf: null }), + // CRDsonnet fix: always resolve to type:object and not type:null + eventObject: { type: 'object' }, + normalJob+: { + properties+: { + steps+: { + // CRDsonnet fix: remove allOf validation as not relevant to the generation process + items: super.items.allOf[1], + }, + // reduce level without reducing functionality + container+: schema.definitions.container, + concurrency+: { + oneOf: [ + super.oneOf[0], + // reduce level + schema.definitions.concurrency, + ], + }, + }, + }, + permissions+: { + oneOf: [ + super.oneOf[0], + // reduce level + schema.definitions['permissions-event'], + ], + }, + }, + } +; + +local jobschema = + std.mergePatch(schema, { properties: null, required: null }) + + { '$ref': '#/definitions/normalJob' }; + +local processor = crdsonnet.processor.new('ast'); + +local asts = [ + crdsonnet.schema.render('workflow', schema, processor), + crdsonnet.schema.render('job', jobschema, processor), +]; + +local docstring = + a.object.new([ + a.field.new( + a.string.new('#'), + a.literal.new( + std.manifestJsonEx( + d.package.new( + 'github-actions-libsonnet', + 'github.com/crdsonnet/github-actions-libsonnet', + 'Jsonnet library to create GitHub actions workflows.', + 'main.libsonnet', + 'main', + ) + + d.package.withUsageTemplate( + std.strReplace( + importstr '../example.jsonnet', + './main.libsonnet', + '%(import)s', + ) + ) + , ' ', '\n' + ), + ), + ), + ]); + +'// DO NOT EDIT: generated by generator/generate.jsonnet\n' ++ "{ workflow+: { '#': { help: '', name: 'workflow' } } }\n+ " ++ "{ job+: { '#': { help: '', name: 'job' } } }\n+ " ++ ( + autils.deepMergeObjects([docstring] + asts) +).toString() + +//processor.parse('workflow', schema) diff --git a/generator/jsonnetfile.json b/generator/jsonnetfile.json new file mode 100644 index 0000000..7ccd323 --- /dev/null +++ b/generator/jsonnetfile.json @@ -0,0 +1,24 @@ +{ + "version": 1, + "dependencies": [ + { + "source": { + "git": { + "remote": "https://github.com/SchemaStore/schemastore.git", + "subdir": "src/schemas/json/" + } + }, + "version": "master" + }, + { + "source": { + "git": { + "remote": "https://github.com/crdsonnet/crdsonnet.git", + "subdir": "crdsonnet" + } + }, + "version": "master" + } + ], + "legacyImports": true +} diff --git a/generator/jsonnetfile.lock.json b/generator/jsonnetfile.lock.json new file mode 100644 index 0000000..2f9772c --- /dev/null +++ b/generator/jsonnetfile.lock.json @@ -0,0 +1,66 @@ +{ + "version": 1, + "dependencies": [ + { + "source": { + "git": { + "remote": "https://github.com/SchemaStore/schemastore.git", + "subdir": "src/schemas/json/" + } + }, + "version": "45cb738f378d32f0583bf33056113def561b1d3f", + "sum": "RJgIzK04JSPOcUFQECSHxdNG20MpF2UBSFCv/5ENPH0=" + }, + { + "source": { + "git": { + "remote": "https://github.com/crdsonnet/astsonnet.git", + "subdir": "" + } + }, + "version": "a771663cb9594cd10b30815933fe55554e6a3755", + "sum": "k/SJ+F+jjdg+dBMKczPEjcYCEuQ6v0BROdXKdXOCi9o=" + }, + { + "source": { + "git": { + "remote": "https://github.com/crdsonnet/crdsonnet.git", + "subdir": "crdsonnet" + } + }, + "version": "754295aa2ffb82811e262914cbf4eb3aa898dead", + "sum": "DlyHtXBQmiM2QBwyun8E/fQg4PzuqxQPkm30/7LsobA=" + }, + { + "source": { + "git": { + "remote": "https://github.com/crdsonnet/validate-libsonnet.git", + "subdir": "" + } + }, + "version": "a78ca15fbfece3110c4807d1f059132ece01d97b", + "sum": "qYLH56MqvmgxE4YMNeTbuJ1XSsCpl1sumHN5x8IQv2I=" + }, + { + "source": { + "git": { + "remote": "https://github.com/jsonnet-libs/docsonnet.git", + "subdir": "doc-util" + } + }, + "version": "6ac6c69685b8c29c54515448eaca583da2d88150", + "sum": "BrAL/k23jq+xy9oA7TWIhUx07dsA/QLm3g7ktCwe//U=" + }, + { + "source": { + "git": { + "remote": "https://github.com/jsonnet-libs/xtd.git", + "subdir": "" + } + }, + "version": "63d430b69a95741061c2f7fc9d84b1a778511d9c", + "sum": "qiZi3axUSXCVzKUF83zSAxklwrnitMmrDK4XAfjPMdE=" + } + ], + "legacyImports": false +} diff --git a/jsonnetfile.json b/jsonnetfile.json index 7ccd323..906ecf3 100644 --- a/jsonnetfile.json +++ b/jsonnetfile.json @@ -1,24 +1,5 @@ { "version": 1, - "dependencies": [ - { - "source": { - "git": { - "remote": "https://github.com/SchemaStore/schemastore.git", - "subdir": "src/schemas/json/" - } - }, - "version": "master" - }, - { - "source": { - "git": { - "remote": "https://github.com/crdsonnet/crdsonnet.git", - "subdir": "crdsonnet" - } - }, - "version": "master" - } - ], + "dependencies": [ ], "legacyImports": true } diff --git a/main.libsonnet b/main.libsonnet index 420327b..dfa82aa 100644 --- a/main.libsonnet +++ b/main.libsonnet @@ -1,29 +1,7 @@ -// static.libsonnet -local refactor = import './refactor.libsonnet'; -local jutils = import 'github.com/Duologic/jsonnet-libsonnet/utils.libsonnet'; -local schema = import 'github.com/SchemaStore/schemastore/src/schemas/json/github-workflow.json'; -local crdsonnet = import 'github.com/crdsonnet/crdsonnet/crdsonnet/main.libsonnet'; -local processor = refactor.ASTProcessor; - - -local unwrapFromCRDsonnet(astObject, title) = - jutils.get( - astObject, - title, - default=error 'field %s not found in ast' % title - ).expr; - - -{ - 'workflow.libsonnet': unwrapFromCRDsonnet(crdsonnet.schema.render('workflow', schema, processor), 'workflow').toString(break='\n'), - local jobSchema = schema.definitions.normalJob - { properties+: { - steps+: { - items+: { - allOf: std.slice(super.allOf, 1, std.length(super.allOf), 1), - }, - }, - } }, - 'normalJob.libsonnet': unwrapFromCRDsonnet(crdsonnet.schema.render('normalJob', jobSchema, processor), 'normalJob').toString(break='\n'), - 'reusableWorkflowCallJob.libsonnet': unwrapFromCRDsonnet(crdsonnet.schema.render('reusableWorkflowCallJob', schema.definitions.reusableWorkflowCallJob, processor), 'reusableWorkflowCallJob').toString(break='\n'), +(import './raw.libsonnet') ++ { + job+: { + steps:: {}, + step: (super.steps + { '#'+: { name: 'step' } }), + }, } diff --git a/raw.libsonnet b/raw.libsonnet new file mode 100644 index 0000000..0836e43 --- /dev/null +++ b/raw.libsonnet @@ -0,0 +1,2333 @@ +// DO NOT EDIT: generated by generator/generate.jsonnet +{ workflow+: { '#': { help: '', name: 'workflow' } } } ++ { job+: { '#': { help: '', name: 'job' } } } ++ { + '#': { + filename: 'main.libsonnet', + help: "Jsonnet library to create GitHub actions workflows.\n## Install\n\n```\njb install github.com/crdsonnet/github-actions-libsonnet@main\n```\n\n## Usage\n\n```jsonnet\nlocal ga = import 'github.com/crdsonnet/github-actions-libsonnet/main.libsonnet';\n\nlocal exampleWorkflow =\n ga.workflow.withName('example workflow')\n + ga.workflow.on.pull_request.withBranches(['main'])\n + ga.workflow.withJobs({\n example:\n ga.job.withRunsOn('ubuntu-latest')\n + ga.job.withSteps(\n ga.job.step.withName('Checkout')\n + ga.job.step.withUses('actions/checkout@v4')\n ),\n });\n\nstd.manifestYamlDoc(exampleWorkflow, indent_array_in_object=true, quote_keys=false)\n\n```\n", + 'import': 'github.com/crdsonnet/github-actions-libsonnet/main.libsonnet', + installTemplate: '\n## Install\n\n```\njb install %(url)s@%(version)s\n```\n', + name: 'github-actions-libsonnet', + url: 'github.com/crdsonnet/github-actions-libsonnet', + usageTemplate: "\n## Usage\n\n```jsonnet\nlocal ga = import '%(import)s';\n\nlocal exampleWorkflow =\n ga.workflow.withName('example workflow')\n + ga.workflow.on.pull_request.withBranches(['main'])\n + ga.workflow.withJobs({\n example:\n ga.job.withRunsOn('ubuntu-latest')\n + ga.job.withSteps(\n ga.job.step.withName('Checkout')\n + ga.job.step.withUses('actions/checkout@v4')\n ),\n });\n\nstd.manifestYamlDoc(exampleWorkflow, indent_array_in_object=true, quote_keys=false)\n\n```\n", + version: 'main', + }, + workflow+: + { + '#withConcurrency': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '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. \nYou can also specify concurrency at the workflow level. \nWhen 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.' } }, + withConcurrency(value): { + concurrency: value, + }, + '#withConcurrencyMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '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. \nYou can also specify concurrency at the workflow level. \nWhen 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.' } }, + withConcurrencyMixin(value): { + concurrency+: value, + }, + concurrency+: + { + '#withCancelInProgress': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'string'] }], help: 'To cancel any currently running job or workflow in the same concurrency group, specify cancel-in-progress: true.' } }, + withCancelInProgress(value): { + concurrency+: { + 'cancel-in-progress': value, + }, + }, + '#withCancelInProgressMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'string'] }], help: 'To cancel any currently running job or workflow in the same concurrency group, specify cancel-in-progress: true.' } }, + withCancelInProgressMixin(value): { + concurrency+: { + 'cancel-in-progress'+: value, + }, + }, + 'cancel-in-progress'+: + { + '#withExpressionSyntax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withExpressionSyntax(value): { + concurrency+: { + 'cancel-in-progress'+: { + expressionSyntax: value, + }, + }, + }, + }, + '#withGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '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.' } }, + withGroup(value): { + concurrency+: { + group: value, + }, + }, + }, + '#withDefaults': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'A map of default settings that will apply to all jobs in the workflow.' } }, + withDefaults(value): { + defaults: value, + }, + '#withDefaultsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'A map of default settings that will apply to all jobs in the workflow.' } }, + withDefaultsMixin(value): { + defaults+: value, + }, + defaults+: + { + '#withRun': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withRun(value): { + defaults+: { + run: value, + }, + }, + '#withRunMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withRunMixin(value): { + defaults+: { + run+: value, + }, + }, + run+: + { + '#withShell': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'string'] }], help: "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." } }, + withShell(value): { + defaults+: { + run+: { + shell: value, + }, + }, + }, + '#withShellMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'string'] }], help: "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." } }, + withShellMixin(value): { + defaults+: { + run+: { + shell+: value, + }, + }, + }, + '#withWorkingDirectory': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Using the working-directory keyword, you can specify the working directory of where to run the command.' } }, + withWorkingDirectory(value): { + defaults+: { + run+: { + 'working-directory': value, + }, + }, + }, + }, + }, + '#withEnv': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object', 'string'] }], help: '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..steps[*].env, jobs..env, and env keywords. For more information, see https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsenv' } }, + withEnv(value): { + env: value, + }, + '#withEnvMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object', 'string'] }], help: '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..steps[*].env, jobs..env, and env keywords. For more information, see https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsenv' } }, + withEnvMixin(value): { + env+: value, + }, + env+: + { + '#withStringContainingExpressionSyntax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withStringContainingExpressionSyntax(value): { + env+: { + stringContainingExpressionSyntax: value, + }, + }, + }, + '#withJobs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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..needs keyword.\nEach job runs in a fresh instance of the virtual environment specified by runs-on.\nYou 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.' } }, + withJobs(value): { + jobs: value, + }, + '#withJobsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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..needs keyword.\nEach job runs in a fresh instance of the virtual environment specified by runs-on.\nYou 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.' } }, + withJobsMixin(value): { + jobs+: value, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "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." } }, + withName(value): { + name: value, + }, + '#withOn': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array', 'object'] }], help: '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.' } }, + withOn(value): { + on: value, + }, + '#withOnMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array', 'object'] }], help: '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.' } }, + withOnMixin(value): { + on+: value, + }, + on+: + { + '#withEvent': { 'function': { args: [{ default: null, enums: ['branch_protection_rule', 'check_run', 'check_suite', 'create', 'delete', 'deployment', 'deployment_status', 'discussion', 'discussion_comment', 'fork', 'gollum', 'issue_comment', 'issues', 'label', 'merge_group', 'milestone', 'page_build', 'project', 'project_card', 'project_column', 'public', 'pull_request', 'pull_request_review', 'pull_request_review_comment', 'pull_request_target', 'push', 'registry_package', 'release', 'status', 'watch', 'workflow_call', 'workflow_dispatch', 'workflow_run', 'repository_dispatch'], name: 'value', type: ['string'] }], help: '' } }, + withEvent(value): { + on+: { + event: value, + }, + }, + '#withBranchProtectionRule': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Runs your workflow anytime the branch_protection_rule event occurs. More than one activity type triggers this event.' } }, + withBranchProtectionRule(value): { + on+: { + branch_protection_rule: value, + }, + }, + '#withBranchProtectionRuleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Runs your workflow anytime the branch_protection_rule event occurs. More than one activity type triggers this event.' } }, + withBranchProtectionRuleMixin(value): { + on+: { + branch_protection_rule+: value, + }, + }, + branch_protection_rule+: + { + '#withTypes': { 'function': { args: [{ default: ['created', 'edited', 'deleted'], enums: null, name: 'value', type: ['array'] }], help: '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.\nYou 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.' } }, + withTypes(value): { + on+: { + branch_protection_rule+: { + types: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withTypesMixin': { 'function': { args: [{ default: ['created', 'edited', 'deleted'], enums: null, name: 'value', type: ['array'] }], help: '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.\nYou 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.' } }, + withTypesMixin(value): { + on+: { + branch_protection_rule+: { + types+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + '#withCheckRun': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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.' } }, + withCheckRun(value): { + on+: { + check_run: value, + }, + }, + '#withCheckRunMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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.' } }, + withCheckRunMixin(value): { + on+: { + check_run+: value, + }, + }, + check_run+: + { + '#withTypes': { 'function': { args: [{ default: ['created', 'rerequested', 'completed', 'requested_action'], enums: null, name: 'value', type: ['array'] }], help: '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.\nYou 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.' } }, + withTypes(value): { + on+: { + check_run+: { + types: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withTypesMixin': { 'function': { args: [{ default: ['created', 'rerequested', 'completed', 'requested_action'], enums: null, name: 'value', type: ['array'] }], help: '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.\nYou 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.' } }, + withTypesMixin(value): { + on+: { + check_run+: { + types+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + '#withCheckSuite': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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/.' } }, + withCheckSuite(value): { + on+: { + check_suite: value, + }, + }, + '#withCheckSuiteMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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/.' } }, + withCheckSuiteMixin(value): { + on+: { + check_suite+: value, + }, + }, + check_suite+: + { + '#withTypes': { 'function': { args: [{ default: ['completed', 'requested', 'rerequested'], enums: null, name: 'value', type: ['array'] }], help: '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.\nYou 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.' } }, + withTypes(value): { + on+: { + check_suite+: { + types: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withTypesMixin': { 'function': { args: [{ default: ['completed', 'requested', 'rerequested'], enums: null, name: 'value', type: ['array'] }], help: '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.\nYou 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.' } }, + withTypesMixin(value): { + on+: { + check_suite+: { + types+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + '#withCreate': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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.' } }, + withCreate(value): { + on+: { + create: value, + }, + }, + '#withCreateMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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.' } }, + withCreateMixin(value): { + on+: { + create+: value, + }, + }, + '#withDelete': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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.' } }, + withDelete(value): { + on+: { + delete: value, + }, + }, + '#withDeleteMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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.' } }, + withDeleteMixin(value): { + on+: { + delete+: value, + }, + }, + '#withDeployment': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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/.' } }, + withDeployment(value): { + on+: { + deployment: value, + }, + }, + '#withDeploymentMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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/.' } }, + withDeploymentMixin(value): { + on+: { + deployment+: value, + }, + }, + '#withDeploymentStatus': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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.' } }, + withDeploymentStatus(value): { + on+: { + deployment_status: value, + }, + }, + '#withDeploymentStatusMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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.' } }, + withDeploymentStatusMixin(value): { + on+: { + deployment_status+: value, + }, + }, + '#withDiscussion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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' } }, + withDiscussion(value): { + on+: { + discussion: value, + }, + }, + '#withDiscussionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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' } }, + withDiscussionMixin(value): { + on+: { + discussion+: value, + }, + }, + discussion+: + { + '#withTypes': { 'function': { args: [{ default: ['created', 'edited', 'deleted', 'transferred', 'pinned', 'unpinned', 'labeled', 'unlabeled', 'locked', 'unlocked', 'category_changed', 'answered', 'unanswered'], enums: null, name: 'value', type: ['array'] }], help: '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.\nYou 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.' } }, + withTypes(value): { + on+: { + discussion+: { + types: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withTypesMixin': { 'function': { args: [{ default: ['created', 'edited', 'deleted', 'transferred', 'pinned', 'unpinned', 'labeled', 'unlabeled', 'locked', 'unlocked', 'category_changed', 'answered', 'unanswered'], enums: null, name: 'value', type: ['array'] }], help: '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.\nYou 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.' } }, + withTypesMixin(value): { + on+: { + discussion+: { + types+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + '#withDiscussionComment': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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' } }, + withDiscussionComment(value): { + on+: { + discussion_comment: value, + }, + }, + '#withDiscussionCommentMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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' } }, + withDiscussionCommentMixin(value): { + on+: { + discussion_comment+: value, + }, + }, + discussion_comment+: + { + '#withTypes': { 'function': { args: [{ default: ['created', 'edited', 'deleted'], enums: null, name: 'value', type: ['array'] }], help: '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.\nYou 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.' } }, + withTypes(value): { + on+: { + discussion_comment+: { + types: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withTypesMixin': { 'function': { args: [{ default: ['created', 'edited', 'deleted'], enums: null, name: 'value', type: ['array'] }], help: '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.\nYou 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.' } }, + withTypesMixin(value): { + on+: { + discussion_comment+: { + types+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + '#withFork': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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.' } }, + withFork(value): { + on+: { + fork: value, + }, + }, + '#withForkMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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.' } }, + withForkMixin(value): { + on+: { + fork+: value, + }, + }, + '#withGollum': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Runs your workflow when someone creates or updates a Wiki page, which triggers the gollum event.' } }, + withGollum(value): { + on+: { + gollum: value, + }, + }, + '#withGollumMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Runs your workflow when someone creates or updates a Wiki page, which triggers the gollum event.' } }, + withGollumMixin(value): { + on+: { + gollum+: value, + }, + }, + '#withIssueComment': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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/.' } }, + withIssueComment(value): { + on+: { + issue_comment: value, + }, + }, + '#withIssueCommentMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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/.' } }, + withIssueCommentMixin(value): { + on+: { + issue_comment+: value, + }, + }, + issue_comment+: + { + '#withTypes': { 'function': { args: [{ default: ['created', 'edited', 'deleted'], enums: null, name: 'value', type: ['array'] }], help: '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.\nYou 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.' } }, + withTypes(value): { + on+: { + issue_comment+: { + types: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withTypesMixin': { 'function': { args: [{ default: ['created', 'edited', 'deleted'], enums: null, name: 'value', type: ['array'] }], help: '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.\nYou 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.' } }, + withTypesMixin(value): { + on+: { + issue_comment+: { + types+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + '#withIssues': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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.' } }, + withIssues(value): { + on+: { + issues: value, + }, + }, + '#withIssuesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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.' } }, + withIssuesMixin(value): { + on+: { + issues+: value, + }, + }, + issues+: + { + '#withTypes': { 'function': { args: [{ default: ['opened', 'edited', 'deleted', 'transferred', 'pinned', 'unpinned', 'closed', 'reopened', 'assigned', 'unassigned', 'labeled', 'unlabeled', 'locked', 'unlocked', 'milestoned', 'demilestoned'], enums: null, name: 'value', type: ['array'] }], help: '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.\nYou 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.' } }, + withTypes(value): { + on+: { + issues+: { + types: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withTypesMixin': { 'function': { args: [{ default: ['opened', 'edited', 'deleted', 'transferred', 'pinned', 'unpinned', 'closed', 'reopened', 'assigned', 'unassigned', 'labeled', 'unlabeled', 'locked', 'unlocked', 'milestoned', 'demilestoned'], enums: null, name: 'value', type: ['array'] }], help: '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.\nYou 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.' } }, + withTypesMixin(value): { + on+: { + issues+: { + types+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + '#withLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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/.' } }, + withLabel(value): { + on+: { + label: value, + }, + }, + '#withLabelMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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/.' } }, + withLabelMixin(value): { + on+: { + label+: value, + }, + }, + label+: + { + '#withTypes': { 'function': { args: [{ default: ['created', 'edited', 'deleted'], enums: null, name: 'value', type: ['array'] }], help: '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.\nYou 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.' } }, + withTypes(value): { + on+: { + label+: { + types: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withTypesMixin': { 'function': { args: [{ default: ['created', 'edited', 'deleted'], enums: null, name: 'value', type: ['array'] }], help: '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.\nYou 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.' } }, + withTypesMixin(value): { + on+: { + label+: { + types+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + '#withMergeGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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 .' } }, + withMergeGroup(value): { + on+: { + merge_group: value, + }, + }, + '#withMergeGroupMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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 .' } }, + withMergeGroupMixin(value): { + on+: { + merge_group+: value, + }, + }, + merge_group+: + { + '#withTypes': { 'function': { args: [{ default: ['checks_requested'], enums: null, name: 'value', type: ['array'] }], help: '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.\nYou 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.' } }, + withTypes(value): { + on+: { + merge_group+: { + types: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withTypesMixin': { 'function': { args: [{ default: ['checks_requested'], enums: null, name: 'value', type: ['array'] }], help: '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.\nYou 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.' } }, + withTypesMixin(value): { + on+: { + merge_group+: { + types+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + '#withMilestone': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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/.' } }, + withMilestone(value): { + on+: { + milestone: value, + }, + }, + '#withMilestoneMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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/.' } }, + withMilestoneMixin(value): { + on+: { + milestone+: value, + }, + }, + milestone+: + { + '#withTypes': { 'function': { args: [{ default: ['created', 'closed', 'opened', 'edited', 'deleted'], enums: null, name: 'value', type: ['array'] }], help: '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.\nYou 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.' } }, + withTypes(value): { + on+: { + milestone+: { + types: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withTypesMixin': { 'function': { args: [{ default: ['created', 'closed', 'opened', 'edited', 'deleted'], enums: null, name: 'value', type: ['array'] }], help: '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.\nYou 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.' } }, + withTypesMixin(value): { + on+: { + milestone+: { + types+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + '#withPageBuild': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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/.' } }, + withPageBuild(value): { + on+: { + page_build: value, + }, + }, + '#withPageBuildMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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/.' } }, + withPageBuildMixin(value): { + on+: { + page_build+: value, + }, + }, + '#withProject': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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/.' } }, + withProject(value): { + on+: { + project: value, + }, + }, + '#withProjectMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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/.' } }, + withProjectMixin(value): { + on+: { + project+: value, + }, + }, + project+: + { + '#withTypes': { 'function': { args: [{ default: ['created', 'updated', 'closed', 'reopened', 'edited', 'deleted'], enums: null, name: 'value', type: ['array'] }], help: '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.\nYou 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.' } }, + withTypes(value): { + on+: { + project+: { + types: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withTypesMixin': { 'function': { args: [{ default: ['created', 'updated', 'closed', 'reopened', 'edited', 'deleted'], enums: null, name: 'value', type: ['array'] }], help: '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.\nYou 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.' } }, + withTypesMixin(value): { + on+: { + project+: { + types+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + '#withProjectCard': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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.' } }, + withProjectCard(value): { + on+: { + project_card: value, + }, + }, + '#withProjectCardMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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.' } }, + withProjectCardMixin(value): { + on+: { + project_card+: value, + }, + }, + project_card+: + { + '#withTypes': { 'function': { args: [{ default: ['created', 'moved', 'converted', 'edited', 'deleted'], enums: null, name: 'value', type: ['array'] }], help: '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.\nYou 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.' } }, + withTypes(value): { + on+: { + project_card+: { + types: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withTypesMixin': { 'function': { args: [{ default: ['created', 'moved', 'converted', 'edited', 'deleted'], enums: null, name: 'value', type: ['array'] }], help: '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.\nYou 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.' } }, + withTypesMixin(value): { + on+: { + project_card+: { + types+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + '#withProjectColumn': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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.' } }, + withProjectColumn(value): { + on+: { + project_column: value, + }, + }, + '#withProjectColumnMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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.' } }, + withProjectColumnMixin(value): { + on+: { + project_column+: value, + }, + }, + project_column+: + { + '#withTypes': { 'function': { args: [{ default: ['created', 'updated', 'moved', 'deleted'], enums: null, name: 'value', type: ['array'] }], help: '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.\nYou 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.' } }, + withTypes(value): { + on+: { + project_column+: { + types: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withTypesMixin': { 'function': { args: [{ default: ['created', 'updated', 'moved', 'deleted'], enums: null, name: 'value', type: ['array'] }], help: '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.\nYou 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.' } }, + withTypesMixin(value): { + on+: { + project_column+: { + types+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + '#withPublic': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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.' } }, + withPublic(value): { + on+: { + public: value, + }, + }, + '#withPublicMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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.' } }, + withPublicMixin(value): { + on+: { + public+: value, + }, + }, + '#withPullRequest': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "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.\nNote: Workflows do not run on private base repositories when you open a pull request from a forked repository.\nWhen 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.\nWorkflows don't run on forked repositories by default. You must enable GitHub Actions in the Actions tab of the forked repository.\nThe 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." } }, + withPullRequest(value): { + on+: { + pull_request: value, + }, + }, + '#withPullRequestMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "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.\nNote: Workflows do not run on private base repositories when you open a pull request from a forked repository.\nWhen 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.\nWorkflows don't run on forked repositories by default. You must enable GitHub Actions in the Actions tab of the forked repository.\nThe 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." } }, + withPullRequestMixin(value): { + on+: { + pull_request+: value, + }, + }, + pull_request+: + { + '#withBranches': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: "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.\nThe 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.\nThe 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.\nYou can use two types of filters to prevent a workflow from running on pushes and pull requests to tags and branches:\n- 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.\n- 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.\nYou can exclude tags and branches using the ! character. The order that you define patterns matters.\n- A matching negative pattern (prefixed with !) after a positive match will exclude the Git ref.\n- A matching positive pattern after a negative match will include the Git ref again." } }, + withBranches(value): { + on+: { + pull_request+: { + branches: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withBranchesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: "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.\nThe 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.\nThe 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.\nYou can use two types of filters to prevent a workflow from running on pushes and pull requests to tags and branches:\n- 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.\n- 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.\nYou can exclude tags and branches using the ! character. The order that you define patterns matters.\n- A matching negative pattern (prefixed with !) after a positive match will exclude the Git ref.\n- A matching positive pattern after a negative match will include the Git ref again." } }, + withBranchesMixin(value): { + on+: { + pull_request+: { + branches+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withBranchesIgnore': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: "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.\nThe 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.\nThe 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.\nYou can use two types of filters to prevent a workflow from running on pushes and pull requests to tags and branches:\n- 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.\n- 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.\nYou can exclude tags and branches using the ! character. The order that you define patterns matters.\n- A matching negative pattern (prefixed with !) after a positive match will exclude the Git ref.\n- A matching positive pattern after a negative match will include the Git ref again." } }, + withBranchesIgnore(value): { + on+: { + pull_request+: { + 'branches-ignore': + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withBranchesIgnoreMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: "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.\nThe 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.\nThe 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.\nYou can use two types of filters to prevent a workflow from running on pushes and pull requests to tags and branches:\n- 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.\n- 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.\nYou can exclude tags and branches using the ! character. The order that you define patterns matters.\n- A matching negative pattern (prefixed with !) after a positive match will exclude the Git ref.\n- A matching positive pattern after a negative match will include the Git ref again." } }, + withBranchesIgnoreMixin(value): { + on+: { + pull_request+: { + 'branches-ignore'+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withPaths': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '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.\nThe 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.\nYou can exclude paths using two types of filters. You cannot use both of these filters for the same event in a workflow.\n- paths-ignore - Use the paths-ignore filter when you only need to exclude path names.\n- paths - Use the paths filter when you need to filter paths for positive matches and exclude paths.' } }, + withPaths(value): { + on+: { + pull_request+: { + paths: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withPathsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '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.\nThe 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.\nYou can exclude paths using two types of filters. You cannot use both of these filters for the same event in a workflow.\n- paths-ignore - Use the paths-ignore filter when you only need to exclude path names.\n- paths - Use the paths filter when you need to filter paths for positive matches and exclude paths.' } }, + withPathsMixin(value): { + on+: { + pull_request+: { + paths+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withPathsIgnore': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '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.\nThe 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.\nYou can exclude paths using two types of filters. You cannot use both of these filters for the same event in a workflow.\n- paths-ignore - Use the paths-ignore filter when you only need to exclude path names.\n- paths - Use the paths filter when you need to filter paths for positive matches and exclude paths.' } }, + withPathsIgnore(value): { + on+: { + pull_request+: { + 'paths-ignore': + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withPathsIgnoreMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '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.\nThe 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.\nYou can exclude paths using two types of filters. You cannot use both of these filters for the same event in a workflow.\n- paths-ignore - Use the paths-ignore filter when you only need to exclude path names.\n- paths - Use the paths filter when you need to filter paths for positive matches and exclude paths.' } }, + withPathsIgnoreMixin(value): { + on+: { + pull_request+: { + 'paths-ignore'+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withTags': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: "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.\nThe 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.\nThe 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.\nYou can use two types of filters to prevent a workflow from running on pushes and pull requests to tags and branches:\n- 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.\n- 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.\nYou can exclude tags and branches using the ! character. The order that you define patterns matters.\n- A matching negative pattern (prefixed with !) after a positive match will exclude the Git ref.\n- A matching positive pattern after a negative match will include the Git ref again." } }, + withTags(value): { + on+: { + pull_request+: { + tags: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withTagsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: "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.\nThe 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.\nThe 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.\nYou can use two types of filters to prevent a workflow from running on pushes and pull requests to tags and branches:\n- 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.\n- 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.\nYou can exclude tags and branches using the ! character. The order that you define patterns matters.\n- A matching negative pattern (prefixed with !) after a positive match will exclude the Git ref.\n- A matching positive pattern after a negative match will include the Git ref again." } }, + withTagsMixin(value): { + on+: { + pull_request+: { + tags+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withTagsIgnore': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: "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.\nThe 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.\nThe 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.\nYou can use two types of filters to prevent a workflow from running on pushes and pull requests to tags and branches:\n- 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.\n- 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.\nYou can exclude tags and branches using the ! character. The order that you define patterns matters.\n- A matching negative pattern (prefixed with !) after a positive match will exclude the Git ref.\n- A matching positive pattern after a negative match will include the Git ref again." } }, + withTagsIgnore(value): { + on+: { + pull_request+: { + 'tags-ignore': + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withTagsIgnoreMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: "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.\nThe 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.\nThe 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.\nYou can use two types of filters to prevent a workflow from running on pushes and pull requests to tags and branches:\n- 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.\n- 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.\nYou can exclude tags and branches using the ! character. The order that you define patterns matters.\n- A matching negative pattern (prefixed with !) after a positive match will exclude the Git ref.\n- A matching positive pattern after a negative match will include the Git ref again." } }, + withTagsIgnoreMixin(value): { + on+: { + pull_request+: { + 'tags-ignore'+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withTypes': { 'function': { args: [{ default: ['opened', 'synchronize', 'reopened'], enums: null, name: 'value', type: ['array'] }], help: '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.\nYou 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.' } }, + withTypes(value): { + on+: { + pull_request+: { + types: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withTypesMixin': { 'function': { args: [{ default: ['opened', 'synchronize', 'reopened'], enums: null, name: 'value', type: ['array'] }], help: '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.\nYou 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.' } }, + withTypesMixin(value): { + on+: { + pull_request+: { + types+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + '#withPullRequestReview': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "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.\nNote: Workflows do not run on private base repositories when you open a pull request from a forked repository.\nWhen 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.\nWorkflows don't run on forked repositories by default. You must enable GitHub Actions in the Actions tab of the forked repository.\nThe 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." } }, + withPullRequestReview(value): { + on+: { + pull_request_review: value, + }, + }, + '#withPullRequestReviewMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "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.\nNote: Workflows do not run on private base repositories when you open a pull request from a forked repository.\nWhen 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.\nWorkflows don't run on forked repositories by default. You must enable GitHub Actions in the Actions tab of the forked repository.\nThe 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." } }, + withPullRequestReviewMixin(value): { + on+: { + pull_request_review+: value, + }, + }, + pull_request_review+: + { + '#withTypes': { 'function': { args: [{ default: ['submitted', 'edited', 'dismissed'], enums: null, name: 'value', type: ['array'] }], help: '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.\nYou 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.' } }, + withTypes(value): { + on+: { + pull_request_review+: { + types: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withTypesMixin': { 'function': { args: [{ default: ['submitted', 'edited', 'dismissed'], enums: null, name: 'value', type: ['array'] }], help: '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.\nYou 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.' } }, + withTypesMixin(value): { + on+: { + pull_request_review+: { + types+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + '#withPullRequestReviewComment': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "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.\nNote: Workflows do not run on private base repositories when you open a pull request from a forked repository.\nWhen 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.\nWorkflows don't run on forked repositories by default. You must enable GitHub Actions in the Actions tab of the forked repository.\nThe 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." } }, + withPullRequestReviewComment(value): { + on+: { + pull_request_review_comment: value, + }, + }, + '#withPullRequestReviewCommentMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "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.\nNote: Workflows do not run on private base repositories when you open a pull request from a forked repository.\nWhen 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.\nWorkflows don't run on forked repositories by default. You must enable GitHub Actions in the Actions tab of the forked repository.\nThe 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." } }, + withPullRequestReviewCommentMixin(value): { + on+: { + pull_request_review_comment+: value, + }, + }, + pull_request_review_comment+: + { + '#withTypes': { 'function': { args: [{ default: ['created', 'edited', 'deleted'], enums: null, name: 'value', type: ['array'] }], help: '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.\nYou 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.' } }, + withTypes(value): { + on+: { + pull_request_review_comment+: { + types: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withTypesMixin': { 'function': { args: [{ default: ['created', 'edited', 'deleted'], enums: null, name: 'value', type: ['array'] }], help: '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.\nYou 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.' } }, + withTypesMixin(value): { + on+: { + pull_request_review_comment+: { + types+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + '#withPullRequestTarget': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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.' } }, + withPullRequestTarget(value): { + on+: { + pull_request_target: value, + }, + }, + '#withPullRequestTargetMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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.' } }, + withPullRequestTargetMixin(value): { + on+: { + pull_request_target+: value, + }, + }, + pull_request_target+: + { + '#withBranches': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: "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.\nThe 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.\nThe 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.\nYou can use two types of filters to prevent a workflow from running on pushes and pull requests to tags and branches:\n- 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.\n- 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.\nYou can exclude tags and branches using the ! character. The order that you define patterns matters.\n- A matching negative pattern (prefixed with !) after a positive match will exclude the Git ref.\n- A matching positive pattern after a negative match will include the Git ref again." } }, + withBranches(value): { + on+: { + pull_request_target+: { + branches: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withBranchesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: "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.\nThe 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.\nThe 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.\nYou can use two types of filters to prevent a workflow from running on pushes and pull requests to tags and branches:\n- 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.\n- 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.\nYou can exclude tags and branches using the ! character. The order that you define patterns matters.\n- A matching negative pattern (prefixed with !) after a positive match will exclude the Git ref.\n- A matching positive pattern after a negative match will include the Git ref again." } }, + withBranchesMixin(value): { + on+: { + pull_request_target+: { + branches+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withBranchesIgnore': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: "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.\nThe 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.\nThe 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.\nYou can use two types of filters to prevent a workflow from running on pushes and pull requests to tags and branches:\n- 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.\n- 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.\nYou can exclude tags and branches using the ! character. The order that you define patterns matters.\n- A matching negative pattern (prefixed with !) after a positive match will exclude the Git ref.\n- A matching positive pattern after a negative match will include the Git ref again." } }, + withBranchesIgnore(value): { + on+: { + pull_request_target+: { + 'branches-ignore': + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withBranchesIgnoreMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: "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.\nThe 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.\nThe 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.\nYou can use two types of filters to prevent a workflow from running on pushes and pull requests to tags and branches:\n- 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.\n- 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.\nYou can exclude tags and branches using the ! character. The order that you define patterns matters.\n- A matching negative pattern (prefixed with !) after a positive match will exclude the Git ref.\n- A matching positive pattern after a negative match will include the Git ref again." } }, + withBranchesIgnoreMixin(value): { + on+: { + pull_request_target+: { + 'branches-ignore'+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withPaths': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '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.\nThe 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.\nYou can exclude paths using two types of filters. You cannot use both of these filters for the same event in a workflow.\n- paths-ignore - Use the paths-ignore filter when you only need to exclude path names.\n- paths - Use the paths filter when you need to filter paths for positive matches and exclude paths.' } }, + withPaths(value): { + on+: { + pull_request_target+: { + paths: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withPathsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '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.\nThe 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.\nYou can exclude paths using two types of filters. You cannot use both of these filters for the same event in a workflow.\n- paths-ignore - Use the paths-ignore filter when you only need to exclude path names.\n- paths - Use the paths filter when you need to filter paths for positive matches and exclude paths.' } }, + withPathsMixin(value): { + on+: { + pull_request_target+: { + paths+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withPathsIgnore': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '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.\nThe 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.\nYou can exclude paths using two types of filters. You cannot use both of these filters for the same event in a workflow.\n- paths-ignore - Use the paths-ignore filter when you only need to exclude path names.\n- paths - Use the paths filter when you need to filter paths for positive matches and exclude paths.' } }, + withPathsIgnore(value): { + on+: { + pull_request_target+: { + 'paths-ignore': + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withPathsIgnoreMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '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.\nThe 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.\nYou can exclude paths using two types of filters. You cannot use both of these filters for the same event in a workflow.\n- paths-ignore - Use the paths-ignore filter when you only need to exclude path names.\n- paths - Use the paths filter when you need to filter paths for positive matches and exclude paths.' } }, + withPathsIgnoreMixin(value): { + on+: { + pull_request_target+: { + 'paths-ignore'+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withTags': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: "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.\nThe 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.\nThe 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.\nYou can use two types of filters to prevent a workflow from running on pushes and pull requests to tags and branches:\n- 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.\n- 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.\nYou can exclude tags and branches using the ! character. The order that you define patterns matters.\n- A matching negative pattern (prefixed with !) after a positive match will exclude the Git ref.\n- A matching positive pattern after a negative match will include the Git ref again." } }, + withTags(value): { + on+: { + pull_request_target+: { + tags: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withTagsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: "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.\nThe 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.\nThe 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.\nYou can use two types of filters to prevent a workflow from running on pushes and pull requests to tags and branches:\n- 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.\n- 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.\nYou can exclude tags and branches using the ! character. The order that you define patterns matters.\n- A matching negative pattern (prefixed with !) after a positive match will exclude the Git ref.\n- A matching positive pattern after a negative match will include the Git ref again." } }, + withTagsMixin(value): { + on+: { + pull_request_target+: { + tags+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withTagsIgnore': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: "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.\nThe 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.\nThe 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.\nYou can use two types of filters to prevent a workflow from running on pushes and pull requests to tags and branches:\n- 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.\n- 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.\nYou can exclude tags and branches using the ! character. The order that you define patterns matters.\n- A matching negative pattern (prefixed with !) after a positive match will exclude the Git ref.\n- A matching positive pattern after a negative match will include the Git ref again." } }, + withTagsIgnore(value): { + on+: { + pull_request_target+: { + 'tags-ignore': + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withTagsIgnoreMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: "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.\nThe 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.\nThe 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.\nYou can use two types of filters to prevent a workflow from running on pushes and pull requests to tags and branches:\n- 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.\n- 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.\nYou can exclude tags and branches using the ! character. The order that you define patterns matters.\n- A matching negative pattern (prefixed with !) after a positive match will exclude the Git ref.\n- A matching positive pattern after a negative match will include the Git ref again." } }, + withTagsIgnoreMixin(value): { + on+: { + pull_request_target+: { + 'tags-ignore'+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withTypes': { 'function': { args: [{ default: ['opened', 'synchronize', 'reopened'], enums: null, name: 'value', type: ['array'] }], help: '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.\nYou 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.' } }, + withTypes(value): { + on+: { + pull_request_target+: { + types: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withTypesMixin': { 'function': { args: [{ default: ['opened', 'synchronize', 'reopened'], enums: null, name: 'value', type: ['array'] }], help: '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.\nYou 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.' } }, + withTypesMixin(value): { + on+: { + pull_request_target+: { + types+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + '#withPush': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Runs your workflow when someone pushes to a repository branch, which triggers the push event.\nNote: 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.' } }, + withPush(value): { + on+: { + push: value, + }, + }, + '#withPushMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Runs your workflow when someone pushes to a repository branch, which triggers the push event.\nNote: 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.' } }, + withPushMixin(value): { + on+: { + push+: value, + }, + }, + push+: + { + '#withBranches': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: "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.\nThe 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.\nThe 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.\nYou can use two types of filters to prevent a workflow from running on pushes and pull requests to tags and branches:\n- 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.\n- 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.\nYou can exclude tags and branches using the ! character. The order that you define patterns matters.\n- A matching negative pattern (prefixed with !) after a positive match will exclude the Git ref.\n- A matching positive pattern after a negative match will include the Git ref again." } }, + withBranches(value): { + on+: { + push+: { + branches: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withBranchesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: "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.\nThe 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.\nThe 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.\nYou can use two types of filters to prevent a workflow from running on pushes and pull requests to tags and branches:\n- 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.\n- 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.\nYou can exclude tags and branches using the ! character. The order that you define patterns matters.\n- A matching negative pattern (prefixed with !) after a positive match will exclude the Git ref.\n- A matching positive pattern after a negative match will include the Git ref again." } }, + withBranchesMixin(value): { + on+: { + push+: { + branches+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withBranchesIgnore': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: "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.\nThe 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.\nThe 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.\nYou can use two types of filters to prevent a workflow from running on pushes and pull requests to tags and branches:\n- 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.\n- 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.\nYou can exclude tags and branches using the ! character. The order that you define patterns matters.\n- A matching negative pattern (prefixed with !) after a positive match will exclude the Git ref.\n- A matching positive pattern after a negative match will include the Git ref again." } }, + withBranchesIgnore(value): { + on+: { + push+: { + 'branches-ignore': + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withBranchesIgnoreMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: "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.\nThe 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.\nThe 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.\nYou can use two types of filters to prevent a workflow from running on pushes and pull requests to tags and branches:\n- 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.\n- 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.\nYou can exclude tags and branches using the ! character. The order that you define patterns matters.\n- A matching negative pattern (prefixed with !) after a positive match will exclude the Git ref.\n- A matching positive pattern after a negative match will include the Git ref again." } }, + withBranchesIgnoreMixin(value): { + on+: { + push+: { + 'branches-ignore'+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withPaths': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '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.\nThe 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.\nYou can exclude paths using two types of filters. You cannot use both of these filters for the same event in a workflow.\n- paths-ignore - Use the paths-ignore filter when you only need to exclude path names.\n- paths - Use the paths filter when you need to filter paths for positive matches and exclude paths.' } }, + withPaths(value): { + on+: { + push+: { + paths: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withPathsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '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.\nThe 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.\nYou can exclude paths using two types of filters. You cannot use both of these filters for the same event in a workflow.\n- paths-ignore - Use the paths-ignore filter when you only need to exclude path names.\n- paths - Use the paths filter when you need to filter paths for positive matches and exclude paths.' } }, + withPathsMixin(value): { + on+: { + push+: { + paths+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withPathsIgnore': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '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.\nThe 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.\nYou can exclude paths using two types of filters. You cannot use both of these filters for the same event in a workflow.\n- paths-ignore - Use the paths-ignore filter when you only need to exclude path names.\n- paths - Use the paths filter when you need to filter paths for positive matches and exclude paths.' } }, + withPathsIgnore(value): { + on+: { + push+: { + 'paths-ignore': + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withPathsIgnoreMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '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.\nThe 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.\nYou can exclude paths using two types of filters. You cannot use both of these filters for the same event in a workflow.\n- paths-ignore - Use the paths-ignore filter when you only need to exclude path names.\n- paths - Use the paths filter when you need to filter paths for positive matches and exclude paths.' } }, + withPathsIgnoreMixin(value): { + on+: { + push+: { + 'paths-ignore'+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withTags': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: "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.\nThe 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.\nThe 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.\nYou can use two types of filters to prevent a workflow from running on pushes and pull requests to tags and branches:\n- 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.\n- 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.\nYou can exclude tags and branches using the ! character. The order that you define patterns matters.\n- A matching negative pattern (prefixed with !) after a positive match will exclude the Git ref.\n- A matching positive pattern after a negative match will include the Git ref again." } }, + withTags(value): { + on+: { + push+: { + tags: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withTagsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: "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.\nThe 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.\nThe 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.\nYou can use two types of filters to prevent a workflow from running on pushes and pull requests to tags and branches:\n- 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.\n- 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.\nYou can exclude tags and branches using the ! character. The order that you define patterns matters.\n- A matching negative pattern (prefixed with !) after a positive match will exclude the Git ref.\n- A matching positive pattern after a negative match will include the Git ref again." } }, + withTagsMixin(value): { + on+: { + push+: { + tags+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withTagsIgnore': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: "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.\nThe 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.\nThe 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.\nYou can use two types of filters to prevent a workflow from running on pushes and pull requests to tags and branches:\n- 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.\n- 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.\nYou can exclude tags and branches using the ! character. The order that you define patterns matters.\n- A matching negative pattern (prefixed with !) after a positive match will exclude the Git ref.\n- A matching positive pattern after a negative match will include the Git ref again." } }, + withTagsIgnore(value): { + on+: { + push+: { + 'tags-ignore': + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withTagsIgnoreMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: "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.\nThe 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.\nThe 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.\nYou can use two types of filters to prevent a workflow from running on pushes and pull requests to tags and branches:\n- 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.\n- 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.\nYou can exclude tags and branches using the ! character. The order that you define patterns matters.\n- A matching negative pattern (prefixed with !) after a positive match will exclude the Git ref.\n- A matching positive pattern after a negative match will include the Git ref again." } }, + withTagsIgnoreMixin(value): { + on+: { + push+: { + 'tags-ignore'+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + '#withRegistryPackage': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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.' } }, + withRegistryPackage(value): { + on+: { + registry_package: value, + }, + }, + '#withRegistryPackageMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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.' } }, + withRegistryPackageMixin(value): { + on+: { + registry_package+: value, + }, + }, + registry_package+: + { + '#withTypes': { 'function': { args: [{ default: ['published', 'updated'], enums: null, name: 'value', type: ['array'] }], help: '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.\nYou 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.' } }, + withTypes(value): { + on+: { + registry_package+: { + types: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withTypesMixin': { 'function': { args: [{ default: ['published', 'updated'], enums: null, name: 'value', type: ['array'] }], help: '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.\nYou 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.' } }, + withTypesMixin(value): { + on+: { + registry_package+: { + types+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + '#withRelease': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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.' } }, + withRelease(value): { + on+: { + release: value, + }, + }, + '#withReleaseMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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.' } }, + withReleaseMixin(value): { + on+: { + release+: value, + }, + }, + release+: + { + '#withTypes': { 'function': { args: [{ default: ['published', 'unpublished', 'created', 'edited', 'deleted', 'prereleased', 'released'], enums: null, name: 'value', type: ['array'] }], help: '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.\nYou 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.' } }, + withTypes(value): { + on+: { + release+: { + types: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withTypesMixin': { 'function': { args: [{ default: ['published', 'unpublished', 'created', 'edited', 'deleted', 'prereleased', 'released'], enums: null, name: 'value', type: ['array'] }], help: '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.\nYou 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.' } }, + withTypesMixin(value): { + on+: { + release+: { + types+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + '#withRepositoryDispatch': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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.\nTo 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.' } }, + withRepositoryDispatch(value): { + on+: { + repository_dispatch: value, + }, + }, + '#withRepositoryDispatchMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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.\nTo 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.' } }, + withRepositoryDispatchMixin(value): { + on+: { + repository_dispatch+: value, + }, + }, + '#withSchedule': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '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.\nNote: GitHub Actions does not support the non-standard syntax @yearly, @monthly, @weekly, @daily, @hourly, and @reboot.\nYou 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).' } }, + withSchedule(value): { + on+: { + schedule: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withScheduleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '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.\nNote: GitHub Actions does not support the non-standard syntax @yearly, @monthly, @weekly, @daily, @hourly, and @reboot.\nYou 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).' } }, + withScheduleMixin(value): { + on+: { + schedule+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withStatus': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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/.' } }, + withStatus(value): { + on+: { + status: value, + }, + }, + '#withStatusMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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/.' } }, + withStatusMixin(value): { + on+: { + status+: value, + }, + }, + '#withWatch': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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/.' } }, + withWatch(value): { + on+: { + watch: value, + }, + }, + '#withWatchMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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/.' } }, + withWatchMixin(value): { + on+: { + watch+: value, + }, + }, + '#withWorkflowCall': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Allows workflows to be reused by other workflows.' } }, + withWorkflowCall(value): { + on+: { + workflow_call: value, + }, + }, + '#withWorkflowDispatch': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "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." } }, + withWorkflowDispatch(value): { + on+: { + workflow_dispatch: value, + }, + }, + '#withWorkflowRun': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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.' } }, + withWorkflowRun(value): { + on+: { + workflow_run: value, + }, + }, + '#withWorkflowRunMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '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.' } }, + withWorkflowRunMixin(value): { + on+: { + workflow_run+: value, + }, + }, + workflow_run+: + { + '#withTypes': { 'function': { args: [{ default: ['requested', 'completed'], enums: null, name: 'value', type: ['array'] }], help: '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.\nYou 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.' } }, + withTypes(value): { + on+: { + workflow_run+: { + types: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withTypesMixin': { 'function': { args: [{ default: ['requested', 'completed'], enums: null, name: 'value', type: ['array'] }], help: '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.\nYou 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.' } }, + withTypesMixin(value): { + on+: { + workflow_run+: { + types+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withWorkflows': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withWorkflows(value): { + on+: { + workflow_run+: { + workflows: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withWorkflowsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withWorkflowsMixin(value): { + on+: { + workflow_run+: { + workflows+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + }, + '#withPermissions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '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.' } }, + withPermissions(value): { + permissions: value, + }, + '#withPermissionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '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.' } }, + withPermissionsMixin(value): { + permissions+: value, + }, + permissions+: + { + '#withActions': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, + withActions(value): { + permissions+: { + actions: value, + }, + }, + '#withAttestations': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, + withAttestations(value): { + permissions+: { + attestations: value, + }, + }, + '#withChecks': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, + withChecks(value): { + permissions+: { + checks: value, + }, + }, + '#withContents': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, + withContents(value): { + permissions+: { + contents: value, + }, + }, + '#withDeployments': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, + withDeployments(value): { + permissions+: { + deployments: value, + }, + }, + '#withDiscussions': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, + withDiscussions(value): { + permissions+: { + discussions: value, + }, + }, + '#withIdToken': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, + withIdToken(value): { + permissions+: { + 'id-token': value, + }, + }, + '#withIssues': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, + withIssues(value): { + permissions+: { + issues: value, + }, + }, + '#withPackages': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, + withPackages(value): { + permissions+: { + packages: value, + }, + }, + '#withPages': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, + withPages(value): { + permissions+: { + pages: value, + }, + }, + '#withPullRequests': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, + withPullRequests(value): { + permissions+: { + 'pull-requests': value, + }, + }, + '#withRepositoryProjects': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, + withRepositoryProjects(value): { + permissions+: { + 'repository-projects': value, + }, + }, + '#withSecurityEvents': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, + withSecurityEvents(value): { + permissions+: { + 'security-events': value, + }, + }, + '#withStatuses': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, + withStatuses(value): { + permissions+: { + statuses: value, + }, + }, + }, + '#withRunName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "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." } }, + withRunName(value): { + 'run-name': value, + }, + }, + job+: + { + '#withConcurrency': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '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. \nYou can also specify concurrency at the workflow level. \nWhen 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.' } }, + withConcurrency(value): { + concurrency: value, + }, + '#withConcurrencyMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '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. \nYou can also specify concurrency at the workflow level. \nWhen 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.' } }, + withConcurrencyMixin(value): { + concurrency+: value, + }, + concurrency+: + { + '#withCancelInProgress': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'string'] }], help: 'To cancel any currently running job or workflow in the same concurrency group, specify cancel-in-progress: true.' } }, + withCancelInProgress(value): { + concurrency+: { + 'cancel-in-progress': value, + }, + }, + '#withCancelInProgressMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'string'] }], help: 'To cancel any currently running job or workflow in the same concurrency group, specify cancel-in-progress: true.' } }, + withCancelInProgressMixin(value): { + concurrency+: { + 'cancel-in-progress'+: value, + }, + }, + 'cancel-in-progress'+: + { + '#withExpressionSyntax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withExpressionSyntax(value): { + concurrency+: { + 'cancel-in-progress'+: { + expressionSyntax: value, + }, + }, + }, + }, + '#withGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '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.' } }, + withGroup(value): { + concurrency+: { + group: value, + }, + }, + }, + '#withContainer': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "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.\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." } }, + withContainer(value): { + container: value, + }, + '#withContainerMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "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.\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." } }, + withContainerMixin(value): { + container+: value, + }, + container+: + { + '#withContainer': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withContainer(value): { + container: value, + }, + '#withContainerMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withContainerMixin(value): { + container+: value, + }, + container+: + { + '#withCredentials': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "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." } }, + withCredentials(value): { + container+: { + credentials: value, + }, + }, + '#withCredentialsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "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." } }, + withCredentialsMixin(value): { + container+: { + credentials+: value, + }, + }, + credentials+: + { + '#withPassword': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPassword(value): { + container+: { + credentials+: { + password: value, + }, + }, + }, + '#withUsername': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withUsername(value): { + container+: { + credentials+: { + username: value, + }, + }, + }, + }, + '#withEnv': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object', 'string'] }], help: '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..steps[*].env, jobs..env, and env keywords. For more information, see https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsenv' } }, + withEnv(value): { + container+: { + env: value, + }, + }, + '#withEnvMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object', 'string'] }], help: '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..steps[*].env, jobs..env, and env keywords. For more information, see https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsenv' } }, + withEnvMixin(value): { + container+: { + env+: value, + }, + }, + env+: + { + '#withStringContainingExpressionSyntax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withStringContainingExpressionSyntax(value): { + container+: { + env+: { + stringContainingExpressionSyntax: value, + }, + }, + }, + }, + '#withImage': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '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.' } }, + withImage(value): { + container+: { + image: value, + }, + }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Additional Docker container resource options. For a list of options, see https://docs.docker.com/engine/reference/commandline/create/#options.' } }, + withOptions(value): { + container+: { + options: value, + }, + }, + '#withPorts': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Sets an array of ports to expose on the container.' } }, + withPorts(value): { + container+: { + ports: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withPortsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Sets an array of ports to expose on the container.' } }, + withPortsMixin(value): { + container+: { + ports+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withVolumes': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '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: :\nThe is a volume name or an absolute path on the host machine, and is an absolute path in the container.' } }, + withVolumes(value): { + container+: { + volumes: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withVolumesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '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: :\nThe is a volume name or an absolute path on the host machine, and is an absolute path in the container.' } }, + withVolumesMixin(value): { + container+: { + volumes+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withCredentials': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "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." } }, + withCredentials(value): { + container+: { + credentials: value, + }, + }, + '#withCredentialsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "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." } }, + withCredentialsMixin(value): { + container+: { + credentials+: value, + }, + }, + credentials+: + { + '#withPassword': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPassword(value): { + container+: { + credentials+: { + password: value, + }, + }, + }, + '#withUsername': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withUsername(value): { + container+: { + credentials+: { + username: value, + }, + }, + }, + }, + '#withEnv': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object', 'string'] }], help: '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..steps[*].env, jobs..env, and env keywords. For more information, see https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsenv' } }, + withEnv(value): { + container+: { + env: value, + }, + }, + '#withEnvMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object', 'string'] }], help: '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..steps[*].env, jobs..env, and env keywords. For more information, see https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsenv' } }, + withEnvMixin(value): { + container+: { + env+: value, + }, + }, + env+: + { + '#withStringContainingExpressionSyntax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withStringContainingExpressionSyntax(value): { + container+: { + env+: { + stringContainingExpressionSyntax: value, + }, + }, + }, + }, + '#withImage': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '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.' } }, + withImage(value): { + container+: { + image: value, + }, + }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Additional Docker container resource options. For a list of options, see https://docs.docker.com/engine/reference/commandline/create/#options.' } }, + withOptions(value): { + container+: { + options: value, + }, + }, + '#withPorts': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Sets an array of ports to expose on the container.' } }, + withPorts(value): { + container+: { + ports: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withPortsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Sets an array of ports to expose on the container.' } }, + withPortsMixin(value): { + container+: { + ports+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withVolumes': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '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: :\nThe is a volume name or an absolute path on the host machine, and is an absolute path in the container.' } }, + withVolumes(value): { + container+: { + volumes: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withVolumesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '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: :\nThe is a volume name or an absolute path on the host machine, and is an absolute path in the container.' } }, + withVolumesMixin(value): { + container+: { + volumes+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withContinueOnError': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'string'] }], help: 'Prevents a workflow run from failing when a job fails. Set to true to allow a workflow run to pass when this job fails.' } }, + withContinueOnError(value): { + 'continue-on-error': value, + }, + '#withContinueOnErrorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'string'] }], help: 'Prevents a workflow run from failing when a job fails. Set to true to allow a workflow run to pass when this job fails.' } }, + withContinueOnErrorMixin(value): { + 'continue-on-error'+: value, + }, + 'continue-on-error'+: + { + '#withExpressionSyntax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withExpressionSyntax(value): { + 'continue-on-error'+: { + expressionSyntax: value, + }, + }, + }, + '#withDefaults': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'A map of default settings that will apply to all steps in the job.' } }, + withDefaults(value): { + defaults: value, + }, + '#withDefaultsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'A map of default settings that will apply to all steps in the job.' } }, + withDefaultsMixin(value): { + defaults+: value, + }, + defaults+: + { + '#withRun': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withRun(value): { + defaults+: { + run: value, + }, + }, + '#withRunMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withRunMixin(value): { + defaults+: { + run+: value, + }, + }, + run+: + { + '#withShell': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'string'] }], help: "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." } }, + withShell(value): { + defaults+: { + run+: { + shell: value, + }, + }, + }, + '#withShellMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'string'] }], help: "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." } }, + withShellMixin(value): { + defaults+: { + run+: { + shell+: value, + }, + }, + }, + '#withWorkingDirectory': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Using the working-directory keyword, you can specify the working directory of where to run the command.' } }, + withWorkingDirectory(value): { + defaults+: { + run+: { + 'working-directory': value, + }, + }, + }, + }, + }, + '#withEnv': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object', 'string'] }], help: '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..steps[*].env, jobs..env, and env keywords. For more information, see https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsenv' } }, + withEnv(value): { + env: value, + }, + '#withEnvMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object', 'string'] }], help: '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..steps[*].env, jobs..env, and env keywords. For more information, see https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsenv' } }, + withEnvMixin(value): { + env+: value, + }, + env+: + { + '#withStringContainingExpressionSyntax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withStringContainingExpressionSyntax(value): { + env+: { + stringContainingExpressionSyntax: value, + }, + }, + }, + '#withEnvironment': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: 'The environment that the job references.' } }, + withEnvironment(value): { + environment: value, + }, + '#withEnvironmentMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: 'The environment that the job references.' } }, + withEnvironmentMixin(value): { + environment+: value, + }, + environment+: + { + '#withEnvironment': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The environment that the job references' } }, + withEnvironment(value): { + environment: value, + }, + '#withEnvironmentMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The environment that the job references' } }, + withEnvironmentMixin(value): { + environment+: value, + }, + environment+: + { + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The name of the environment configured in the repo.' } }, + withName(value): { + environment+: { + name: value, + }, + }, + '#withUrl': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A deployment URL' } }, + withUrl(value): { + environment+: { + url: value, + }, + }, + }, + }, + '#withIf': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number', 'string'] }], help: '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.\nExpressions 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.' } }, + withIf(value): { + 'if': value, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The name of the job displayed on GitHub.' } }, + withName(value): { + name: value, + }, + '#withNeeds': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array', 'string'] }], help: '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.' } }, + withNeeds(value): { + needs: value, + }, + '#withNeedsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array', 'string'] }], help: '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.' } }, + withNeedsMixin(value): { + needs+: value, + }, + needs+: + { + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + needs+: { + name: value, + }, + }, + }, + '#withOutputs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'A map of outputs for a job. Job outputs are available to all downstream jobs that depend on this job.' } }, + withOutputs(value): { + outputs: value, + }, + '#withOutputsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'A map of outputs for a job. Job outputs are available to all downstream jobs that depend on this job.' } }, + withOutputsMixin(value): { + outputs+: value, + }, + '#withPermissions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '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.' } }, + withPermissions(value): { + permissions: value, + }, + '#withPermissionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '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.' } }, + withPermissionsMixin(value): { + permissions+: value, + }, + permissions+: + { + '#withActions': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, + withActions(value): { + permissions+: { + actions: value, + }, + }, + '#withAttestations': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, + withAttestations(value): { + permissions+: { + attestations: value, + }, + }, + '#withChecks': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, + withChecks(value): { + permissions+: { + checks: value, + }, + }, + '#withContents': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, + withContents(value): { + permissions+: { + contents: value, + }, + }, + '#withDeployments': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, + withDeployments(value): { + permissions+: { + deployments: value, + }, + }, + '#withDiscussions': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, + withDiscussions(value): { + permissions+: { + discussions: value, + }, + }, + '#withIdToken': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, + withIdToken(value): { + permissions+: { + 'id-token': value, + }, + }, + '#withIssues': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, + withIssues(value): { + permissions+: { + issues: value, + }, + }, + '#withPackages': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, + withPackages(value): { + permissions+: { + packages: value, + }, + }, + '#withPages': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, + withPages(value): { + permissions+: { + pages: value, + }, + }, + '#withPullRequests': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, + withPullRequests(value): { + permissions+: { + 'pull-requests': value, + }, + }, + '#withRepositoryProjects': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, + withRepositoryProjects(value): { + permissions+: { + 'repository-projects': value, + }, + }, + '#withSecurityEvents': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, + withSecurityEvents(value): { + permissions+: { + 'security-events': value, + }, + }, + '#withStatuses': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, + withStatuses(value): { + permissions+: { + statuses: value, + }, + }, + }, + '#withRunsOn': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array', 'object', 'string', 'string'] }], help: 'The type of machine to run the job on. The machine can be either a GitHub-hosted runner, or a self-hosted runner.' } }, + withRunsOn(value): { + 'runs-on': value, + }, + '#withRunsOnMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array', 'object', 'string', 'string'] }], help: 'The type of machine to run the job on. The machine can be either a GitHub-hosted runner, or a self-hosted runner.' } }, + withRunsOnMixin(value): { + 'runs-on'+: value, + }, + 'runs-on'+: + { + '#withGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withGroup(value): { + 'runs-on'+: { + group: value, + }, + }, + '#withLabels': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: '' } }, + withLabels(value): { + 'runs-on'+: { + labels: value, + }, + }, + '#withLabelsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: '' } }, + withLabelsMixin(value): { + 'runs-on'+: { + labels+: value, + }, + }, + '#withStringContainingExpressionSyntax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withStringContainingExpressionSyntax(value): { + 'runs-on'+: { + stringContainingExpressionSyntax: value, + }, + }, + '#withExpressionSyntax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withExpressionSyntax(value): { + 'runs-on'+: { + expressionSyntax: value, + }, + }, + }, + '#withServices': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "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.\nWhen 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.\nWhen 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.\nWhen a step does not use a container action, you must access the service using localhost and bind the ports." } }, + withServices(value): { + services: value, + }, + '#withServicesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "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.\nWhen 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.\nWhen 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.\nWhen a step does not use a container action, you must access the service using localhost and bind the ports." } }, + withServicesMixin(value): { + services+: value, + }, + '#withSteps': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '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.\nMust contain either `uses` or `run`\n' } }, + withSteps(value): { + steps: + (if std.isArray(value) + then value + else [value]), + }, + '#withStepsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '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.\nMust contain either `uses` or `run`\n' } }, + withStepsMixin(value): { + steps+: + (if std.isArray(value) + then value + else [value]), + }, + steps+: + { + '#': { help: '', name: 'steps' }, + '#withContinueOnError': { 'function': { args: [{ default: false, enums: null, name: 'value', type: ['boolean', 'string'] }], help: 'Prevents a job from failing when a step fails. Set to true to allow a job to pass when this step fails.' } }, + withContinueOnError(value=false): { + 'continue-on-error': value, + }, + '#withContinueOnErrorMixin': { 'function': { args: [{ default: false, enums: null, name: 'value', type: ['boolean', 'string'] }], help: 'Prevents a job from failing when a step fails. Set to true to allow a job to pass when this step fails.' } }, + withContinueOnErrorMixin(value): { + 'continue-on-error'+: value, + }, + 'continue-on-error'+: + { + '#withExpressionSyntax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withExpressionSyntax(value): { + 'continue-on-error'+: { + expressionSyntax: value, + }, + }, + }, + '#withEnv': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object', 'string'] }], help: '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..steps[*].env, jobs..env, and env keywords. For more information, see https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsenv' } }, + withEnv(value): { + env: value, + }, + '#withEnvMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object', 'string'] }], help: '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..steps[*].env, jobs..env, and env keywords. For more information, see https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsenv' } }, + withEnvMixin(value): { + env+: value, + }, + env+: + { + '#withStringContainingExpressionSyntax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withStringContainingExpressionSyntax(value): { + env+: { + stringContainingExpressionSyntax: value, + }, + }, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '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.' } }, + withId(value): { + id: value, + }, + '#withIf': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number', 'string'] }], help: '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.\nExpressions 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.' } }, + withIf(value): { + 'if': value, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A name for your step to display on GitHub.' } }, + withName(value): { + name: value, + }, + '#withRun': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "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.\nCommands 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.\nEach 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." } }, + withRun(value): { + run: value, + }, + '#withShell': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'string'] }], help: "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." } }, + withShell(value): { + shell: value, + }, + '#withShellMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'string'] }], help: "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." } }, + withShellMixin(value): { + shell+: value, + }, + '#withTimeoutMinutes': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number', 'string'] }], help: 'The maximum number of minutes to run the step before killing the process.' } }, + withTimeoutMinutes(value): { + 'timeout-minutes': value, + }, + '#withTimeoutMinutesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number', 'string'] }], help: 'The maximum number of minutes to run the step before killing the process.' } }, + withTimeoutMinutesMixin(value): { + 'timeout-minutes'+: value, + }, + 'timeout-minutes'+: + { + '#withExpressionSyntax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withExpressionSyntax(value): { + 'timeout-minutes'+: { + expressionSyntax: value, + }, + }, + }, + '#withUses': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "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/).\nWe 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.\n- Using the commit SHA of a released action version is the safest for stability and security.\n- 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.\n- 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.\nSome actions require inputs that you must set using the with keyword. Review the action's README file to determine the inputs required.\nActions 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." } }, + withUses(value): { + uses: value, + }, + '#withWith': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object', 'string'] }], help: '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..steps[*].env, jobs..env, and env keywords. For more information, see https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsenv' } }, + withWith(value): { + with: value, + }, + '#withWithMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object', 'string'] }], help: '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..steps[*].env, jobs..env, and env keywords. For more information, see https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsenv' } }, + withWithMixin(value): { + with+: value, + }, + with+: + { + '#withStringContainingExpressionSyntax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withStringContainingExpressionSyntax(value): { + with+: { + stringContainingExpressionSyntax: value, + }, + }, + }, + '#withWorkingDirectory': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Using the working-directory keyword, you can specify the working directory of where to run the command.' } }, + withWorkingDirectory(value): { + 'working-directory': value, + }, + }, + '#withStrategy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'A strategy creates a build matrix for your jobs. You can define different variations of an environment to run each job in.' } }, + withStrategy(value): { + strategy: value, + }, + '#withStrategyMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'A strategy creates a build matrix for your jobs. You can define different variations of an environment to run each job in.' } }, + withStrategyMixin(value): { + strategy+: value, + }, + strategy+: + { + '#withFailFast': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean', 'string'] }], help: 'When set to true, GitHub cancels all in-progress jobs if any matrix job fails. Default: true' } }, + withFailFast(value=true): { + strategy+: { + 'fail-fast': value, + }, + }, + '#withMatrix': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object', 'string'] }], help: '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.\nYou 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.\nWhen 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.' } }, + withMatrix(value): { + strategy+: { + matrix: value, + }, + }, + '#withMatrixMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object', 'string'] }], help: '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.\nYou 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.\nWhen 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.' } }, + withMatrixMixin(value): { + strategy+: { + matrix+: value, + }, + }, + matrix+: + { + '#withExpressionSyntax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withExpressionSyntax(value): { + strategy+: { + matrix+: { + expressionSyntax: value, + }, + }, + }, + }, + '#withMaxParallel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number', 'string'] }], help: '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.' } }, + withMaxParallel(value): { + strategy+: { + 'max-parallel': value, + }, + }, + }, + '#withTimeoutMinutes': { 'function': { args: [{ default: 360, enums: null, name: 'value', type: ['number', 'string'] }], help: 'The maximum number of minutes to let a workflow run before GitHub automatically cancels it. Default: 360' } }, + withTimeoutMinutes(value=360): { + 'timeout-minutes': value, + }, + '#withTimeoutMinutesMixin': { 'function': { args: [{ default: 360, enums: null, name: 'value', type: ['number', 'string'] }], help: 'The maximum number of minutes to let a workflow run before GitHub automatically cancels it. Default: 360' } }, + withTimeoutMinutesMixin(value): { + 'timeout-minutes'+: value, + }, + 'timeout-minutes'+: + { + '#withExpressionSyntax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withExpressionSyntax(value): { + 'timeout-minutes'+: { + expressionSyntax: value, + }, + }, + }, + }, +} diff --git a/refactor.libsonnet b/refactor.libsonnet deleted file mode 100644 index 2552d8a..0000000 --- a/refactor.libsonnet +++ /dev/null @@ -1,67 +0,0 @@ -local j = import 'github.com/Duologic/jsonnet-libsonnet/main.libsonnet'; -local jutils = import 'github.com/Duologic/jsonnet-libsonnet/utils.libsonnet'; -local crdsonnet = import 'github.com/crdsonnet/crdsonnet/crdsonnet/main.libsonnet'; -local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; -local xtd = import 'github.com/jsonnet-libs/xtd/main.libsonnet'; - -{ - ASTProcessor: - crdsonnet.processor.new() - + crdsonnet.processor.withRenderEngineType('ast'), - - refactor(ast, groupings={}, copy=[]): - local grouped = self.groupFields(ast, groupings); - local copied = self.copyFields(ast, copy); - - jutils.deepMergeObjects(grouped + copied), - - groupFields(ast, groupings): - [ - jutils.setFieldsAtPath( - key, - jutils.getFieldsFromPaths(ast, insertDocPath(groupings[key])) - ) - for key in std.objectFields(groupings) - ], - - local insertDocPath(arr) = - std.flatMap( - function(item) [pathToDocPath(item), item], - arr - ), - - local pathToDocPath(path) = - local splitFromPath = xtd.string.splitEscape(path, '.'); - local lastKey = xtd.array.slice(splitFromPath, -1)[0]; - std.join( - '.', - xtd.array.slice(splitFromPath, 0, -1) - + ['#' + lastKey], - ), - - copyFields(ast, toCopy): - [ - local obj = jutils.getFieldFromPath(ast, copy.from); - local splitFromPath = xtd.string.splitEscape(copy.to, '.'); - local lastKey = xtd.array.slice(splitFromPath, -1)[0]; - local updated = self.updatePackageName(lastKey, obj.expr.members); - jutils.setFieldsAtPath(copy.to, updated) - for copy in toCopy - ], - - updatePackageName(name, fields): - std.map( - function(field) - if jutils.isField(field) - && jutils.fieldnameValue(field.fieldname) == '#' - && jutils.type(field.expr) == 'literal' - then - j.field.field( - j.fieldname.string('#'), - j.literal(d.package.newSub(name, '')), - nobreak=true, - ) - else field, - fields - ), -}