diff --git a/Makefile b/Makefile index e137e76..5e38749 100644 --- a/Makefile +++ b/Makefile @@ -1,11 +1,14 @@ +DEFAULT: docs JSONNET_BIN ?= jsonnet jsonnetfile.json: - jb init + jb init || true -vendor jsonnetfile.lock.json: jsonnetfile.json +jsonnetfile.lock.json: jsonnetfile.json jb install +vendor: jsonnetfile.lock.json + .PHONY: test test: vendor jsonnetfile.lock.json @cd test/ && make test @@ -19,14 +22,19 @@ fmt: -o -name '*.jsonnet' -print \ | xargs -n 1 -- jsonnetfmt --no-use-implicit-plus -i -.PHONY: docs -docs: jsonnetfile.json +docs: vendor raw.libsonnet main.libsonnet @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 +raw.libsonnet: generator vendor examples jsonnet -J generator/vendor -S generator/generate.jsonnet | jsonnetfmt - > raw.libsonnet + +EXAMPLES_SOURCES := $(wildcard examples/*.jsonnet) +EXAMPLES_FILES := $(EXAMPLES_SOURCES:.jsonnet=.output.yaml) +examples: $(EXAMPLES_FILES) + +examples/%.output.yaml: examples/%.jsonnet + jsonnet -S $< > $@ diff --git a/docs/README.md b/docs/README.md index f46e9d3..eb18bf6 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,6 @@ # github-actions-libsonnet -Jsonnet library to create GitHub actions workflows. +Jsonnet library to create workflows and actions for GitHub Actions. ## Install ``` @@ -10,28 +10,11 @@ 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) - +local ga = import "github.com/crdsonnet/github-actions-libsonnet/main.libsonnet" ``` ## Subpackages * [action](action/index.md) -* [job](job/index.md) -* [util](util.md) -* [workflow](workflow.md) +* [workflow](workflow/index.md) diff --git a/docs/action/composite/index.md b/docs/action/composite/index.md new file mode 100644 index 0000000..b20629f --- /dev/null +++ b/docs/action/composite/index.md @@ -0,0 +1,231 @@ +# composite + +Configures the path to the composite action, and the application used to execute the code. + +## Subpackages + +* [input](input.md) +* [output](output.md) +* [runs.step](runs/step.md) + +## Index + +* [`fn new(name, description="defaults to the name")`](#fn-new) +* [`fn withAuthor(value)`](#fn-withauthor) +* [`fn withBranding(value)`](#fn-withbranding) +* [`fn withBrandingMixin(value)`](#fn-withbrandingmixin) +* [`fn withDescription(value)`](#fn-withdescription) +* [`fn withInputs(value)`](#fn-withinputs) +* [`fn withInputsMixin(value)`](#fn-withinputsmixin) +* [`fn withName(value)`](#fn-withname) +* [`fn withOutputs(value)`](#fn-withoutputs) +* [`fn withOutputsMixin(value)`](#fn-withoutputsmixin) +* [`fn withRuns(value)`](#fn-withruns) +* [`fn withRunsMixin(value)`](#fn-withrunsmixin) +* [`obj branding`](#obj-branding) + * [`fn withColor(value)`](#fn-brandingwithcolor) + * [`fn withIcon(value)`](#fn-brandingwithicon) +* [`obj runs`](#obj-runs) + * [`fn withSteps(value)`](#fn-runswithsteps) + * [`fn withStepsMixin(value)`](#fn-runswithstepsmixin) + * [`fn withUsing()`](#fn-runswithusing) + +## Fields + +### fn new + +```jsonnet +new(name, description="defaults to the name") +``` + +PARAMETERS: + +* **name** (`string`) +* **description** (`string`) + - default value: `"defaults to the name"` + +`new` initializes a Composite action. Use `withSteps()` to add steps. + +### fn withAuthor + +```jsonnet +withAuthor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The name of the action's author. +### fn withBranding + +```jsonnet +withBranding(value) +``` + +PARAMETERS: + +* **value** (`object`) + +You can use a color and Feather icon to create a badge to personalize and distinguish your action. Badges are shown next to your action name in GitHub Marketplace. +### fn withBrandingMixin + +```jsonnet +withBrandingMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +You can use a color and Feather icon to create a badge to personalize and distinguish your action. Badges are shown next to your action name in GitHub Marketplace. +### fn withDescription + +```jsonnet +withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A short description of the action. +### fn withInputs + +```jsonnet +withInputs(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Input parameters allow you to specify data that the action expects to use during runtime. GitHub stores input parameters as environment variables. Input ids with uppercase letters are converted to lowercase during runtime. We recommended using lowercase input ids. +### fn withInputsMixin + +```jsonnet +withInputsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Input parameters allow you to specify data that the action expects to use during runtime. GitHub stores input parameters as environment variables. Input ids with uppercase letters are converted to lowercase during runtime. We recommended using lowercase input ids. +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The name of your action. GitHub displays the `name` in the Actions tab to help visually identify actions in each job. +### fn withOutputs + +```jsonnet +withOutputs(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Output parameters allow you to declare data that an action sets. Actions that run later in a workflow can use the output data set in previously run actions. For example, if you had an action that performed the addition of two inputs (x + y = z), the action could output the sum (z) for other actions to use as an input. +If you don't declare an output in your action metadata file, you can still set outputs and use them in a workflow. +### fn withOutputsMixin + +```jsonnet +withOutputsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Output parameters allow you to declare data that an action sets. Actions that run later in a workflow can use the output data set in previously run actions. For example, if you had an action that performed the addition of two inputs (x + y = z), the action could output the sum (z) for other actions to use as an input. +If you don't declare an output in your action metadata file, you can still set outputs and use them in a workflow. +### fn withRuns + +```jsonnet +withRuns(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Configures the path to the composite action, and the application used to execute the code. +### fn withRunsMixin + +```jsonnet +withRunsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Configures the path to the composite action, and the application used to execute the code. +### obj branding + + +#### fn branding.withColor + +```jsonnet +branding.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"white"`, `"black"`, `"yellow"`, `"blue"`, `"green"`, `"orange"`, `"red"`, `"purple"`, `"gray-dark"` + +The background color of the badge. +#### fn branding.withIcon + +```jsonnet +branding.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"activity"`, `"airplay"`, `"alert-circle"`, `"alert-octagon"`, `"alert-triangle"`, `"align-center"`, `"align-justify"`, `"align-left"`, `"align-right"`, `"anchor"`, `"aperture"`, `"archive"`, `"arrow-down-circle"`, `"arrow-down-left"`, `"arrow-down-right"`, `"arrow-down"`, `"arrow-left-circle"`, `"arrow-left"`, `"arrow-right-circle"`, `"arrow-right"`, `"arrow-up-circle"`, `"arrow-up-left"`, `"arrow-up-right"`, `"arrow-up"`, `"at-sign"`, `"award"`, `"bar-chart-2"`, `"bar-chart"`, `"battery-charging"`, `"battery"`, `"bell-off"`, `"bell"`, `"bluetooth"`, `"bold"`, `"book-open"`, `"book"`, `"bookmark"`, `"box"`, `"briefcase"`, `"calendar"`, `"camera-off"`, `"camera"`, `"cast"`, `"check-circle"`, `"check-square"`, `"check"`, `"chevron-down"`, `"chevron-left"`, `"chevron-right"`, `"chevron-up"`, `"chevrons-down"`, `"chevrons-left"`, `"chevrons-right"`, `"chevrons-up"`, `"circle"`, `"clipboard"`, `"clock"`, `"cloud-drizzle"`, `"cloud-lightning"`, `"cloud-off"`, `"cloud-rain"`, `"cloud-snow"`, `"cloud"`, `"code"`, `"command"`, `"compass"`, `"copy"`, `"corner-down-left"`, `"corner-down-right"`, `"corner-left-down"`, `"corner-left-up"`, `"corner-right-down"`, `"corner-right-up"`, `"corner-up-left"`, `"corner-up-right"`, `"cpu"`, `"credit-card"`, `"crop"`, `"crosshair"`, `"database"`, `"delete"`, `"disc"`, `"dollar-sign"`, `"download-cloud"`, `"download"`, `"droplet"`, `"edit-2"`, `"edit-3"`, `"edit"`, `"external-link"`, `"eye-off"`, `"eye"`, `"fast-forward"`, `"feather"`, `"file-minus"`, `"file-plus"`, `"file-text"`, `"file"`, `"film"`, `"filter"`, `"flag"`, `"folder-minus"`, `"folder-plus"`, `"folder"`, `"gift"`, `"git-branch"`, `"git-commit"`, `"git-merge"`, `"git-pull-request"`, `"globe"`, `"grid"`, `"hard-drive"`, `"hash"`, `"headphones"`, `"heart"`, `"help-circle"`, `"home"`, `"image"`, `"inbox"`, `"info"`, `"italic"`, `"layers"`, `"layout"`, `"life-buoy"`, `"link-2"`, `"link"`, `"list"`, `"loader"`, `"lock"`, `"log-in"`, `"log-out"`, `"mail"`, `"map-pin"`, `"map"`, `"maximize-2"`, `"maximize"`, `"menu"`, `"message-circle"`, `"message-square"`, `"mic-off"`, `"mic"`, `"minimize-2"`, `"minimize"`, `"minus-circle"`, `"minus-square"`, `"minus"`, `"monitor"`, `"moon"`, `"more-horizontal"`, `"more-vertical"`, `"move"`, `"music"`, `"navigation-2"`, `"navigation"`, `"octagon"`, `"package"`, `"paperclip"`, `"pause-circle"`, `"pause"`, `"percent"`, `"phone-call"`, `"phone-forwarded"`, `"phone-incoming"`, `"phone-missed"`, `"phone-off"`, `"phone-outgoing"`, `"phone"`, `"pie-chart"`, `"play-circle"`, `"play"`, `"plus-circle"`, `"plus-square"`, `"plus"`, `"pocket"`, `"power"`, `"printer"`, `"radio"`, `"refresh-ccw"`, `"refresh-cw"`, `"repeat"`, `"rewind"`, `"rotate-ccw"`, `"rotate-cw"`, `"rss"`, `"save"`, `"scissors"`, `"search"`, `"send"`, `"server"`, `"settings"`, `"share-2"`, `"share"`, `"shield-off"`, `"shield"`, `"shopping-bag"`, `"shopping-cart"`, `"shuffle"`, `"sidebar"`, `"skip-back"`, `"skip-forward"`, `"slash"`, `"sliders"`, `"smartphone"`, `"speaker"`, `"square"`, `"star"`, `"stop-circle"`, `"sun"`, `"sunrise"`, `"sunset"`, `"table"`, `"tablet"`, `"tag"`, `"target"`, `"terminal"`, `"thermometer"`, `"thumbs-down"`, `"thumbs-up"`, `"toggle-left"`, `"toggle-right"`, `"trash-2"`, `"trash"`, `"trending-down"`, `"trending-up"`, `"triangle"`, `"truck"`, `"tv"`, `"type"`, `"umbrella"`, `"underline"`, `"unlock"`, `"upload-cloud"`, `"upload"`, `"user-check"`, `"user-minus"`, `"user-plus"`, `"user-x"`, `"user"`, `"users"`, `"video-off"`, `"video"`, `"voicemail"`, `"volume-1"`, `"volume-2"`, `"volume-x"`, `"volume"`, `"watch"`, `"wifi-off"`, `"wifi"`, `"wind"`, `"x-circle"`, `"x-square"`, `"x"`, `"zap-off"`, `"zap"`, `"zoom-in"`, `"zoom-out"` + +The name of the Feather icon to use. +### obj runs + + +#### fn runs.withSteps + +```jsonnet +runs.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The run steps that you plan to run in this action. +#### fn runs.withStepsMixin + +```jsonnet +runs.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The run steps that you plan to run in this action. +#### fn runs.withUsing + +```jsonnet +runs.withUsing() +``` + + +To use a composite run steps action, set this to 'composite'. \ No newline at end of file diff --git a/docs/action/input.md b/docs/action/composite/input.md similarity index 99% rename from docs/action/input.md rename to docs/action/composite/input.md index c4a59c5..edf6836 100644 --- a/docs/action/input.md +++ b/docs/action/composite/input.md @@ -1,4 +1,4 @@ -# action +# input diff --git a/docs/action/composite/output.md b/docs/action/composite/output.md new file mode 100644 index 0000000..4cd0aa3 --- /dev/null +++ b/docs/action/composite/output.md @@ -0,0 +1,33 @@ +# output + + + +## Index + +* [`fn withDescription(value)`](#fn-withdescription) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withDescription + +```jsonnet +withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A string description of the output parameter. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The value that the output parameter will be mapped to. You can set this to a string or an expression with context. For example, you can use the steps context to set the value of an output to the output value of a step. \ No newline at end of file diff --git a/docs/action/runs/composite/step.md b/docs/action/composite/runs/step.md similarity index 100% rename from docs/action/runs/composite/step.md rename to docs/action/composite/runs/step.md diff --git a/docs/action/docker/index.md b/docs/action/docker/index.md new file mode 100644 index 0000000..50f06cd --- /dev/null +++ b/docs/action/docker/index.md @@ -0,0 +1,350 @@ +# docker + +Configures the image used for the Docker action. + +## Subpackages + +* [input](input.md) +* [output](output.md) + +## Index + +* [`fn new(name, image, description="defaults to the name")`](#fn-new) +* [`fn withAuthor(value)`](#fn-withauthor) +* [`fn withBranding(value)`](#fn-withbranding) +* [`fn withBrandingMixin(value)`](#fn-withbrandingmixin) +* [`fn withDescription(value)`](#fn-withdescription) +* [`fn withInputs(value)`](#fn-withinputs) +* [`fn withInputsMixin(value)`](#fn-withinputsmixin) +* [`fn withName(value)`](#fn-withname) +* [`fn withOutputs(value)`](#fn-withoutputs) +* [`fn withOutputsMixin(value)`](#fn-withoutputsmixin) +* [`fn withRuns(value)`](#fn-withruns) +* [`fn withRunsMixin(value)`](#fn-withrunsmixin) +* [`obj branding`](#obj-branding) + * [`fn withColor(value)`](#fn-brandingwithcolor) + * [`fn withIcon(value)`](#fn-brandingwithicon) +* [`obj runs`](#obj-runs) + * [`fn withArgs(value)`](#fn-runswithargs) + * [`fn withArgsMixin(value)`](#fn-runswithargsmixin) + * [`fn withEntrypoint(value)`](#fn-runswithentrypoint) + * [`fn withEnv(value)`](#fn-runswithenv) + * [`fn withEnvMixin(value)`](#fn-runswithenvmixin) + * [`fn withImage(value)`](#fn-runswithimage) + * [`fn withPostEntrypoint(value)`](#fn-runswithpostentrypoint) + * [`fn withPostIf(value)`](#fn-runswithpostif) + * [`fn withPreEntrypoint(value)`](#fn-runswithpreentrypoint) + * [`fn withPreIf(value)`](#fn-runswithpreif) + * [`fn withUsing()`](#fn-runswithusing) + * [`obj env`](#obj-runsenv) + * [`fn withStringContainingExpressionSyntax(value)`](#fn-runsenvwithstringcontainingexpressionsyntax) + +## Fields + +### fn new + +```jsonnet +new(name, image, description="defaults to the name") +``` + +PARAMETERS: + +* **name** (`string`) +* **image** (`string`) +* **description** (`string`) + - default value: `"defaults to the name"` + +`new` initializes a Composite action. + +### fn withAuthor + +```jsonnet +withAuthor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The name of the action's author. +### fn withBranding + +```jsonnet +withBranding(value) +``` + +PARAMETERS: + +* **value** (`object`) + +You can use a color and Feather icon to create a badge to personalize and distinguish your action. Badges are shown next to your action name in GitHub Marketplace. +### fn withBrandingMixin + +```jsonnet +withBrandingMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +You can use a color and Feather icon to create a badge to personalize and distinguish your action. Badges are shown next to your action name in GitHub Marketplace. +### fn withDescription + +```jsonnet +withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A short description of the action. +### fn withInputs + +```jsonnet +withInputs(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Input parameters allow you to specify data that the action expects to use during runtime. GitHub stores input parameters as environment variables. Input ids with uppercase letters are converted to lowercase during runtime. We recommended using lowercase input ids. +### fn withInputsMixin + +```jsonnet +withInputsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Input parameters allow you to specify data that the action expects to use during runtime. GitHub stores input parameters as environment variables. Input ids with uppercase letters are converted to lowercase during runtime. We recommended using lowercase input ids. +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The name of your action. GitHub displays the `name` in the Actions tab to help visually identify actions in each job. +### fn withOutputs + +```jsonnet +withOutputs(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Output parameters allow you to declare data that an action sets. Actions that run later in a workflow can use the output data set in previously run actions. For example, if you had an action that performed the addition of two inputs (x + y = z), the action could output the sum (z) for other actions to use as an input. +If you don't declare an output in your action metadata file, you can still set outputs and use them in a workflow. +### fn withOutputsMixin + +```jsonnet +withOutputsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Output parameters allow you to declare data that an action sets. Actions that run later in a workflow can use the output data set in previously run actions. For example, if you had an action that performed the addition of two inputs (x + y = z), the action could output the sum (z) for other actions to use as an input. +If you don't declare an output in your action metadata file, you can still set outputs and use them in a workflow. +### fn withRuns + +```jsonnet +withRuns(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Configures the image used for the Docker action. +### fn withRunsMixin + +```jsonnet +withRunsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Configures the image used for the Docker action. +### obj branding + + +#### fn branding.withColor + +```jsonnet +branding.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"white"`, `"black"`, `"yellow"`, `"blue"`, `"green"`, `"orange"`, `"red"`, `"purple"`, `"gray-dark"` + +The background color of the badge. +#### fn branding.withIcon + +```jsonnet +branding.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"activity"`, `"airplay"`, `"alert-circle"`, `"alert-octagon"`, `"alert-triangle"`, `"align-center"`, `"align-justify"`, `"align-left"`, `"align-right"`, `"anchor"`, `"aperture"`, `"archive"`, `"arrow-down-circle"`, `"arrow-down-left"`, `"arrow-down-right"`, `"arrow-down"`, `"arrow-left-circle"`, `"arrow-left"`, `"arrow-right-circle"`, `"arrow-right"`, `"arrow-up-circle"`, `"arrow-up-left"`, `"arrow-up-right"`, `"arrow-up"`, `"at-sign"`, `"award"`, `"bar-chart-2"`, `"bar-chart"`, `"battery-charging"`, `"battery"`, `"bell-off"`, `"bell"`, `"bluetooth"`, `"bold"`, `"book-open"`, `"book"`, `"bookmark"`, `"box"`, `"briefcase"`, `"calendar"`, `"camera-off"`, `"camera"`, `"cast"`, `"check-circle"`, `"check-square"`, `"check"`, `"chevron-down"`, `"chevron-left"`, `"chevron-right"`, `"chevron-up"`, `"chevrons-down"`, `"chevrons-left"`, `"chevrons-right"`, `"chevrons-up"`, `"circle"`, `"clipboard"`, `"clock"`, `"cloud-drizzle"`, `"cloud-lightning"`, `"cloud-off"`, `"cloud-rain"`, `"cloud-snow"`, `"cloud"`, `"code"`, `"command"`, `"compass"`, `"copy"`, `"corner-down-left"`, `"corner-down-right"`, `"corner-left-down"`, `"corner-left-up"`, `"corner-right-down"`, `"corner-right-up"`, `"corner-up-left"`, `"corner-up-right"`, `"cpu"`, `"credit-card"`, `"crop"`, `"crosshair"`, `"database"`, `"delete"`, `"disc"`, `"dollar-sign"`, `"download-cloud"`, `"download"`, `"droplet"`, `"edit-2"`, `"edit-3"`, `"edit"`, `"external-link"`, `"eye-off"`, `"eye"`, `"fast-forward"`, `"feather"`, `"file-minus"`, `"file-plus"`, `"file-text"`, `"file"`, `"film"`, `"filter"`, `"flag"`, `"folder-minus"`, `"folder-plus"`, `"folder"`, `"gift"`, `"git-branch"`, `"git-commit"`, `"git-merge"`, `"git-pull-request"`, `"globe"`, `"grid"`, `"hard-drive"`, `"hash"`, `"headphones"`, `"heart"`, `"help-circle"`, `"home"`, `"image"`, `"inbox"`, `"info"`, `"italic"`, `"layers"`, `"layout"`, `"life-buoy"`, `"link-2"`, `"link"`, `"list"`, `"loader"`, `"lock"`, `"log-in"`, `"log-out"`, `"mail"`, `"map-pin"`, `"map"`, `"maximize-2"`, `"maximize"`, `"menu"`, `"message-circle"`, `"message-square"`, `"mic-off"`, `"mic"`, `"minimize-2"`, `"minimize"`, `"minus-circle"`, `"minus-square"`, `"minus"`, `"monitor"`, `"moon"`, `"more-horizontal"`, `"more-vertical"`, `"move"`, `"music"`, `"navigation-2"`, `"navigation"`, `"octagon"`, `"package"`, `"paperclip"`, `"pause-circle"`, `"pause"`, `"percent"`, `"phone-call"`, `"phone-forwarded"`, `"phone-incoming"`, `"phone-missed"`, `"phone-off"`, `"phone-outgoing"`, `"phone"`, `"pie-chart"`, `"play-circle"`, `"play"`, `"plus-circle"`, `"plus-square"`, `"plus"`, `"pocket"`, `"power"`, `"printer"`, `"radio"`, `"refresh-ccw"`, `"refresh-cw"`, `"repeat"`, `"rewind"`, `"rotate-ccw"`, `"rotate-cw"`, `"rss"`, `"save"`, `"scissors"`, `"search"`, `"send"`, `"server"`, `"settings"`, `"share-2"`, `"share"`, `"shield-off"`, `"shield"`, `"shopping-bag"`, `"shopping-cart"`, `"shuffle"`, `"sidebar"`, `"skip-back"`, `"skip-forward"`, `"slash"`, `"sliders"`, `"smartphone"`, `"speaker"`, `"square"`, `"star"`, `"stop-circle"`, `"sun"`, `"sunrise"`, `"sunset"`, `"table"`, `"tablet"`, `"tag"`, `"target"`, `"terminal"`, `"thermometer"`, `"thumbs-down"`, `"thumbs-up"`, `"toggle-left"`, `"toggle-right"`, `"trash-2"`, `"trash"`, `"trending-down"`, `"trending-up"`, `"triangle"`, `"truck"`, `"tv"`, `"type"`, `"umbrella"`, `"underline"`, `"unlock"`, `"upload-cloud"`, `"upload"`, `"user-check"`, `"user-minus"`, `"user-plus"`, `"user-x"`, `"user"`, `"users"`, `"video-off"`, `"video"`, `"voicemail"`, `"volume-1"`, `"volume-2"`, `"volume-x"`, `"volume"`, `"watch"`, `"wifi-off"`, `"wifi"`, `"wind"`, `"x-circle"`, `"x-square"`, `"x"`, `"zap-off"`, `"zap"`, `"zoom-in"`, `"zoom-out"` + +The name of the Feather icon to use. +### obj runs + + +#### fn runs.withArgs + +```jsonnet +runs.withArgs(value) +``` + +PARAMETERS: + +* **value** (`array`) + +An array of strings that define the inputs for a Docker container. Inputs can include hardcoded strings. GitHub passes the `args` to the container's `ENTRYPOINT` when the container starts up. +The `args` are used in place of the `CMD` instruction in a `Dockerfile`. If you use `CMD` in your `Dockerfile`, use the guidelines ordered by preference: +- Document required arguments in the action's README and omit them from the `CMD` instruction. +- Use defaults that allow using the action without specifying any `args`. +- If the action exposes a `--help` flag, or something similar, use that to make your action self-documenting. +#### fn runs.withArgsMixin + +```jsonnet +runs.withArgsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +An array of strings that define the inputs for a Docker container. Inputs can include hardcoded strings. GitHub passes the `args` to the container's `ENTRYPOINT` when the container starts up. +The `args` are used in place of the `CMD` instruction in a `Dockerfile`. If you use `CMD` in your `Dockerfile`, use the guidelines ordered by preference: +- Document required arguments in the action's README and omit them from the `CMD` instruction. +- Use defaults that allow using the action without specifying any `args`. +- If the action exposes a `--help` flag, or something similar, use that to make your action self-documenting. +#### fn runs.withEntrypoint + +```jsonnet +runs.withEntrypoint(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the Docker `ENTRYPOINT` in the `Dockerfile`, or sets it if one wasn't already specified. Use `entrypoint` when the `Dockerfile` does not specify an `ENTRYPOINT` or you want to override the `ENTRYPOINT` instruction. If you omit `entrypoint`, the commands you specify in the Docker `ENTRYPOINT` instruction will execute. The Docker `ENTRYPOINT instruction has a *shell* form and *exec* form. The Docker `ENTRYPOINT` documentation recommends using the *exec* form of the `ENTRYPOINT` instruction. +#### fn runs.withEnv + +```jsonnet +runs.withEnv(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + +Specifies a key/value map of environment variables to set in the container environment. +#### fn runs.withEnvMixin + +```jsonnet +runs.withEnvMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + +Specifies a key/value map of environment variables to set in the container environment. +#### fn runs.withImage + +```jsonnet +runs.withImage(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The Docker image to use as the container to run the action. The value can be the Docker base image name, a local `Dockerfile` in your repository, or a public image in Docker Hub or another registry. To reference a `Dockerfile` local to your repository, use a path relative to your action metadata file. The `docker` application will execute this file. +#### fn runs.withPostEntrypoint + +```jsonnet +runs.withPostEntrypoint(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Allows you to run a cleanup script once the `runs.entrypoint` action has completed. GitHub Actions uses `docker run` to launch this action. Because GitHub Actions runs the script inside a new container using the same base image, the runtime state is different from the main `entrypoint` container. You can access any state you need in either the workspace, `HOME`, or as a `STATE_` variable. The `post-entrypoint:` action always runs by default but you can override this using `post-if`. +#### fn runs.withPostIf + +```jsonnet +runs.withPostIf(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Allows you to define conditions for the `post:` action execution. The `post:` action will only run if the conditions in `post-if` are met. If not set, then `post-if` defaults to `always()`. +#### fn runs.withPreEntrypoint + +```jsonnet +runs.withPreEntrypoint(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Allows you to run a script before the `entrypoint` action begins. For example, you can use `pre-entrypoint:` to run a prerequisite setup script. GitHub Actions uses `docker run` to launch this action, and runs the script inside a new container that uses the same base image. This means that the runtime state is different from the main `entrypoint` container, and any states you require must be accessed in either the workspace, `HOME`, or as a `STATE_` variable. The `pre-entrypoint:` action always runs by default but you can override this using `pre-if`. +#### fn runs.withPreIf + +```jsonnet +runs.withPreIf(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Allows you to define conditions for the `pre:` action execution. The `pre:` action will only run if the conditions in `pre-if` are met. If not set, then `pre-if` defaults to `always()`. Note that the `step` context is unavailable, as no steps have run yet. +#### fn runs.withUsing + +```jsonnet +runs.withUsing() +``` + + +You must set this value to 'docker'. +#### obj runs.env + + +##### fn runs.env.withStringContainingExpressionSyntax + +```jsonnet +runs.env.withStringContainingExpressionSyntax(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/docs/action/docker/input.md b/docs/action/docker/input.md new file mode 100644 index 0000000..edf6836 --- /dev/null +++ b/docs/action/docker/input.md @@ -0,0 +1,58 @@ +# input + + + +## Index + +* [`fn withDefault(value)`](#fn-withdefault) +* [`fn withDeprecationMessage(value)`](#fn-withdeprecationmessage) +* [`fn withDescription(value)`](#fn-withdescription) +* [`fn withRequired(value=true)`](#fn-withrequired) + +## Fields + +### fn withDefault + +```jsonnet +withDefault(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A string representing the default value. The default value is used when an input parameter isn't specified in a workflow file. +### fn withDeprecationMessage + +```jsonnet +withDeprecationMessage(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A string shown to users using the deprecated input. +### fn withDescription + +```jsonnet +withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A string description of the input parameter. +### fn withRequired + +```jsonnet +withRequired(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +A boolean to indicate whether the action requires the input parameter. Set to `true` when the parameter is required. \ No newline at end of file diff --git a/docs/action/docker/output.md b/docs/action/docker/output.md new file mode 100644 index 0000000..4d9e87f --- /dev/null +++ b/docs/action/docker/output.md @@ -0,0 +1,21 @@ +# output + + + +## Index + +* [`fn withDescription(value)`](#fn-withdescription) + +## Fields + +### fn withDescription + +```jsonnet +withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A string description of the output parameter. \ No newline at end of file diff --git a/docs/action/index.md b/docs/action/index.md index 095ed85..a413785 100644 --- a/docs/action/index.md +++ b/docs/action/index.md @@ -1,539 +1,42 @@ # action - - -## Subpackages - -* [input](input.md) -* [runs.composite.step](runs/composite/step.md) - -## Index - -* [`fn withAuthor(value)`](#fn-withauthor) -* [`fn withBranding(value)`](#fn-withbranding) -* [`fn withBrandingMixin(value)`](#fn-withbrandingmixin) -* [`fn withDescription(value)`](#fn-withdescription) -* [`fn withInputs(value)`](#fn-withinputs) -* [`fn withInputsMixin(value)`](#fn-withinputsmixin) -* [`fn withName(value)`](#fn-withname) -* [`fn withOutputs(value)`](#fn-withoutputs) -* [`fn withRuns(value)`](#fn-withruns) -* [`fn withRunsMixin(value)`](#fn-withrunsmixin) -* [`obj branding`](#obj-branding) - * [`fn withColor(value)`](#fn-brandingwithcolor) - * [`fn withIcon(value)`](#fn-brandingwithicon) -* [`obj output`](#obj-output) - * [`fn withDescription(value)`](#fn-outputwithdescription) - * [`fn withValue(value)`](#fn-outputwithvalue) -* [`obj runs`](#obj-runs) - * [`fn withComposite(value)`](#fn-runswithcomposite) - * [`fn withCompositeMixin(value)`](#fn-runswithcompositemixin) - * [`fn withDocker(value)`](#fn-runswithdocker) - * [`fn withDockerMixin(value)`](#fn-runswithdockermixin) - * [`fn withJavascript(value)`](#fn-runswithjavascript) - * [`fn withJavascriptMixin(value)`](#fn-runswithjavascriptmixin) - * [`obj composite`](#obj-runscomposite) - * [`fn withSteps(value)`](#fn-runscompositewithsteps) - * [`fn withStepsMixin(value)`](#fn-runscompositewithstepsmixin) - * [`fn withUsing()`](#fn-runscompositewithusing) - * [`obj docker`](#obj-runsdocker) - * [`fn withArgs(value)`](#fn-runsdockerwithargs) - * [`fn withArgsMixin(value)`](#fn-runsdockerwithargsmixin) - * [`fn withEntrypoint(value)`](#fn-runsdockerwithentrypoint) - * [`fn withEnv(value)`](#fn-runsdockerwithenv) - * [`fn withEnvMixin(value)`](#fn-runsdockerwithenvmixin) - * [`fn withImage(value)`](#fn-runsdockerwithimage) - * [`fn withPostEntrypoint(value)`](#fn-runsdockerwithpostentrypoint) - * [`fn withPostIf(value)`](#fn-runsdockerwithpostif) - * [`fn withPreEntrypoint(value)`](#fn-runsdockerwithpreentrypoint) - * [`fn withPreIf(value)`](#fn-runsdockerwithpreif) - * [`fn withUsing()`](#fn-runsdockerwithusing) - * [`obj env`](#obj-runsdockerenv) - * [`fn withStringContainingExpressionSyntax(value)`](#fn-runsdockerenvwithstringcontainingexpressionsyntax) - * [`obj javascript`](#obj-runsjavascript) - * [`fn withMain(value)`](#fn-runsjavascriptwithmain) - * [`fn withPost(value)`](#fn-runsjavascriptwithpost) - * [`fn withPostIf(value)`](#fn-runsjavascriptwithpostif) - * [`fn withPre(value)`](#fn-runsjavascriptwithpre) - * [`fn withPreIf(value)`](#fn-runsjavascriptwithpreif) - * [`fn withUsing(value)`](#fn-runsjavascriptwithusing) - -## Fields - -### fn withAuthor - -```jsonnet -withAuthor(value) -``` - -PARAMETERS: - -* **value** (`string`) - -The name of the action's author. -### fn withBranding - -```jsonnet -withBranding(value) -``` - -PARAMETERS: - -* **value** (`object`) - -You can use a color and Feather icon to create a badge to personalize and distinguish your action. Badges are shown next to your action name in GitHub Marketplace. -### fn withBrandingMixin - -```jsonnet -withBrandingMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - -You can use a color and Feather icon to create a badge to personalize and distinguish your action. Badges are shown next to your action name in GitHub Marketplace. -### fn withDescription - -```jsonnet -withDescription(value) -``` - -PARAMETERS: - -* **value** (`string`) - -A short description of the action. -### fn withInputs - -```jsonnet -withInputs(value) -``` - -PARAMETERS: - -* **value** (`object`) - -Input parameters allow you to specify data that the action expects to use during runtime. GitHub stores input parameters as environment variables. Input ids with uppercase letters are converted to lowercase during runtime. We recommended using lowercase input ids. -### fn withInputsMixin - -```jsonnet -withInputsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - -Input parameters allow you to specify data that the action expects to use during runtime. GitHub stores input parameters as environment variables. Input ids with uppercase letters are converted to lowercase during runtime. We recommended using lowercase input ids. -### fn withName - -```jsonnet -withName(value) -``` - -PARAMETERS: - -* **value** (`string`) - -The name of your action. GitHub displays the `name` in the Actions tab to help visually identify actions in each job. -### fn withOutputs - -```jsonnet -withOutputs(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -### fn withRuns - -```jsonnet -withRuns(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -### fn withRunsMixin - -```jsonnet -withRunsMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - - -### obj branding - - -#### fn branding.withColor - -```jsonnet -branding.withColor(value) -``` - -PARAMETERS: - -* **value** (`string`) - - valid values: `"white"`, `"black"`, `"yellow"`, `"blue"`, `"green"`, `"orange"`, `"red"`, `"purple"`, `"gray-dark"` - -The background color of the badge. -#### fn branding.withIcon - -```jsonnet -branding.withIcon(value) -``` - -PARAMETERS: - -* **value** (`string`) - - valid values: `"activity"`, `"airplay"`, `"alert-circle"`, `"alert-octagon"`, `"alert-triangle"`, `"align-center"`, `"align-justify"`, `"align-left"`, `"align-right"`, `"anchor"`, `"aperture"`, `"archive"`, `"arrow-down-circle"`, `"arrow-down-left"`, `"arrow-down-right"`, `"arrow-down"`, `"arrow-left-circle"`, `"arrow-left"`, `"arrow-right-circle"`, `"arrow-right"`, `"arrow-up-circle"`, `"arrow-up-left"`, `"arrow-up-right"`, `"arrow-up"`, `"at-sign"`, `"award"`, `"bar-chart-2"`, `"bar-chart"`, `"battery-charging"`, `"battery"`, `"bell-off"`, `"bell"`, `"bluetooth"`, `"bold"`, `"book-open"`, `"book"`, `"bookmark"`, `"box"`, `"briefcase"`, `"calendar"`, `"camera-off"`, `"camera"`, `"cast"`, `"check-circle"`, `"check-square"`, `"check"`, `"chevron-down"`, `"chevron-left"`, `"chevron-right"`, `"chevron-up"`, `"chevrons-down"`, `"chevrons-left"`, `"chevrons-right"`, `"chevrons-up"`, `"circle"`, `"clipboard"`, `"clock"`, `"cloud-drizzle"`, `"cloud-lightning"`, `"cloud-off"`, `"cloud-rain"`, `"cloud-snow"`, `"cloud"`, `"code"`, `"command"`, `"compass"`, `"copy"`, `"corner-down-left"`, `"corner-down-right"`, `"corner-left-down"`, `"corner-left-up"`, `"corner-right-down"`, `"corner-right-up"`, `"corner-up-left"`, `"corner-up-right"`, `"cpu"`, `"credit-card"`, `"crop"`, `"crosshair"`, `"database"`, `"delete"`, `"disc"`, `"dollar-sign"`, `"download-cloud"`, `"download"`, `"droplet"`, `"edit-2"`, `"edit-3"`, `"edit"`, `"external-link"`, `"eye-off"`, `"eye"`, `"fast-forward"`, `"feather"`, `"file-minus"`, `"file-plus"`, `"file-text"`, `"file"`, `"film"`, `"filter"`, `"flag"`, `"folder-minus"`, `"folder-plus"`, `"folder"`, `"gift"`, `"git-branch"`, `"git-commit"`, `"git-merge"`, `"git-pull-request"`, `"globe"`, `"grid"`, `"hard-drive"`, `"hash"`, `"headphones"`, `"heart"`, `"help-circle"`, `"home"`, `"image"`, `"inbox"`, `"info"`, `"italic"`, `"layers"`, `"layout"`, `"life-buoy"`, `"link-2"`, `"link"`, `"list"`, `"loader"`, `"lock"`, `"log-in"`, `"log-out"`, `"mail"`, `"map-pin"`, `"map"`, `"maximize-2"`, `"maximize"`, `"menu"`, `"message-circle"`, `"message-square"`, `"mic-off"`, `"mic"`, `"minimize-2"`, `"minimize"`, `"minus-circle"`, `"minus-square"`, `"minus"`, `"monitor"`, `"moon"`, `"more-horizontal"`, `"more-vertical"`, `"move"`, `"music"`, `"navigation-2"`, `"navigation"`, `"octagon"`, `"package"`, `"paperclip"`, `"pause-circle"`, `"pause"`, `"percent"`, `"phone-call"`, `"phone-forwarded"`, `"phone-incoming"`, `"phone-missed"`, `"phone-off"`, `"phone-outgoing"`, `"phone"`, `"pie-chart"`, `"play-circle"`, `"play"`, `"plus-circle"`, `"plus-square"`, `"plus"`, `"pocket"`, `"power"`, `"printer"`, `"radio"`, `"refresh-ccw"`, `"refresh-cw"`, `"repeat"`, `"rewind"`, `"rotate-ccw"`, `"rotate-cw"`, `"rss"`, `"save"`, `"scissors"`, `"search"`, `"send"`, `"server"`, `"settings"`, `"share-2"`, `"share"`, `"shield-off"`, `"shield"`, `"shopping-bag"`, `"shopping-cart"`, `"shuffle"`, `"sidebar"`, `"skip-back"`, `"skip-forward"`, `"slash"`, `"sliders"`, `"smartphone"`, `"speaker"`, `"square"`, `"star"`, `"stop-circle"`, `"sun"`, `"sunrise"`, `"sunset"`, `"table"`, `"tablet"`, `"tag"`, `"target"`, `"terminal"`, `"thermometer"`, `"thumbs-down"`, `"thumbs-up"`, `"toggle-left"`, `"toggle-right"`, `"trash-2"`, `"trash"`, `"trending-down"`, `"trending-up"`, `"triangle"`, `"truck"`, `"tv"`, `"type"`, `"umbrella"`, `"underline"`, `"unlock"`, `"upload-cloud"`, `"upload"`, `"user-check"`, `"user-minus"`, `"user-plus"`, `"user-x"`, `"user"`, `"users"`, `"video-off"`, `"video"`, `"voicemail"`, `"volume-1"`, `"volume-2"`, `"volume-x"`, `"volume"`, `"watch"`, `"wifi-off"`, `"wifi"`, `"wind"`, `"x-circle"`, `"x-square"`, `"x"`, `"zap-off"`, `"zap"`, `"zoom-in"`, `"zoom-out"` - -The name of the Feather icon to use. -### obj output - - -#### fn output.withDescription - -```jsonnet -output.withDescription(value) -``` - -PARAMETERS: - -* **value** (`string`) - -A string description of the output parameter. -#### fn output.withValue - -```jsonnet -output.withValue(value) -``` - -PARAMETERS: - -* **value** (`string`) - -The value that the output parameter will be mapped to. You can set this to a string or an expression with context. For example, you can use the steps context to set the value of an output to the output value of a step. -### obj runs - - -#### fn runs.withComposite - -```jsonnet -runs.withComposite(value) -``` - -PARAMETERS: - -* **value** (`object`) - -Configures the path to the composite action, and the application used to execute the code. -#### fn runs.withCompositeMixin - -```jsonnet -runs.withCompositeMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - -Configures the path to the composite action, and the application used to execute the code. -#### fn runs.withDocker - -```jsonnet -runs.withDocker(value) -``` - -PARAMETERS: - -* **value** (`object`) - -Configures the image used for the Docker action. -#### fn runs.withDockerMixin - -```jsonnet -runs.withDockerMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - -Configures the image used for the Docker action. -#### fn runs.withJavascript - -```jsonnet -runs.withJavascript(value) -``` - -PARAMETERS: - -* **value** (`object`) - -Configures the path to the action's code and the application used to execute the code. -#### fn runs.withJavascriptMixin - -```jsonnet -runs.withJavascriptMixin(value) -``` - -PARAMETERS: - -* **value** (`object`) - -Configures the path to the action's code and the application used to execute the code. -#### obj runs.composite - - -##### fn runs.composite.withSteps - -```jsonnet -runs.composite.withSteps(value) -``` - -PARAMETERS: - -* **value** (`array`) - -The run steps that you plan to run in this action. -##### fn runs.composite.withStepsMixin - -```jsonnet -runs.composite.withStepsMixin(value) -``` - -PARAMETERS: - -* **value** (`array`) - -The run steps that you plan to run in this action. -##### fn runs.composite.withUsing - -```jsonnet -runs.composite.withUsing() -``` - - -To use a composite run steps action, set this to 'composite'. -#### obj runs.docker - - -##### fn runs.docker.withArgs - -```jsonnet -runs.docker.withArgs(value) -``` - -PARAMETERS: - -* **value** (`array`) - -An array of strings that define the inputs for a Docker container. Inputs can include hardcoded strings. GitHub passes the `args` to the container's `ENTRYPOINT` when the container starts up. -The `args` are used in place of the `CMD` instruction in a `Dockerfile`. If you use `CMD` in your `Dockerfile`, use the guidelines ordered by preference: -- Document required arguments in the action's README and omit them from the `CMD` instruction. -- Use defaults that allow using the action without specifying any `args`. -- If the action exposes a `--help` flag, or something similar, use that to make your action self-documenting. -##### fn runs.docker.withArgsMixin - -```jsonnet -runs.docker.withArgsMixin(value) -``` - -PARAMETERS: - -* **value** (`array`) - -An array of strings that define the inputs for a Docker container. Inputs can include hardcoded strings. GitHub passes the `args` to the container's `ENTRYPOINT` when the container starts up. -The `args` are used in place of the `CMD` instruction in a `Dockerfile`. If you use `CMD` in your `Dockerfile`, use the guidelines ordered by preference: -- Document required arguments in the action's README and omit them from the `CMD` instruction. -- Use defaults that allow using the action without specifying any `args`. -- If the action exposes a `--help` flag, or something similar, use that to make your action self-documenting. -##### fn runs.docker.withEntrypoint - -```jsonnet -runs.docker.withEntrypoint(value) -``` - -PARAMETERS: - -* **value** (`string`) - -Overrides the Docker `ENTRYPOINT` in the `Dockerfile`, or sets it if one wasn't already specified. Use `entrypoint` when the `Dockerfile` does not specify an `ENTRYPOINT` or you want to override the `ENTRYPOINT` instruction. If you omit `entrypoint`, the commands you specify in the Docker `ENTRYPOINT` instruction will execute. The Docker `ENTRYPOINT instruction has a *shell* form and *exec* form. The Docker `ENTRYPOINT` documentation recommends using the *exec* form of the `ENTRYPOINT` instruction. -##### fn runs.docker.withEnv - -```jsonnet -runs.docker.withEnv(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - -Specifies a key/value map of environment variables to set in the container environment. -##### fn runs.docker.withEnvMixin - -```jsonnet -runs.docker.withEnvMixin(value) -``` - -PARAMETERS: - -* **value** (`object`,`string`) - -Specifies a key/value map of environment variables to set in the container environment. -##### fn runs.docker.withImage - -```jsonnet -runs.docker.withImage(value) -``` - -PARAMETERS: - -* **value** (`string`) - -The Docker image to use as the container to run the action. The value can be the Docker base image name, a local `Dockerfile` in your repository, or a public image in Docker Hub or another registry. To reference a `Dockerfile` local to your repository, use a path relative to your action metadata file. The `docker` application will execute this file. -##### fn runs.docker.withPostEntrypoint - -```jsonnet -runs.docker.withPostEntrypoint(value) -``` - -PARAMETERS: - -* **value** (`string`) - -Allows you to run a cleanup script once the `runs.entrypoint` action has completed. GitHub Actions uses `docker run` to launch this action. Because GitHub Actions runs the script inside a new container using the same base image, the runtime state is different from the main `entrypoint` container. You can access any state you need in either the workspace, `HOME`, or as a `STATE_` variable. The `post-entrypoint:` action always runs by default but you can override this using `post-if`. -##### fn runs.docker.withPostIf - -```jsonnet -runs.docker.withPostIf(value) -``` - -PARAMETERS: - -* **value** (`string`) - -Allows you to define conditions for the `post:` action execution. The `post:` action will only run if the conditions in `post-if` are met. If not set, then `post-if` defaults to `always()`. -##### fn runs.docker.withPreEntrypoint - -```jsonnet -runs.docker.withPreEntrypoint(value) -``` - -PARAMETERS: - -* **value** (`string`) - -Allows you to run a script before the `entrypoint` action begins. For example, you can use `pre-entrypoint:` to run a prerequisite setup script. GitHub Actions uses `docker run` to launch this action, and runs the script inside a new container that uses the same base image. This means that the runtime state is different from the main `entrypoint` container, and any states you require must be accessed in either the workspace, `HOME`, or as a `STATE_` variable. The `pre-entrypoint:` action always runs by default but you can override this using `pre-if`. -##### fn runs.docker.withPreIf - -```jsonnet -runs.docker.withPreIf(value) -``` - -PARAMETERS: - -* **value** (`string`) - -Allows you to define conditions for the `pre:` action execution. The `pre:` action will only run if the conditions in `pre-if` are met. If not set, then `pre-if` defaults to `always()`. Note that the `step` context is unavailable, as no steps have run yet. -##### fn runs.docker.withUsing - -```jsonnet -runs.docker.withUsing() -``` - - -You must set this value to 'docker'. -##### obj runs.docker.env - - -###### fn runs.docker.env.withStringContainingExpressionSyntax - -```jsonnet -runs.docker.env.withStringContainingExpressionSyntax(value) -``` - -PARAMETERS: - -* **value** (`string`) - - -#### obj runs.javascript - - -##### fn runs.javascript.withMain - -```jsonnet -runs.javascript.withMain(value) -``` - -PARAMETERS: - -* **value** (`string`) - -The file that contains your action code. The application specified in `using` executes this file. -##### fn runs.javascript.withPost - -```jsonnet -runs.javascript.withPost(value) -``` - -PARAMETERS: - -* **value** (`string`) - -Allows you to run a script at the end of a job, once the `main:` action has completed. For example, you can use `post:` to terminate certain processes or remove unneeded files. The application specified with the `using` syntax will execute this file. The `post:` action always runs by default but you can override this using `post-if`. -##### fn runs.javascript.withPostIf - ```jsonnet -runs.javascript.withPostIf(value) -``` +local ga = import 'github.com/crdsonnet/github-actions-libsonnet/main.libsonnet'; +local step = ga.action.composite.runs.step; -PARAMETERS: +local exampleAction = + ga.action.composite.new('example composite action') + + ga.action.composite.runs.withSteps([ + step.withName('Checkout') + + step.withUses('actions/checkout@v4'), + ]); -* **value** (`string`) +exampleAction.manifest() -Allows you to define conditions for the `post:` action execution. The `post:` action will only run if the conditions in `post-if` are met. If not set, then `post-if` defaults to `always()`. -##### fn runs.javascript.withPre - -```jsonnet -runs.javascript.withPre(value) ``` -PARAMETERS: - -* **value** (`string`) - -Allows you to run a script at the start of a job, before the `main:` action begins. For example, you can use `pre:` to run a prerequisite setup script. The application specified with the `using` syntax will execute this file. The `pre:` action always runs by default but you can override this using `pre-if`. -##### fn runs.javascript.withPreIf +This can be rendered into a Yaml file like so: -```jsonnet -runs.javascript.withPreIf(value) +```console +jsonnet -S action.jsonnet ``` -PARAMETERS: - -* **value** (`string`) +The output will look like this: +```yaml +name: "example composite action" +description: "example composite action" -Allows you to define conditions for the `pre:` action execution. The `pre:` action will only run if the conditions in `pre-if` are met. If not set, then `pre-if` defaults to `always()`. Note that the `step` context is unavailable, as no steps have run yet. -##### fn runs.javascript.withUsing +runs: + using: "composite" -```jsonnet -runs.javascript.withUsing(value) + steps: + - name: "Checkout" + uses: "actions/checkout@v4" ``` -PARAMETERS: -* **value** (`string`) - - valid values: `"node12"`, `"node16"`, `"node20"` +## Subpackages -The application used to execute the code specified in `main`. \ No newline at end of file +* [composite](composite/index.md) +* [docker](docker/index.md) +* [javascript](javascript/index.md) diff --git a/docs/action/javascript/index.md b/docs/action/javascript/index.md new file mode 100644 index 0000000..a97f0ad --- /dev/null +++ b/docs/action/javascript/index.md @@ -0,0 +1,271 @@ +# javascript + +Configures the path to the action's code and the application used to execute the code. + +## Subpackages + +* [input](input.md) +* [output](output.md) + +## Index + +* [`fn new(name, main, description="defaults to the name")`](#fn-new) +* [`fn withAuthor(value)`](#fn-withauthor) +* [`fn withBranding(value)`](#fn-withbranding) +* [`fn withBrandingMixin(value)`](#fn-withbrandingmixin) +* [`fn withDescription(value)`](#fn-withdescription) +* [`fn withInputs(value)`](#fn-withinputs) +* [`fn withInputsMixin(value)`](#fn-withinputsmixin) +* [`fn withName(value)`](#fn-withname) +* [`fn withOutputs(value)`](#fn-withoutputs) +* [`fn withOutputsMixin(value)`](#fn-withoutputsmixin) +* [`fn withRuns(value)`](#fn-withruns) +* [`fn withRunsMixin(value)`](#fn-withrunsmixin) +* [`obj branding`](#obj-branding) + * [`fn withColor(value)`](#fn-brandingwithcolor) + * [`fn withIcon(value)`](#fn-brandingwithicon) +* [`obj runs`](#obj-runs) + * [`fn withMain(value)`](#fn-runswithmain) + * [`fn withPost(value)`](#fn-runswithpost) + * [`fn withPostIf(value)`](#fn-runswithpostif) + * [`fn withPre(value)`](#fn-runswithpre) + * [`fn withPreIf(value)`](#fn-runswithpreif) + * [`fn withUsing(value)`](#fn-runswithusing) + +## Fields + +### fn new + +```jsonnet +new(name, main, description="defaults to the name") +``` + +PARAMETERS: + +* **name** (`string`) +* **main** (`string`) +* **description** (`string`) + - default value: `"defaults to the name"` + +`new` initializes a Javascript action. + +### fn withAuthor + +```jsonnet +withAuthor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The name of the action's author. +### fn withBranding + +```jsonnet +withBranding(value) +``` + +PARAMETERS: + +* **value** (`object`) + +You can use a color and Feather icon to create a badge to personalize and distinguish your action. Badges are shown next to your action name in GitHub Marketplace. +### fn withBrandingMixin + +```jsonnet +withBrandingMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +You can use a color and Feather icon to create a badge to personalize and distinguish your action. Badges are shown next to your action name in GitHub Marketplace. +### fn withDescription + +```jsonnet +withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A short description of the action. +### fn withInputs + +```jsonnet +withInputs(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Input parameters allow you to specify data that the action expects to use during runtime. GitHub stores input parameters as environment variables. Input ids with uppercase letters are converted to lowercase during runtime. We recommended using lowercase input ids. +### fn withInputsMixin + +```jsonnet +withInputsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Input parameters allow you to specify data that the action expects to use during runtime. GitHub stores input parameters as environment variables. Input ids with uppercase letters are converted to lowercase during runtime. We recommended using lowercase input ids. +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The name of your action. GitHub displays the `name` in the Actions tab to help visually identify actions in each job. +### fn withOutputs + +```jsonnet +withOutputs(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Output parameters allow you to declare data that an action sets. Actions that run later in a workflow can use the output data set in previously run actions. For example, if you had an action that performed the addition of two inputs (x + y = z), the action could output the sum (z) for other actions to use as an input. +If you don't declare an output in your action metadata file, you can still set outputs and use them in a workflow. +### fn withOutputsMixin + +```jsonnet +withOutputsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Output parameters allow you to declare data that an action sets. Actions that run later in a workflow can use the output data set in previously run actions. For example, if you had an action that performed the addition of two inputs (x + y = z), the action could output the sum (z) for other actions to use as an input. +If you don't declare an output in your action metadata file, you can still set outputs and use them in a workflow. +### fn withRuns + +```jsonnet +withRuns(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Configures the path to the action's code and the application used to execute the code. +### fn withRunsMixin + +```jsonnet +withRunsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Configures the path to the action's code and the application used to execute the code. +### obj branding + + +#### fn branding.withColor + +```jsonnet +branding.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"white"`, `"black"`, `"yellow"`, `"blue"`, `"green"`, `"orange"`, `"red"`, `"purple"`, `"gray-dark"` + +The background color of the badge. +#### fn branding.withIcon + +```jsonnet +branding.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"activity"`, `"airplay"`, `"alert-circle"`, `"alert-octagon"`, `"alert-triangle"`, `"align-center"`, `"align-justify"`, `"align-left"`, `"align-right"`, `"anchor"`, `"aperture"`, `"archive"`, `"arrow-down-circle"`, `"arrow-down-left"`, `"arrow-down-right"`, `"arrow-down"`, `"arrow-left-circle"`, `"arrow-left"`, `"arrow-right-circle"`, `"arrow-right"`, `"arrow-up-circle"`, `"arrow-up-left"`, `"arrow-up-right"`, `"arrow-up"`, `"at-sign"`, `"award"`, `"bar-chart-2"`, `"bar-chart"`, `"battery-charging"`, `"battery"`, `"bell-off"`, `"bell"`, `"bluetooth"`, `"bold"`, `"book-open"`, `"book"`, `"bookmark"`, `"box"`, `"briefcase"`, `"calendar"`, `"camera-off"`, `"camera"`, `"cast"`, `"check-circle"`, `"check-square"`, `"check"`, `"chevron-down"`, `"chevron-left"`, `"chevron-right"`, `"chevron-up"`, `"chevrons-down"`, `"chevrons-left"`, `"chevrons-right"`, `"chevrons-up"`, `"circle"`, `"clipboard"`, `"clock"`, `"cloud-drizzle"`, `"cloud-lightning"`, `"cloud-off"`, `"cloud-rain"`, `"cloud-snow"`, `"cloud"`, `"code"`, `"command"`, `"compass"`, `"copy"`, `"corner-down-left"`, `"corner-down-right"`, `"corner-left-down"`, `"corner-left-up"`, `"corner-right-down"`, `"corner-right-up"`, `"corner-up-left"`, `"corner-up-right"`, `"cpu"`, `"credit-card"`, `"crop"`, `"crosshair"`, `"database"`, `"delete"`, `"disc"`, `"dollar-sign"`, `"download-cloud"`, `"download"`, `"droplet"`, `"edit-2"`, `"edit-3"`, `"edit"`, `"external-link"`, `"eye-off"`, `"eye"`, `"fast-forward"`, `"feather"`, `"file-minus"`, `"file-plus"`, `"file-text"`, `"file"`, `"film"`, `"filter"`, `"flag"`, `"folder-minus"`, `"folder-plus"`, `"folder"`, `"gift"`, `"git-branch"`, `"git-commit"`, `"git-merge"`, `"git-pull-request"`, `"globe"`, `"grid"`, `"hard-drive"`, `"hash"`, `"headphones"`, `"heart"`, `"help-circle"`, `"home"`, `"image"`, `"inbox"`, `"info"`, `"italic"`, `"layers"`, `"layout"`, `"life-buoy"`, `"link-2"`, `"link"`, `"list"`, `"loader"`, `"lock"`, `"log-in"`, `"log-out"`, `"mail"`, `"map-pin"`, `"map"`, `"maximize-2"`, `"maximize"`, `"menu"`, `"message-circle"`, `"message-square"`, `"mic-off"`, `"mic"`, `"minimize-2"`, `"minimize"`, `"minus-circle"`, `"minus-square"`, `"minus"`, `"monitor"`, `"moon"`, `"more-horizontal"`, `"more-vertical"`, `"move"`, `"music"`, `"navigation-2"`, `"navigation"`, `"octagon"`, `"package"`, `"paperclip"`, `"pause-circle"`, `"pause"`, `"percent"`, `"phone-call"`, `"phone-forwarded"`, `"phone-incoming"`, `"phone-missed"`, `"phone-off"`, `"phone-outgoing"`, `"phone"`, `"pie-chart"`, `"play-circle"`, `"play"`, `"plus-circle"`, `"plus-square"`, `"plus"`, `"pocket"`, `"power"`, `"printer"`, `"radio"`, `"refresh-ccw"`, `"refresh-cw"`, `"repeat"`, `"rewind"`, `"rotate-ccw"`, `"rotate-cw"`, `"rss"`, `"save"`, `"scissors"`, `"search"`, `"send"`, `"server"`, `"settings"`, `"share-2"`, `"share"`, `"shield-off"`, `"shield"`, `"shopping-bag"`, `"shopping-cart"`, `"shuffle"`, `"sidebar"`, `"skip-back"`, `"skip-forward"`, `"slash"`, `"sliders"`, `"smartphone"`, `"speaker"`, `"square"`, `"star"`, `"stop-circle"`, `"sun"`, `"sunrise"`, `"sunset"`, `"table"`, `"tablet"`, `"tag"`, `"target"`, `"terminal"`, `"thermometer"`, `"thumbs-down"`, `"thumbs-up"`, `"toggle-left"`, `"toggle-right"`, `"trash-2"`, `"trash"`, `"trending-down"`, `"trending-up"`, `"triangle"`, `"truck"`, `"tv"`, `"type"`, `"umbrella"`, `"underline"`, `"unlock"`, `"upload-cloud"`, `"upload"`, `"user-check"`, `"user-minus"`, `"user-plus"`, `"user-x"`, `"user"`, `"users"`, `"video-off"`, `"video"`, `"voicemail"`, `"volume-1"`, `"volume-2"`, `"volume-x"`, `"volume"`, `"watch"`, `"wifi-off"`, `"wifi"`, `"wind"`, `"x-circle"`, `"x-square"`, `"x"`, `"zap-off"`, `"zap"`, `"zoom-in"`, `"zoom-out"` + +The name of the Feather icon to use. +### obj runs + + +#### fn runs.withMain + +```jsonnet +runs.withMain(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The file that contains your action code. The application specified in `using` executes this file. +#### fn runs.withPost + +```jsonnet +runs.withPost(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Allows you to run a script at the end of a job, once the `main:` action has completed. For example, you can use `post:` to terminate certain processes or remove unneeded files. The application specified with the `using` syntax will execute this file. The `post:` action always runs by default but you can override this using `post-if`. +#### fn runs.withPostIf + +```jsonnet +runs.withPostIf(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Allows you to define conditions for the `post:` action execution. The `post:` action will only run if the conditions in `post-if` are met. If not set, then `post-if` defaults to `always()`. +#### fn runs.withPre + +```jsonnet +runs.withPre(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Allows you to run a script at the start of a job, before the `main:` action begins. For example, you can use `pre:` to run a prerequisite setup script. The application specified with the `using` syntax will execute this file. The `pre:` action always runs by default but you can override this using `pre-if`. +#### fn runs.withPreIf + +```jsonnet +runs.withPreIf(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Allows you to define conditions for the `pre:` action execution. The `pre:` action will only run if the conditions in `pre-if` are met. If not set, then `pre-if` defaults to `always()`. Note that the `step` context is unavailable, as no steps have run yet. +#### fn runs.withUsing + +```jsonnet +runs.withUsing(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"node12"`, `"node16"`, `"node20"` + +The application used to execute the code specified in `main`. \ No newline at end of file diff --git a/docs/action/javascript/input.md b/docs/action/javascript/input.md new file mode 100644 index 0000000..edf6836 --- /dev/null +++ b/docs/action/javascript/input.md @@ -0,0 +1,58 @@ +# input + + + +## Index + +* [`fn withDefault(value)`](#fn-withdefault) +* [`fn withDeprecationMessage(value)`](#fn-withdeprecationmessage) +* [`fn withDescription(value)`](#fn-withdescription) +* [`fn withRequired(value=true)`](#fn-withrequired) + +## Fields + +### fn withDefault + +```jsonnet +withDefault(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A string representing the default value. The default value is used when an input parameter isn't specified in a workflow file. +### fn withDeprecationMessage + +```jsonnet +withDeprecationMessage(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A string shown to users using the deprecated input. +### fn withDescription + +```jsonnet +withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A string description of the input parameter. +### fn withRequired + +```jsonnet +withRequired(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +A boolean to indicate whether the action requires the input parameter. Set to `true` when the parameter is required. \ No newline at end of file diff --git a/docs/action/javascript/output.md b/docs/action/javascript/output.md new file mode 100644 index 0000000..4d9e87f --- /dev/null +++ b/docs/action/javascript/output.md @@ -0,0 +1,21 @@ +# output + + + +## Index + +* [`fn withDescription(value)`](#fn-withdescription) + +## Fields + +### fn withDescription + +```jsonnet +withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A string description of the output parameter. \ No newline at end of file diff --git a/docs/util.md b/docs/util.md deleted file mode 100644 index 83df384..0000000 --- a/docs/util.md +++ /dev/null @@ -1,40 +0,0 @@ -# util - - - -## Index - -* [`fn manifestAction(action)`](#fn-manifestaction) -* [`fn manifestWorkflow(workflow)`](#fn-manifestworkflow) - -## Fields - -### fn manifestAction - -```jsonnet -manifestAction(action) -``` - -PARAMETERS: - -* **action** (`object`) - -`manifestAction` manifests an action in an opinionated Yaml format. - -It manifest fields in the same order as they show up in the syntax docs: -https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions - -### fn manifestWorkflow - -```jsonnet -manifestWorkflow(workflow) -``` - -PARAMETERS: - -* **workflow** (`object`) - -`manifestWorkflow` manifests a workflow in an opinionated Yaml format. - -It manifest fields in the same order as they show up in the syntax docs: -https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions diff --git a/docs/workflow.md b/docs/workflow/index.md similarity index 99% rename from docs/workflow.md rename to docs/workflow/index.md index 339c90b..7dbbf16 100644 --- a/docs/workflow.md +++ b/docs/workflow/index.md @@ -1,9 +1,56 @@ # workflow +```jsonnet +local ga = import 'github.com/crdsonnet/github-actions-libsonnet/main.libsonnet'; +local job = ga.workflow.job; + +local exampleWorkflow = + ga.workflow.new('example workflow') + + ga.workflow.on.pull_request.withBranches(['main']) + + ga.workflow.withJobs({ + example: + job.withRunsOn('ubuntu-latest') + + job.withSteps([ + job.step.withName('Checkout') + + job.step.withUses('actions/checkout@v4'), + ]), + }); + +exampleWorkflow.manifest() + +``` + +This can be rendered into a Yaml file like so: + +```console +jsonnet -S workflow.jsonnet +``` + +The output will look like this: +```yaml +name: "example workflow" + +on: + pull_request: + branches: + - "main" + +jobs: + example: + runs-on: "ubuntu-latest" + steps: + - name: "Checkout" + uses: "actions/checkout@v4" +``` + + +## Subpackages +* [job](job/index.md) ## Index +* [`fn new(name)`](#fn-new) * [`fn withConcurrency(value)`](#fn-withconcurrency) * [`fn withConcurrencyMixin(value)`](#fn-withconcurrencymixin) * [`fn withDefaults(value)`](#fn-withdefaults) @@ -220,6 +267,18 @@ ## Fields +### fn new + +```jsonnet +new(name) +``` + +PARAMETERS: + +* **name** (`string`) + +`new` initializes a Workflow. + ### fn withConcurrency ```jsonnet diff --git a/docs/job/index.md b/docs/workflow/job/index.md similarity index 100% rename from docs/job/index.md rename to docs/workflow/job/index.md diff --git a/docs/job/step.md b/docs/workflow/job/step.md similarity index 100% rename from docs/job/step.md rename to docs/workflow/job/step.md diff --git a/example.jsonnet b/example.jsonnet deleted file mode 100644 index 0e26d1b..0000000 --- a/example.jsonnet +++ /dev/null @@ -1,15 +0,0 @@ -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/examples/action.jsonnet b/examples/action.jsonnet new file mode 100644 index 0000000..a5bb2cb --- /dev/null +++ b/examples/action.jsonnet @@ -0,0 +1,11 @@ +local ga = import '../main.libsonnet'; +local step = ga.action.composite.runs.step; + +local exampleAction = + ga.action.composite.new('example composite action') + + ga.action.composite.runs.withSteps([ + step.withName('Checkout') + + step.withUses('actions/checkout@v4'), + ]); + +exampleAction.manifest() diff --git a/examples/action.output.yaml b/examples/action.output.yaml new file mode 100644 index 0000000..869c67a --- /dev/null +++ b/examples/action.output.yaml @@ -0,0 +1,9 @@ +name: "example composite action" +description: "example composite action" + +runs: + using: "composite" + + steps: + - name: "Checkout" + uses: "actions/checkout@v4" diff --git a/examples/workflow.jsonnet b/examples/workflow.jsonnet new file mode 100644 index 0000000..b0ec42e --- /dev/null +++ b/examples/workflow.jsonnet @@ -0,0 +1,16 @@ +local ga = import '../main.libsonnet'; +local job = ga.workflow.job; + +local exampleWorkflow = + ga.workflow.new('example workflow') + + ga.workflow.on.pull_request.withBranches(['main']) + + ga.workflow.withJobs({ + example: + job.withRunsOn('ubuntu-latest') + + job.withSteps([ + job.step.withName('Checkout') + + job.step.withUses('actions/checkout@v4'), + ]), + }); + +exampleWorkflow.manifest() diff --git a/examples/workflow.output.yaml b/examples/workflow.output.yaml new file mode 100644 index 0000000..63eaae9 --- /dev/null +++ b/examples/workflow.output.yaml @@ -0,0 +1,13 @@ +name: "example workflow" + +on: + pull_request: + branches: + - "main" + +jobs: + example: + runs-on: "ubuntu-latest" + steps: + - name: "Checkout" + uses: "actions/checkout@v4" diff --git a/generator/action.libsonnet b/generator/action.libsonnet new file mode 100644 index 0000000..4bb62de --- /dev/null +++ b/generator/action.libsonnet @@ -0,0 +1,139 @@ +local a = import 'github.com/crdsonnet/astsonnet/main.libsonnet'; +local autils = import 'github.com/crdsonnet/astsonnet/utils.libsonnet'; +local crdsonnet = import 'github.com/crdsonnet/crdsonnet/crdsonnet/main.libsonnet'; + +local util = import './util.libsonnet'; + +local schema = import 'github.com/SchemaStore/schemastore/src/schemas/json/github-action.json'; + +local compositeSchema = + schema + + { + properties+: { + runs: + schema.definitions['runs-composite'] + + { + properties+: { + steps:: {}, + local steps = super.steps, + step: steps, + }, + }, + outputs: schema.definitions['outputs-composite'], + }, + }; + +local compositeOutputsSchema = + schema.definitions['outputs-composite'].patternProperties['^[_a-zA-Z][a-zA-Z0-9_-]*$']; + +local dockerSchema = + schema + + { + properties+: { + runs: schema.definitions['runs-docker'], + outputs: schema.definitions.outputs, + }, + }; + +local javascriptSchema = + schema + + { + properties+: { + runs: schema.definitions['runs-javascript'], + outputs: schema.definitions.outputs, + }, + }; + +local inputsSchema = + schema.properties.inputs.patternProperties['^[_a-zA-Z][a-zA-Z0-9_-]*$']; + +local outputsSchema = + schema.definitions.outputs.patternProperties['^[_a-zA-Z][a-zA-Z0-9_-]*$']; + +local runsHelp(using) = + schema.definitions['runs-%s' % using].description; + +local forUsing(using, schema, inputsSchema, outputsSchema) = + a.object.new([ + a.field.new( + a.id.new('action'), + util.mergeDocstring( + using, + autils.deepMergeObjects([ + crdsonnet.schema.render(using, schema, util.processor), + a.object.new([ + a.field.new( + a.id.new(using), + util.mergeDocstring( + 'input', + crdsonnet.schema.render('input', inputsSchema, util.processor), + ) + ), + ]), + a.object.new([ + a.field.new( + a.id.new(using), + util.mergeDocstring( + 'output', + crdsonnet.schema.render('output', outputsSchema, util.processor), + ) + ), + ]), + ]), + runsHelp(using), + ), + ) + + a.field.withAdditive(), + ]); + +local tree = + util.mergeDocstring( + 'action', + autils.deepMergeObjects([ + forUsing( + 'composite', + compositeSchema, + inputsSchema, + compositeOutputsSchema + ), + forUsing( + 'docker', + dockerSchema, + inputsSchema, + outputsSchema + ), + forUsing( + 'javascript', + javascriptSchema, + inputsSchema, + outputsSchema + ), + ]), + ||| + ```jsonnet + %(jsonnet)s + ``` + + This can be rendered into a Yaml file like so: + + ```console + jsonnet -S action.jsonnet + ``` + + The output will look like this: + ```yaml + %(output)s + ``` + ||| % { + jsonnet: + std.strReplace( + importstr '../examples/action.jsonnet', + '../main.libsonnet', + 'github.com/crdsonnet/github-actions-libsonnet/main.libsonnet', + ), + output: + std.rstripChars(importstr '../examples/action.output.yaml', '\n'), + } + ); + +tree diff --git a/generator/generate.jsonnet b/generator/generate.jsonnet index 03288fb..23e6a28 100644 --- a/generator/generate.jsonnet +++ b/generator/generate.jsonnet @@ -1,118 +1,7 @@ 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 '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:: {}, - local steps = super.steps, - step: steps + { - // CRDsonnet fix: remove allOf validation as not relevant to the generation process - items: steps.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 actionschema = - (import 'github.com/SchemaStore/schemastore/src/schemas/json/github-action.json') - + { - // rename refs for nicer output - definitions+: { - javascript: self['runs-javascript'], - composite: self['runs-composite'] + { - properties+: { - steps:: {}, - local steps = super.steps, - step: steps, - }, - }, - docker: self['runs-docker'], - }, - properties+: { - runs: { - oneOf: [ - { - '$ref': '#/definitions/javascript', - }, - { - '$ref': '#/definitions/composite', - }, - { - '$ref': '#/definitions/docker', - }, - ], - }, - }, - }; - -local inputsschema = - actionschema.properties.inputs.patternProperties['^[_a-zA-Z][a-zA-Z0-9_-]*$']; -local outputsschema = - actionschema.definitions['outputs-composite'].patternProperties['^[_a-zA-Z][a-zA-Z0-9_-]*$']; - -local processor = crdsonnet.processor.new('ast'); - -local asts = [ - crdsonnet.schema.render('workflow', schema, processor), - crdsonnet.schema.render('job', jobschema, processor), - crdsonnet.schema.render('action', actionschema, processor), - a.object.new([ - a.field.new( - a.id.new('action'), - crdsonnet.schema.render('input', inputsschema, processor) - ), - ]), - a.object.new([ - a.field.new( - a.id.new('action'), - crdsonnet.schema.render('output', outputsschema, processor) - ), - ]), -]; - local docstring = a.object.new([ a.field.new( @@ -122,16 +11,12 @@ local docstring = d.package.new( 'github-actions-libsonnet', 'github.com/crdsonnet/github-actions-libsonnet', - 'Jsonnet library to create GitHub actions workflows.', + 'Jsonnet library to create workflows and actions for GitHub Actions.', 'main.libsonnet', 'main', ) + d.package.withUsageTemplate( - std.strReplace( - importstr '../example.jsonnet', - './main.libsonnet', - '%(import)s', - ) + 'local ga = import "%(import)s"' ) , ' ', '\n' ), @@ -139,11 +24,16 @@ local docstring = ), ]); +local actionTree = import './action.libsonnet'; +local workflowTree = import './workflow.libsonnet'; + '// DO NOT EDIT: generated by generator/generate.jsonnet\n' -+ "{ workflow+: { '#': { help: '', name: 'workflow' } } }\n+ " -+ "{ job+: { '#': { help: '', name: 'job' } } }\n+ " -+ "{ action+: { '#': { help: '', name: 'action' } } }\n+ " -+ "{ action+: { input+: { '#': { help: '', name: 'action' } } } }\n+ " + ( - autils.deepMergeObjects([docstring] + asts) + autils.deepMergeObjects( + [ + docstring, + actionTree, + workflowTree, + ] + ) ).toString() diff --git a/generator/util.libsonnet b/generator/util.libsonnet new file mode 100644 index 0000000..6a0c6ff --- /dev/null +++ b/generator/util.libsonnet @@ -0,0 +1,32 @@ +local a = import 'github.com/crdsonnet/astsonnet/main.libsonnet'; +local autils = import 'github.com/crdsonnet/astsonnet/utils.libsonnet'; +local crdsonnet = import 'github.com/crdsonnet/crdsonnet/crdsonnet/main.libsonnet'; +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + processor: crdsonnet.processor.new('ast'), + + subPackageDocstring(name, help=''): + a.object.new([ + a.field.new( + a.string.new('#'), + a.literal.new( + std.manifestJsonEx( + d.package.newSub(name, help) + , ' ', '' + ), + ), + ), + ]), + + mergeDocstring(name, obj, help=''): + autils.deepMergeObjects([ + a.object.new([ + a.field.new( + a.id.new(name), + self.subPackageDocstring(name, help) + ), + ]), + obj, + ]), +} diff --git a/generator/workflow.libsonnet b/generator/workflow.libsonnet new file mode 100644 index 0000000..b6f6dc0 --- /dev/null +++ b/generator/workflow.libsonnet @@ -0,0 +1,100 @@ +local a = import 'github.com/crdsonnet/astsonnet/main.libsonnet'; +local autils = import 'github.com/crdsonnet/astsonnet/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 util = import './util.libsonnet'; + +local schema = + (import '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:: {}, + local steps = super.steps, + step: steps + { + // CRDsonnet fix: remove allOf validation as not relevant to the generation process + items: steps.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 tree = + util.mergeDocstring( + 'workflow', + autils.deepMergeObjects([ + a.object.new([ + a.field.new( + a.id.new('workflow'), + util.mergeDocstring( + 'job', + crdsonnet.schema.render('job', jobSchema, util.processor), + ), + ), + ]), + crdsonnet.schema.render('workflow', schema, util.processor), + ]), + ||| + ```jsonnet + %(jsonnet)s + ``` + + This can be rendered into a Yaml file like so: + + ```console + jsonnet -S workflow.jsonnet + ``` + + The output will look like this: + ```yaml + %(output)s + ``` + ||| % { + jsonnet: + std.strReplace( + importstr '../examples/workflow.jsonnet', + '../main.libsonnet', + 'github.com/crdsonnet/github-actions-libsonnet/main.libsonnet', + ), + output: + std.rstripChars(importstr '../examples/workflow.output.yaml', '\n'), + }, + ); + +tree diff --git a/main.libsonnet b/main.libsonnet index 6e367f1..8307311 100644 --- a/main.libsonnet +++ b/main.libsonnet @@ -1,34 +1,69 @@ +local util = import './util.libsonnet'; +local d = import './vendor/github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + (import './raw.libsonnet') + { - util: import './util.libsonnet', + workflow+: { + '#new':: + d.func.new( + ||| + `new` initializes a Workflow. + |||, + args=[ + d.arg('name', d.T.string), + ], + ), + new(name): + self.withName(name) + + self.withOn({}) + + self.withJobs({}) + + { manifest():: util.manifestWorkflow(self) }, - job+: { - // The generated code implements a singular 'step' to accomodate for a nicer library. - // The withStep* functions below fix the side effects of this. - // This also ensures language server support works properly. - '#withStep':: {}, - '#withSteps':: super['#withStep'], - withStep: self.withSteps, - withSteps(value): { - steps: - (if std.isArray(value) - then value - else [value]), - }, - '#withStepMixin':: {}, - '#withStepsMixin':: super['#withStepMixin'], - withStepMixin: self.withStepsMixin, - withStepsMixin(value): { - steps+: - (if std.isArray(value) - then value - else [value]), + job+: { + // The generated code implements a singular 'step' to accomodate for a nicer library. + // The withStep* functions below fix the side effects of this. + // This also ensures language server support works properly. + '#withStep':: {}, + '#withSteps':: super['#withStep'], + withStep: self.withSteps, + withSteps(value): { + steps: + (if std.isArray(value) + then value + else [value]), + }, + '#withStepMixin':: {}, + '#withStepsMixin':: super['#withStepMixin'], + withStepMixin: self.withStepsMixin, + withStepsMixin(value): { + steps+: + (if std.isArray(value) + then value + else [value]), + }, }, }, action+: { - runs+: { - composite+: { + composite+: { + '#new':: + d.func.new( + ||| + `new` initializes a Composite action. Use `withSteps()` to add steps. + |||, + args=[ + d.arg('name', d.T.string), + d.arg('description', d.T.string, default='defaults to the name'), + ], + ), + new(name, description=name): + self.withName(name) + + self.withDescription(description) + + self.runs.withUsing() + + self.runs.withSteps([]) + + { manifest():: util.manifestAction(self) }, + + runs+: { // The generated code implements a singular 'step' to accomodate for a nicer library. // The withStep* functions below fix the side effects of this. // This also ensures language server support works properly. @@ -56,5 +91,43 @@ }, }, }, + javascript+: { + '#new':: + d.func.new( + ||| + `new` initializes a Javascript action. + |||, + args=[ + d.arg('name', d.T.string), + d.arg('main', d.T.string), + d.arg('description', d.T.string, default='defaults to the name'), + ], + ), + new(name, main, description=name): + self.withName(name) + + self.withDescription(description) + + self.runs.withUsing() + + self.runs.withMain(main) + + { manifest():: util.manifestAction(self) }, + }, + docker+: { + '#new':: + d.func.new( + ||| + `new` initializes a Composite action. + |||, + args=[ + d.arg('name', d.T.string), + d.arg('image', d.T.string), + d.arg('description', d.T.string, default='defaults to the name'), + ], + ), + new(name, image, description=name): + self.withName(name) + + self.withDescription(description) + + self.runs.withUsing() + + self.runs.withImage(image) + + { manifest():: util.manifestAction(self) }, + }, }, } diff --git a/raw.libsonnet b/raw.libsonnet index 7bd455e..b69a1a4 100644 --- a/raw.libsonnet +++ b/raw.libsonnet @@ -1,1285 +1,1436 @@ // DO NOT EDIT: generated by generator/generate.jsonnet -{ workflow+: { '#': { help: '', name: 'workflow' } } } -+ { job+: { '#': { help: '', name: 'job' } } } -+ { action+: { '#': { help: '', name: 'action' } } } -+ { action+: { input+: { '#': { help: '', name: 'action' } } } } -+ { +{ '#': { 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", + help: 'Jsonnet library to create workflows and actions for GitHub Actions.\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```\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", + usageTemplate: '\n## Usage\n\n```jsonnet\nlocal ga = import "%(import)s"\n```\n', version: 'main', }, - workflow+: + action+: { - '#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+: + '#': { help: "```jsonnet\nlocal ga = import 'github.com/crdsonnet/github-actions-libsonnet/main.libsonnet';\nlocal step = ga.action.composite.runs.step;\n\nlocal exampleAction =\n ga.action.composite.new('example composite action')\n + ga.action.composite.runs.withSteps([\n step.withName('Checkout')\n + step.withUses('actions/checkout@v4'),\n ]);\n\nexampleAction.manifest()\n\n```\n\nThis can be rendered into a Yaml file like so:\n\n```console\njsonnet -S action.jsonnet\n```\n\nThe output will look like this:\n```yaml\nname: \"example composite action\"\ndescription: \"example composite action\"\n\nruns:\n using: \"composite\"\n\n steps:\n - name: \"Checkout\"\n uses: \"actions/checkout@v4\"\n```\n", name: 'action' }, + composite+: { - '#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, - }, + '#': { help: 'Configures the path to the composite action, and the application used to execute the code.', name: 'composite' }, + '#withAuthor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "The name of the action's author." } }, + withAuthor(value): { + author: 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, - }, + '#withBranding': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'You can use a color and Feather icon to create a badge to personalize and distinguish your action. Badges are shown next to your action name in GitHub Marketplace.' } }, + withBranding(value): { + branding: value, }, - 'cancel-in-progress'+: + '#withBrandingMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'You can use a color and Feather icon to create a badge to personalize and distinguish your action. Badges are shown next to your action name in GitHub Marketplace.' } }, + withBrandingMixin(value): { + branding+: value, + }, + branding+: { - '#withExpressionSyntax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, - withExpressionSyntax(value): { - concurrency+: { - 'cancel-in-progress'+: { - expressionSyntax: value, - }, + '#withColor': { 'function': { args: [{ default: null, enums: ['white', 'black', 'yellow', 'blue', 'green', 'orange', 'red', 'purple', 'gray-dark'], name: 'value', type: ['string'] }], help: 'The background color of the badge.' } }, + withColor(value): { + branding+: { + color: value, + }, + }, + '#withIcon': { 'function': { args: [{ default: null, enums: ['activity', 'airplay', 'alert-circle', 'alert-octagon', 'alert-triangle', 'align-center', 'align-justify', 'align-left', 'align-right', 'anchor', 'aperture', 'archive', 'arrow-down-circle', 'arrow-down-left', 'arrow-down-right', 'arrow-down', 'arrow-left-circle', 'arrow-left', 'arrow-right-circle', 'arrow-right', 'arrow-up-circle', 'arrow-up-left', 'arrow-up-right', 'arrow-up', 'at-sign', 'award', 'bar-chart-2', 'bar-chart', 'battery-charging', 'battery', 'bell-off', 'bell', 'bluetooth', 'bold', 'book-open', 'book', 'bookmark', 'box', 'briefcase', 'calendar', 'camera-off', 'camera', 'cast', 'check-circle', 'check-square', 'check', 'chevron-down', 'chevron-left', 'chevron-right', 'chevron-up', 'chevrons-down', 'chevrons-left', 'chevrons-right', 'chevrons-up', 'circle', 'clipboard', 'clock', 'cloud-drizzle', 'cloud-lightning', 'cloud-off', 'cloud-rain', 'cloud-snow', 'cloud', 'code', 'command', 'compass', 'copy', 'corner-down-left', 'corner-down-right', 'corner-left-down', 'corner-left-up', 'corner-right-down', 'corner-right-up', 'corner-up-left', 'corner-up-right', 'cpu', 'credit-card', 'crop', 'crosshair', 'database', 'delete', 'disc', 'dollar-sign', 'download-cloud', 'download', 'droplet', 'edit-2', 'edit-3', 'edit', 'external-link', 'eye-off', 'eye', 'fast-forward', 'feather', 'file-minus', 'file-plus', 'file-text', 'file', 'film', 'filter', 'flag', 'folder-minus', 'folder-plus', 'folder', 'gift', 'git-branch', 'git-commit', 'git-merge', 'git-pull-request', 'globe', 'grid', 'hard-drive', 'hash', 'headphones', 'heart', 'help-circle', 'home', 'image', 'inbox', 'info', 'italic', 'layers', 'layout', 'life-buoy', 'link-2', 'link', 'list', 'loader', 'lock', 'log-in', 'log-out', 'mail', 'map-pin', 'map', 'maximize-2', 'maximize', 'menu', 'message-circle', 'message-square', 'mic-off', 'mic', 'minimize-2', 'minimize', 'minus-circle', 'minus-square', 'minus', 'monitor', 'moon', 'more-horizontal', 'more-vertical', 'move', 'music', 'navigation-2', 'navigation', 'octagon', 'package', 'paperclip', 'pause-circle', 'pause', 'percent', 'phone-call', 'phone-forwarded', 'phone-incoming', 'phone-missed', 'phone-off', 'phone-outgoing', 'phone', 'pie-chart', 'play-circle', 'play', 'plus-circle', 'plus-square', 'plus', 'pocket', 'power', 'printer', 'radio', 'refresh-ccw', 'refresh-cw', 'repeat', 'rewind', 'rotate-ccw', 'rotate-cw', 'rss', 'save', 'scissors', 'search', 'send', 'server', 'settings', 'share-2', 'share', 'shield-off', 'shield', 'shopping-bag', 'shopping-cart', 'shuffle', 'sidebar', 'skip-back', 'skip-forward', 'slash', 'sliders', 'smartphone', 'speaker', 'square', 'star', 'stop-circle', 'sun', 'sunrise', 'sunset', 'table', 'tablet', 'tag', 'target', 'terminal', 'thermometer', 'thumbs-down', 'thumbs-up', 'toggle-left', 'toggle-right', 'trash-2', 'trash', 'trending-down', 'trending-up', 'triangle', 'truck', 'tv', 'type', 'umbrella', 'underline', 'unlock', 'upload-cloud', 'upload', 'user-check', 'user-minus', 'user-plus', 'user-x', 'user', 'users', 'video-off', 'video', 'voicemail', 'volume-1', 'volume-2', 'volume-x', 'volume', 'watch', 'wifi-off', 'wifi', 'wind', 'x-circle', 'x-square', 'x', 'zap-off', 'zap', 'zoom-in', 'zoom-out'], name: 'value', type: ['string'] }], help: 'The name of the Feather icon to use.' } }, + withIcon(value): { + branding+: { + icon: 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, - }, + '#withDescription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A short description of the action.' } }, + withDescription(value): { + description: 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, - }, + '#withInputs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Input parameters allow you to specify data that the action expects to use during runtime. GitHub stores input parameters as environment variables. Input ids with uppercase letters are converted to lowercase during runtime. We recommended using lowercase input ids.' } }, + withInputs(value): { + inputs: value, }, - '#withRunMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, - withRunMixin(value): { - defaults+: { - run+: value, - }, + '#withInputsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Input parameters allow you to specify data that the action expects to use during runtime. GitHub stores input parameters as environment variables. Input ids with uppercase letters are converted to lowercase during runtime. We recommended using lowercase input ids.' } }, + withInputsMixin(value): { + inputs+: value, }, - run+: + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The name of your action. GitHub displays the `name` in the Actions tab to help visually identify actions in each job.' } }, + withName(value): { + name: value, + }, + '#withOutputs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "Output parameters allow you to declare data that an action sets. Actions that run later in a workflow can use the output data set in previously run actions. For example, if you had an action that performed the addition of two inputs (x + y = z), the action could output the sum (z) for other actions to use as an input.\nIf you don't declare an output in your action metadata file, you can still set outputs and use them in a workflow." } }, + withOutputs(value): { + outputs: value, + }, + '#withOutputsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "Output parameters allow you to declare data that an action sets. Actions that run later in a workflow can use the output data set in previously run actions. For example, if you had an action that performed the addition of two inputs (x + y = z), the action could output the sum (z) for other actions to use as an input.\nIf you don't declare an output in your action metadata file, you can still set outputs and use them in a workflow." } }, + withOutputsMixin(value): { + outputs+: value, + }, + '#withRuns': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Configures the path to the composite action, and the application used to execute the code.' } }, + withRuns(value): { + runs: value, + }, + '#withRunsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Configures the path to the composite action, and the application used to execute the code.' } }, + withRunsMixin(value): { + runs+: value, + }, + runs+: { - '#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, - }, + '#withStep': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'The run steps that you plan to run in this action.' } }, + withStep(value): { + runs+: { + step: + (if std.isArray(value) + then value + else [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, - }, + '#withStepMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'The run steps that you plan to run in this action.' } }, + withStepMixin(value): { + runs+: { + step+: + (if std.isArray(value) + then value + else [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+: { + step+: + { + '#': { help: '', name: 'step' }, + '#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: 'Sets a map of environment variables for only that step.' } }, + withEnv(value): { + env: value, + }, + '#withEnvMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object', 'string'] }], help: 'Sets a map of environment variables for only that step.' } }, + 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.' } }, + withId(value): { + id: value, + }, + '#withIf': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['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: 'The name of the composite run step.' } }, + withName(value): { + name: value, + }, + '#withRun': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The command you want to run. This can be inline or a script in your action repository.' } }, + withRun(value): { + run: value, + }, + '#withShell': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The shell where you want to run the command.' } }, + withShell(value): { + shell: 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.' } }, + withUses(value): { + uses: value, + }, + '#withWith': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'A map of the input parameters defined by the action. Each input parameter is a key/value pair. Input parameters are set as environment variables. The variable is prefixed with INPUT_ and converted to upper case.' } }, + withWith(value): { + with: value, + }, + '#withWithMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'A map of the input parameters defined by the action. Each input parameter is a key/value pair. Input parameters are set as environment variables. The variable is prefixed with INPUT_ and converted to upper case.' } }, + withWithMixin(value): { + with+: value, + }, + '#withWorkingDirectory': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specifies the working directory where the command is run.' } }, + withWorkingDirectory(value): { 'working-directory': value, }, }, + '#withUsing': { 'function': { args: [], help: "To use a composite run steps action, set this to 'composite'." } }, + withUsing(): { + runs+: { + using: 'composite', + }, }, }, - }, - '#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, + input+: + { + '#': { help: '', name: 'input' }, + '#withDefault': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "A string representing the default value. The default value is used when an input parameter isn't specified in a workflow file." } }, + withDefault(value): { + default: value, + }, + '#withDeprecationMessage': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A string shown to users using the deprecated input.' } }, + withDeprecationMessage(value): { + deprecationMessage: value, + }, + '#withDescription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A string description of the input parameter.' } }, + withDescription(value): { + description: value, + }, + '#withRequired': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'A boolean to indicate whether the action requires the input parameter. Set to `true` when the parameter is required.' } }, + withRequired(value=true): { + required: value, + }, + }, + output+: + { + '#': { help: '', name: 'output' }, + '#withDescription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A string description of the output parameter.' } }, + withDescription(value): { + description: value, + }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The value that the output parameter will be mapped to. You can set this to a string or an expression with context. For example, you can use the steps context to set the value of an output to the output value of a step.' } }, + withValue(value): { + value: 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+: + docker+: { - '#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, - }, + '#': { help: 'Configures the image used for the Docker action.', name: 'docker' }, + '#withAuthor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "The name of the action's author." } }, + withAuthor(value): { + author: 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, - }, + '#withBranding': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'You can use a color and Feather icon to create a badge to personalize and distinguish your action. Badges are shown next to your action name in GitHub Marketplace.' } }, + withBranding(value): { + branding: 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, - }, + '#withBrandingMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'You can use a color and Feather icon to create a badge to personalize and distinguish your action. Badges are shown next to your action name in GitHub Marketplace.' } }, + withBrandingMixin(value): { + branding+: value, }, - branch_protection_rule+: + branding+: { - '#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]), - }, + '#withColor': { 'function': { args: [{ default: null, enums: ['white', 'black', 'yellow', 'blue', 'green', 'orange', 'red', 'purple', 'gray-dark'], name: 'value', type: ['string'] }], help: 'The background color of the badge.' } }, + withColor(value): { + branding+: { + color: 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]), - }, + '#withIcon': { 'function': { args: [{ default: null, enums: ['activity', 'airplay', 'alert-circle', 'alert-octagon', 'alert-triangle', 'align-center', 'align-justify', 'align-left', 'align-right', 'anchor', 'aperture', 'archive', 'arrow-down-circle', 'arrow-down-left', 'arrow-down-right', 'arrow-down', 'arrow-left-circle', 'arrow-left', 'arrow-right-circle', 'arrow-right', 'arrow-up-circle', 'arrow-up-left', 'arrow-up-right', 'arrow-up', 'at-sign', 'award', 'bar-chart-2', 'bar-chart', 'battery-charging', 'battery', 'bell-off', 'bell', 'bluetooth', 'bold', 'book-open', 'book', 'bookmark', 'box', 'briefcase', 'calendar', 'camera-off', 'camera', 'cast', 'check-circle', 'check-square', 'check', 'chevron-down', 'chevron-left', 'chevron-right', 'chevron-up', 'chevrons-down', 'chevrons-left', 'chevrons-right', 'chevrons-up', 'circle', 'clipboard', 'clock', 'cloud-drizzle', 'cloud-lightning', 'cloud-off', 'cloud-rain', 'cloud-snow', 'cloud', 'code', 'command', 'compass', 'copy', 'corner-down-left', 'corner-down-right', 'corner-left-down', 'corner-left-up', 'corner-right-down', 'corner-right-up', 'corner-up-left', 'corner-up-right', 'cpu', 'credit-card', 'crop', 'crosshair', 'database', 'delete', 'disc', 'dollar-sign', 'download-cloud', 'download', 'droplet', 'edit-2', 'edit-3', 'edit', 'external-link', 'eye-off', 'eye', 'fast-forward', 'feather', 'file-minus', 'file-plus', 'file-text', 'file', 'film', 'filter', 'flag', 'folder-minus', 'folder-plus', 'folder', 'gift', 'git-branch', 'git-commit', 'git-merge', 'git-pull-request', 'globe', 'grid', 'hard-drive', 'hash', 'headphones', 'heart', 'help-circle', 'home', 'image', 'inbox', 'info', 'italic', 'layers', 'layout', 'life-buoy', 'link-2', 'link', 'list', 'loader', 'lock', 'log-in', 'log-out', 'mail', 'map-pin', 'map', 'maximize-2', 'maximize', 'menu', 'message-circle', 'message-square', 'mic-off', 'mic', 'minimize-2', 'minimize', 'minus-circle', 'minus-square', 'minus', 'monitor', 'moon', 'more-horizontal', 'more-vertical', 'move', 'music', 'navigation-2', 'navigation', 'octagon', 'package', 'paperclip', 'pause-circle', 'pause', 'percent', 'phone-call', 'phone-forwarded', 'phone-incoming', 'phone-missed', 'phone-off', 'phone-outgoing', 'phone', 'pie-chart', 'play-circle', 'play', 'plus-circle', 'plus-square', 'plus', 'pocket', 'power', 'printer', 'radio', 'refresh-ccw', 'refresh-cw', 'repeat', 'rewind', 'rotate-ccw', 'rotate-cw', 'rss', 'save', 'scissors', 'search', 'send', 'server', 'settings', 'share-2', 'share', 'shield-off', 'shield', 'shopping-bag', 'shopping-cart', 'shuffle', 'sidebar', 'skip-back', 'skip-forward', 'slash', 'sliders', 'smartphone', 'speaker', 'square', 'star', 'stop-circle', 'sun', 'sunrise', 'sunset', 'table', 'tablet', 'tag', 'target', 'terminal', 'thermometer', 'thumbs-down', 'thumbs-up', 'toggle-left', 'toggle-right', 'trash-2', 'trash', 'trending-down', 'trending-up', 'triangle', 'truck', 'tv', 'type', 'umbrella', 'underline', 'unlock', 'upload-cloud', 'upload', 'user-check', 'user-minus', 'user-plus', 'user-x', 'user', 'users', 'video-off', 'video', 'voicemail', 'volume-1', 'volume-2', 'volume-x', 'volume', 'watch', 'wifi-off', 'wifi', 'wind', 'x-circle', 'x-square', 'x', 'zap-off', 'zap', 'zoom-in', 'zoom-out'], name: 'value', type: ['string'] }], help: 'The name of the Feather icon to use.' } }, + withIcon(value): { + branding+: { + icon: 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, - }, + '#withDescription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A short description of the action.' } }, + withDescription(value): { + description: 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, - }, + '#withInputs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Input parameters allow you to specify data that the action expects to use during runtime. GitHub stores input parameters as environment variables. Input ids with uppercase letters are converted to lowercase during runtime. We recommended using lowercase input ids.' } }, + withInputs(value): { + inputs: value, }, - check_run+: + '#withInputsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Input parameters allow you to specify data that the action expects to use during runtime. GitHub stores input parameters as environment variables. Input ids with uppercase letters are converted to lowercase during runtime. We recommended using lowercase input ids.' } }, + withInputsMixin(value): { + inputs+: value, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The name of your action. GitHub displays the `name` in the Actions tab to help visually identify actions in each job.' } }, + withName(value): { + name: value, + }, + '#withOutputs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "Output parameters allow you to declare data that an action sets. Actions that run later in a workflow can use the output data set in previously run actions. For example, if you had an action that performed the addition of two inputs (x + y = z), the action could output the sum (z) for other actions to use as an input.\nIf you don't declare an output in your action metadata file, you can still set outputs and use them in a workflow." } }, + withOutputs(value): { + outputs: value, + }, + '#withOutputsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "Output parameters allow you to declare data that an action sets. Actions that run later in a workflow can use the output data set in previously run actions. For example, if you had an action that performed the addition of two inputs (x + y = z), the action could output the sum (z) for other actions to use as an input.\nIf you don't declare an output in your action metadata file, you can still set outputs and use them in a workflow." } }, + withOutputsMixin(value): { + outputs+: value, + }, + '#withRuns': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Configures the image used for the Docker action.' } }, + withRuns(value): { + runs: value, + }, + '#withRunsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Configures the image used for the Docker action.' } }, + withRunsMixin(value): { + runs+: value, + }, + runs+: { - '#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]), - }, + '#withArgs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: "An array of strings that define the inputs for a Docker container. Inputs can include hardcoded strings. GitHub passes the `args` to the container's `ENTRYPOINT` when the container starts up.\nThe `args` are used in place of the `CMD` instruction in a `Dockerfile`. If you use `CMD` in your `Dockerfile`, use the guidelines ordered by preference:\n- Document required arguments in the action's README and omit them from the `CMD` instruction.\n- Use defaults that allow using the action without specifying any `args`.\n- If the action exposes a `--help` flag, or something similar, use that to make your action self-documenting." } }, + withArgs(value): { + runs+: { + args: + (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]), + '#withArgsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: "An array of strings that define the inputs for a Docker container. Inputs can include hardcoded strings. GitHub passes the `args` to the container's `ENTRYPOINT` when the container starts up.\nThe `args` are used in place of the `CMD` instruction in a `Dockerfile`. If you use `CMD` in your `Dockerfile`, use the guidelines ordered by preference:\n- Document required arguments in the action's README and omit them from the `CMD` instruction.\n- Use defaults that allow using the action without specifying any `args`.\n- If the action exposes a `--help` flag, or something similar, use that to make your action self-documenting." } }, + withArgsMixin(value): { + runs+: { + args+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withEntrypoint': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "Overrides the Docker `ENTRYPOINT` in the `Dockerfile`, or sets it if one wasn't already specified. Use `entrypoint` when the `Dockerfile` does not specify an `ENTRYPOINT` or you want to override the `ENTRYPOINT` instruction. If you omit `entrypoint`, the commands you specify in the Docker `ENTRYPOINT` instruction will execute. The Docker `ENTRYPOINT instruction has a *shell* form and *exec* form. The Docker `ENTRYPOINT` documentation recommends using the *exec* form of the `ENTRYPOINT` instruction." } }, + withEntrypoint(value): { + runs+: { + entrypoint: value, + }, + }, + '#withEnv': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object', 'string'] }], help: 'Specifies a key/value map of environment variables to set in the container environment.' } }, + withEnv(value): { + runs+: { + env: value, + }, + }, + '#withEnvMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object', 'string'] }], help: 'Specifies a key/value map of environment variables to set in the container environment.' } }, + withEnvMixin(value): { + runs+: { + env+: value, + }, + }, + env+: + { + '#withStringContainingExpressionSyntax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withStringContainingExpressionSyntax(value): { + runs+: { + 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 base image name, a local `Dockerfile` in your repository, or a public image in Docker Hub or another registry. To reference a `Dockerfile` local to your repository, use a path relative to your action metadata file. The `docker` application will execute this file.' } }, + withImage(value): { + runs+: { + image: value, + }, + }, + '#withPostEntrypoint': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Allows you to run a cleanup script once the `runs.entrypoint` action has completed. GitHub Actions uses `docker run` to launch this action. Because GitHub Actions runs the script inside a new container using the same base image, the runtime state is different from the main `entrypoint` container. You can access any state you need in either the workspace, `HOME`, or as a `STATE_` variable. The `post-entrypoint:` action always runs by default but you can override this using `post-if`.' } }, + withPostEntrypoint(value): { + runs+: { + 'post-entrypoint': value, + }, + }, + '#withPostIf': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Allows you to define conditions for the `post:` action execution. The `post:` action will only run if the conditions in `post-if` are met. If not set, then `post-if` defaults to `always()`.' } }, + withPostIf(value): { + runs+: { + 'post-if': value, + }, + }, + '#withPreEntrypoint': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Allows you to run a script before the `entrypoint` action begins. For example, you can use `pre-entrypoint:` to run a prerequisite setup script. GitHub Actions uses `docker run` to launch this action, and runs the script inside a new container that uses the same base image. This means that the runtime state is different from the main `entrypoint` container, and any states you require must be accessed in either the workspace, `HOME`, or as a `STATE_` variable. The `pre-entrypoint:` action always runs by default but you can override this using `pre-if`.' } }, + withPreEntrypoint(value): { + runs+: { + 'pre-entrypoint': value, + }, + }, + '#withPreIf': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Allows you to define conditions for the `pre:` action execution. The `pre:` action will only run if the conditions in `pre-if` are met. If not set, then `pre-if` defaults to `always()`. Note that the `step` context is unavailable, as no steps have run yet.' } }, + withPreIf(value): { + runs+: { + 'pre-if': value, + }, + }, + '#withUsing': { 'function': { args: [], help: "You must set this value to 'docker'." } }, + withUsing(): { + runs+: { + using: 'docker', + }, }, }, - '#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, + input+: + { + '#': { help: '', name: 'input' }, + '#withDefault': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "A string representing the default value. The default value is used when an input parameter isn't specified in a workflow file." } }, + withDefault(value): { + default: value, + }, + '#withDeprecationMessage': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A string shown to users using the deprecated input.' } }, + withDeprecationMessage(value): { + deprecationMessage: value, + }, + '#withDescription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A string description of the input parameter.' } }, + withDescription(value): { + description: value, + }, + '#withRequired': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'A boolean to indicate whether the action requires the input parameter. Set to `true` when the parameter is required.' } }, + withRequired(value=true): { + required: 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, + output+: + { + '#': { help: '', name: 'output' }, + '#withDescription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A string description of the output parameter.' } }, + withDescription(value): { + description: value, + }, }, + }, + javascript+: + { + '#': { help: "Configures the path to the action's code and the application used to execute the code.", name: 'javascript' }, + '#withAuthor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "The name of the action's author." } }, + withAuthor(value): { + author: value, }, - check_suite+: + '#withBranding': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'You can use a color and Feather icon to create a badge to personalize and distinguish your action. Badges are shown next to your action name in GitHub Marketplace.' } }, + withBranding(value): { + branding: value, + }, + '#withBrandingMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'You can use a color and Feather icon to create a badge to personalize and distinguish your action. Badges are shown next to your action name in GitHub Marketplace.' } }, + withBrandingMixin(value): { + branding+: value, + }, + branding+: { - '#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]), - }, + '#withColor': { 'function': { args: [{ default: null, enums: ['white', 'black', 'yellow', 'blue', 'green', 'orange', 'red', 'purple', 'gray-dark'], name: 'value', type: ['string'] }], help: 'The background color of the badge.' } }, + withColor(value): { + branding+: { + color: 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]), - }, + '#withIcon': { 'function': { args: [{ default: null, enums: ['activity', 'airplay', 'alert-circle', 'alert-octagon', 'alert-triangle', 'align-center', 'align-justify', 'align-left', 'align-right', 'anchor', 'aperture', 'archive', 'arrow-down-circle', 'arrow-down-left', 'arrow-down-right', 'arrow-down', 'arrow-left-circle', 'arrow-left', 'arrow-right-circle', 'arrow-right', 'arrow-up-circle', 'arrow-up-left', 'arrow-up-right', 'arrow-up', 'at-sign', 'award', 'bar-chart-2', 'bar-chart', 'battery-charging', 'battery', 'bell-off', 'bell', 'bluetooth', 'bold', 'book-open', 'book', 'bookmark', 'box', 'briefcase', 'calendar', 'camera-off', 'camera', 'cast', 'check-circle', 'check-square', 'check', 'chevron-down', 'chevron-left', 'chevron-right', 'chevron-up', 'chevrons-down', 'chevrons-left', 'chevrons-right', 'chevrons-up', 'circle', 'clipboard', 'clock', 'cloud-drizzle', 'cloud-lightning', 'cloud-off', 'cloud-rain', 'cloud-snow', 'cloud', 'code', 'command', 'compass', 'copy', 'corner-down-left', 'corner-down-right', 'corner-left-down', 'corner-left-up', 'corner-right-down', 'corner-right-up', 'corner-up-left', 'corner-up-right', 'cpu', 'credit-card', 'crop', 'crosshair', 'database', 'delete', 'disc', 'dollar-sign', 'download-cloud', 'download', 'droplet', 'edit-2', 'edit-3', 'edit', 'external-link', 'eye-off', 'eye', 'fast-forward', 'feather', 'file-minus', 'file-plus', 'file-text', 'file', 'film', 'filter', 'flag', 'folder-minus', 'folder-plus', 'folder', 'gift', 'git-branch', 'git-commit', 'git-merge', 'git-pull-request', 'globe', 'grid', 'hard-drive', 'hash', 'headphones', 'heart', 'help-circle', 'home', 'image', 'inbox', 'info', 'italic', 'layers', 'layout', 'life-buoy', 'link-2', 'link', 'list', 'loader', 'lock', 'log-in', 'log-out', 'mail', 'map-pin', 'map', 'maximize-2', 'maximize', 'menu', 'message-circle', 'message-square', 'mic-off', 'mic', 'minimize-2', 'minimize', 'minus-circle', 'minus-square', 'minus', 'monitor', 'moon', 'more-horizontal', 'more-vertical', 'move', 'music', 'navigation-2', 'navigation', 'octagon', 'package', 'paperclip', 'pause-circle', 'pause', 'percent', 'phone-call', 'phone-forwarded', 'phone-incoming', 'phone-missed', 'phone-off', 'phone-outgoing', 'phone', 'pie-chart', 'play-circle', 'play', 'plus-circle', 'plus-square', 'plus', 'pocket', 'power', 'printer', 'radio', 'refresh-ccw', 'refresh-cw', 'repeat', 'rewind', 'rotate-ccw', 'rotate-cw', 'rss', 'save', 'scissors', 'search', 'send', 'server', 'settings', 'share-2', 'share', 'shield-off', 'shield', 'shopping-bag', 'shopping-cart', 'shuffle', 'sidebar', 'skip-back', 'skip-forward', 'slash', 'sliders', 'smartphone', 'speaker', 'square', 'star', 'stop-circle', 'sun', 'sunrise', 'sunset', 'table', 'tablet', 'tag', 'target', 'terminal', 'thermometer', 'thumbs-down', 'thumbs-up', 'toggle-left', 'toggle-right', 'trash-2', 'trash', 'trending-down', 'trending-up', 'triangle', 'truck', 'tv', 'type', 'umbrella', 'underline', 'unlock', 'upload-cloud', 'upload', 'user-check', 'user-minus', 'user-plus', 'user-x', 'user', 'users', 'video-off', 'video', 'voicemail', 'volume-1', 'volume-2', 'volume-x', 'volume', 'watch', 'wifi-off', 'wifi', 'wind', 'x-circle', 'x-square', 'x', 'zap-off', 'zap', 'zoom-in', 'zoom-out'], name: 'value', type: ['string'] }], help: 'The name of the Feather icon to use.' } }, + withIcon(value): { + branding+: { + icon: 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, - }, + '#withDescription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A short description of the action.' } }, + withDescription(value): { + description: 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, - }, + '#withInputs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Input parameters allow you to specify data that the action expects to use during runtime. GitHub stores input parameters as environment variables. Input ids with uppercase letters are converted to lowercase during runtime. We recommended using lowercase input ids.' } }, + withInputs(value): { + inputs: 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, - }, + '#withInputsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Input parameters allow you to specify data that the action expects to use during runtime. GitHub stores input parameters as environment variables. Input ids with uppercase letters are converted to lowercase during runtime. We recommended using lowercase input ids.' } }, + withInputsMixin(value): { + inputs+: 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, - }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The name of your action. GitHub displays the `name` in the Actions tab to help visually identify actions in each job.' } }, + withName(value): { + name: 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, - }, + '#withOutputs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "Output parameters allow you to declare data that an action sets. Actions that run later in a workflow can use the output data set in previously run actions. For example, if you had an action that performed the addition of two inputs (x + y = z), the action could output the sum (z) for other actions to use as an input.\nIf you don't declare an output in your action metadata file, you can still set outputs and use them in a workflow." } }, + withOutputs(value): { + outputs: 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, - }, + '#withOutputsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "Output parameters allow you to declare data that an action sets. Actions that run later in a workflow can use the output data set in previously run actions. For example, if you had an action that performed the addition of two inputs (x + y = z), the action could output the sum (z) for other actions to use as an input.\nIf you don't declare an output in your action metadata file, you can still set outputs and use them in a workflow." } }, + withOutputsMixin(value): { + outputs+: 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, - }, + '#withRuns': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "Configures the path to the action's code and the application used to execute the code." } }, + withRuns(value): { + runs: 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, - }, + '#withRunsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "Configures the path to the action's code and the application used to execute the code." } }, + withRunsMixin(value): { + runs+: value, }, - discussion+: + runs+: { - '#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]), - }, + '#withMain': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The file that contains your action code. The application specified in `using` executes this file.' } }, + withMain(value): { + runs+: { + main: 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]), - }, + '#withPost': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Allows you to run a script at the end of a job, once the `main:` action has completed. For example, you can use `post:` to terminate certain processes or remove unneeded files. The application specified with the `using` syntax will execute this file. The `post:` action always runs by default but you can override this using `post-if`.' } }, + withPost(value): { + runs+: { + post: 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]), - }, + '#withPostIf': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Allows you to define conditions for the `post:` action execution. The `post:` action will only run if the conditions in `post-if` are met. If not set, then `post-if` defaults to `always()`.' } }, + withPostIf(value): { + runs+: { + 'post-if': 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]), - }, + '#withPre': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Allows you to run a script at the start of a job, before the `main:` action begins. For example, you can use `pre:` to run a prerequisite setup script. The application specified with the `using` syntax will execute this file. The `pre:` action always runs by default but you can override this using `pre-if`.' } }, + withPre(value): { + runs+: { + pre: 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]), - }, + '#withPreIf': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Allows you to define conditions for the `pre:` action execution. The `pre:` action will only run if the conditions in `pre-if` are met. If not set, then `pre-if` defaults to `always()`. Note that the `step` context is unavailable, as no steps have run yet.' } }, + withPreIf(value): { + runs+: { + 'pre-if': 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]), - }, + '#withUsing': { 'function': { args: [{ default: null, enums: ['node12', 'node16', 'node20'], name: 'value', type: ['string'] }], help: 'The application used to execute the code specified in `main`.' } }, + withUsing(value): { + runs+: { + using: 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+: + input+: { - '#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]), - }, - }, + '#': { help: '', name: 'input' }, + '#withDefault': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "A string representing the default value. The default value is used when an input parameter isn't specified in a workflow file." } }, + withDefault(value): { + default: 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]), - }, - }, + '#withDeprecationMessage': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A string shown to users using the deprecated input.' } }, + withDeprecationMessage(value): { + deprecationMessage: 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]), - }, - }, + '#withDescription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A string description of the input parameter.' } }, + withDescription(value): { + description: 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]), - }, - }, + '#withRequired': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'A boolean to indicate whether the action requires the input parameter. Set to `true` when the parameter is required.' } }, + withRequired(value=true): { + required: 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, + output+: + { + '#': { help: '', name: 'output' }, + '#withDescription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A string description of the output parameter.' } }, + withDescription(value): { + description: value, + }, }, + }, + }, + workflow+: + { + '#': { help: "```jsonnet\nlocal ga = import 'github.com/crdsonnet/github-actions-libsonnet/main.libsonnet';\nlocal job = ga.workflow.job;\n\nlocal exampleWorkflow =\n ga.workflow.new('example workflow')\n + ga.workflow.on.pull_request.withBranches(['main'])\n + ga.workflow.withJobs({\n example:\n job.withRunsOn('ubuntu-latest')\n + job.withSteps([\n job.step.withName('Checkout')\n + job.step.withUses('actions/checkout@v4'),\n ]),\n });\n\nexampleWorkflow.manifest()\n\n```\n\nThis can be rendered into a Yaml file like so:\n\n```console\njsonnet -S workflow.jsonnet\n```\n\nThe output will look like this:\n```yaml\nname: \"example workflow\"\n\non:\n pull_request:\n branches:\n - \"main\"\n\njobs:\n example:\n runs-on: \"ubuntu-latest\"\n steps:\n - name: \"Checkout\"\n uses: \"actions/checkout@v4\"\n```\n", name: 'workflow' }, + job+: + { + '#': { help: '', name: '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, }, - '#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, - }, + '#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, }, - merge_group+: + concurrency+: { - '#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]), - }, + '#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, }, }, - '#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]), - }, + '#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, }, }, - }, - '#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]), + 'cancel-in-progress'+: + { + '#withExpressionSyntax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withExpressionSyntax(value): { + concurrency+: { + 'cancel-in-progress'+: { + expressionSyntax: 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]), - }, + '#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, }, }, }, - '#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, - }, + '#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, }, - '#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, - }, + '#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, }, - project+: + container+: { - '#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]), + '#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, }, }, - '#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]), - }, + '#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, }, }, - }, - '#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]), + 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, + }, }, - '#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]), - }, + '#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, }, }, - }, - '#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]), + 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, + }, }, - '#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]), - }, + '#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]), }, }, }, - '#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, - }, + '#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, }, - '#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, - }, + '#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, }, - '#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, + '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, }, - '#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, - }, + '#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, }, - pull_request+: + defaults+: { - '#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]), - }, + '#withRun': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withRun(value): { + defaults+: { + run: 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]), - }, + '#withRunMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withRunMixin(value): { + defaults+: { + run+: 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]), + 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, + }, }, - '#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]), + }, + '#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, }, }, - '#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]), - }, + }, + '#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, }, }, - '#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]), - }, + '#withAttestations': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, + withAttestations(value): { + permissions+: { + attestations: 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]), - }, + '#withChecks': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, + withChecks(value): { + permissions+: { + checks: 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]), - }, + '#withContents': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, + withContents(value): { + permissions+: { + contents: 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]), - }, + '#withDeployments': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, + withDeployments(value): { + permissions+: { + deployments: 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]), - }, + '#withDiscussions': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, + withDiscussions(value): { + permissions+: { + discussions: 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]), - }, + '#withIdToken': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, + withIdToken(value): { + permissions+: { + 'id-token': 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]), - }, + '#withIssues': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, + withIssues(value): { + permissions+: { + issues: 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]), - }, + '#withPackages': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, + withPackages(value): { + permissions+: { + packages: 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]), - }, + '#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, }, }, }, - '#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, - }, + '#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, }, - '#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, - }, + '#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, }, - pull_request_review+: + 'runs-on'+: { - '#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]), - }, + '#withGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withGroup(value): { + 'runs-on'+: { + group: 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]), - }, + '#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, }, }, }, - '#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, - }, + '#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, }, - '#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, - }, + '#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, }, - pull_request_review_comment+: + '#withStep': { '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' } }, + withStep(value): { + step: + (if std.isArray(value) + then value + else [value]), + }, + '#withStepMixin': { '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' } }, + withStepMixin(value): { + step+: + (if std.isArray(value) + then value + else [value]), + }, + step+: { - '#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]), + '#': { help: '', name: 'step' }, + '#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, }, - '#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]), - }, - }, + '#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, }, - }, - '#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]), + 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, }, - '#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]), - }, - }, + '#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, }, - '#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]), - }, - }, + '#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, }, - '#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]), - }, - }, + '#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, }, - '#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]), - }, - }, + '#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, }, - '#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]), - }, - }, + '#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, }, - '#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]), - }, - }, + '#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, }, - '#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]), + '#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, }, - '#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]), + '#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, }, - '#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]), - }, + }, + '#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, }, }, - '#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]), - }, + '#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, }, }, - '#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]), - }, + '#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, }, }, - '#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]), + 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, + }, }, - '#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]), - }, + }, + '#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, }, }, }, - '#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, + }, + '#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, }, }, - '#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, + '#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, }, }, - push+: + 'cancel-in-progress'+: { - '#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]), + '#withExpressionSyntax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withExpressionSyntax(value): { + concurrency+: { + 'cancel-in-progress'+: { + expressionSyntax: 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]), + }, + '#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, }, }, }, - '#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]), + '#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, }, }, }, - '#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]), + '#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, }, }, }, - '#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): { + }, + }, + '#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+: { - push+: { - 'tags-ignore': + branch_protection_rule+: { + types: (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): { + '#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+: { - push+: { - 'tags-ignore'+: + branch_protection_rule+: { + types+: (if std.isArray(value) then value else [value]), @@ -1287,24 +1438,24 @@ }, }, }, - '#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): { + '#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+: { - registry_package: value, + check_run: 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): { + '#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+: { - registry_package+: value, + check_run+: value, }, }, - registry_package+: + check_run+: { - '#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': { '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+: { - registry_package+: { + check_run+: { types: (if std.isArray(value) then value @@ -1312,10 +1463,10 @@ }, }, }, - '#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': { '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+: { - registry_package+: { + check_run+: { types+: (if std.isArray(value) then value @@ -1324,24 +1475,24 @@ }, }, }, - '#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): { + '#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+: { - release: value, + check_suite: 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): { + '#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+: { - release+: value, + check_suite+: value, }, }, - release+: + check_suite+: { - '#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': { '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+: { - release+: { + check_suite+: { types: (if std.isArray(value) then value @@ -1349,10 +1500,10 @@ }, }, }, - '#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': { '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+: { - release+: { + check_suite+: { types+: (if std.isArray(value) then value @@ -1361,90 +1512,72 @@ }, }, }, - '#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): { + '#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+: { - repository_dispatch: value, + create: 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): { + '#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+: { - repository_dispatch+: value, + create+: 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): { + '#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+: { - status: value, + delete: 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): { + '#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+: { - status+: value, + delete+: 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): { + '#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+: { - watch: value, + deployment: 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): { + '#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+: { - watch+: value, + deployment+: value, }, }, - '#withWorkflowCall': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Allows workflows to be reused by other workflows.' } }, - withWorkflowCall(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+: { - workflow_call: value, + deployment_status: 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): { + '#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+: { - workflow_dispatch: value, + deployment_status+: 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): { + '#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+: { - workflow_run: value, + discussion: 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): { + '#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+: { - workflow_run+: value, + discussion+: value, }, }, - workflow_run+: + discussion+: { - '#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': { '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+: { - workflow_run+: { + discussion+: { types: (if std.isArray(value) then value @@ -1452,10 +1585,10 @@ }, }, }, - '#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': { '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+: { - workflow_run+: { + discussion+: { types+: (if std.isArray(value) then value @@ -1463,22 +1596,37 @@ }, }, }, - '#withWorkflows': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, - withWorkflows(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+: { - workflow_run+: { - workflows: + discussion_comment+: { + types: (if std.isArray(value) then value else [value]), }, }, }, - '#withWorkflowsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, - withWorkflowsMixin(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+: { - workflow_run+: { - workflows+: + discussion_comment+: { + types+: (if std.isArray(value) then value else [value]), @@ -1486,1203 +1634,1207 @@ }, }, }, - }, - '#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, + '#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, }, }, - '#withAttestations': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, - withAttestations(value): { - permissions+: { - attestations: 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, }, }, - '#withChecks': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, - withChecks(value): { - permissions+: { - checks: 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, }, }, - '#withContents': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, - withContents(value): { - permissions+: { - contents: 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, }, }, - '#withDeployments': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, - withDeployments(value): { - permissions+: { - deployments: 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, }, }, - '#withDiscussions': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, - withDiscussions(value): { - permissions+: { - discussions: 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, }, }, - '#withIdToken': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, - withIdToken(value): { - permissions+: { - 'id-token': 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: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, + '#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): { - permissions+: { + on+: { issues: value, }, }, - '#withPackages': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, - withPackages(value): { - permissions+: { - packages: 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, }, }, - '#withPages': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, - withPages(value): { - permissions+: { - pages: 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]), + }, + }, + }, }, - }, - '#withPullRequests': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, - withPullRequests(value): { - permissions+: { - 'pull-requests': 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, }, }, - '#withRepositoryProjects': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, - withRepositoryProjects(value): { - permissions+: { - 'repository-projects': 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, }, }, - '#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'+: + label+: { - '#withExpressionSyntax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, - withExpressionSyntax(value): { - concurrency+: { - 'cancel-in-progress'+: { - expressionSyntax: value, + '#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]), }, }, }, }, - '#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, + '#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, }, }, - }, - '#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, + '#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, + }, }, - container+: + merge_group+: { - '#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, - }, - }, + '#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]), }, }, - '#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, - }, - }, + '#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]), }, }, - '#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, + '#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, }, }, - '#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, + '#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, }, }, - credentials+: + milestone+: { - '#withPassword': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, - withPassword(value): { - container+: { - credentials+: { - password: value, + '#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]), }, }, }, - '#withUsername': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, - withUsername(value): { - container+: { - credentials+: { - username: 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]), }, }, }, }, - '#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, + '#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, }, }, - '#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, + '#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, }, }, - 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, + '#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, }, }, - '#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, + '#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, }, }, - '#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+: + project+: { - '#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, + '#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]), }, }, }, - '#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, + '#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]), }, }, }, }, - }, - '#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, + '#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, }, }, - }, - '#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, + '#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, + }, }, - environment+: + project_card+: { - '#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, + '#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]), + }, }, }, - '#withUrl': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A deployment URL' } }, - withUrl(value): { - environment+: { - url: 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]), + }, }, }, }, - }, - '#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, + '#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, }, }, - '#withDeployments': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, - withDeployments(value): { - permissions+: { - deployments: 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, }, }, - '#withDiscussions': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, - withDiscussions(value): { - permissions+: { - discussions: 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]), + }, + }, + }, }, - }, - '#withIdToken': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, - withIdToken(value): { - permissions+: { - 'id-token': 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, }, }, - '#withIssues': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, - withIssues(value): { - permissions+: { - issues: 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, }, }, - '#withPackages': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, - withPackages(value): { - permissions+: { - packages: 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, }, }, - '#withPages': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, - withPages(value): { - permissions+: { - pages: 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, }, }, - '#withPullRequests': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, - withPullRequests(value): { - permissions+: { - 'pull-requests': 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]), + }, + }, + }, }, - }, - '#withRepositoryProjects': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, - withRepositoryProjects(value): { - permissions+: { - 'repository-projects': 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, }, }, - '#withSecurityEvents': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, - withSecurityEvents(value): { - permissions+: { - 'security-events': 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, }, }, - '#withStatuses': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, - withStatuses(value): { - permissions+: { - statuses: 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]), + }, + }, + }, }, - }, - }, - '#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, + '#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, }, }, - '#withLabels': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: '' } }, - withLabels(value): { - 'runs-on'+: { - labels: 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, }, }, - '#withLabelsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: '' } }, - withLabelsMixin(value): { - 'runs-on'+: { - labels+: 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]), + }, + }, + }, }, - }, - '#withStringContainingExpressionSyntax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, - withStringContainingExpressionSyntax(value): { - 'runs-on'+: { - stringContainingExpressionSyntax: 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, }, }, - '#withExpressionSyntax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, - withExpressionSyntax(value): { - 'runs-on'+: { - expressionSyntax: 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, }, }, - }, - '#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, - }, - '#withStep': { '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' } }, - withStep(value): { - step: - (if std.isArray(value) - then value - else [value]), - }, - '#withStepMixin': { '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' } }, - withStepMixin(value): { - step+: - (if std.isArray(value) - then value - else [value]), - }, - step+: - { - '#': { help: '', name: 'step' }, - '#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'+: + pull_request_target+: { - '#withExpressionSyntax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, - withExpressionSyntax(value): { - 'continue-on-error'+: { - expressionSyntax: value, + '#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]), + }, }, }, - }, - '#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, + '#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]), + }, }, }, - }, - '#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, + '#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]), + }, }, }, - }, - '#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, + '#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]), + }, }, }, - }, - '#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, + '#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]), }, }, }, }, - '#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, - }, - }, - }, - }, - action+: - { - '#withAuthor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "The name of the action's author." } }, - withAuthor(value): { - author: value, - }, - '#withBranding': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'You can use a color and Feather icon to create a badge to personalize and distinguish your action. Badges are shown next to your action name in GitHub Marketplace.' } }, - withBranding(value): { - branding: value, - }, - '#withBrandingMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'You can use a color and Feather icon to create a badge to personalize and distinguish your action. Badges are shown next to your action name in GitHub Marketplace.' } }, - withBrandingMixin(value): { - branding+: value, - }, - branding+: - { - '#withColor': { 'function': { args: [{ default: null, enums: ['white', 'black', 'yellow', 'blue', 'green', 'orange', 'red', 'purple', 'gray-dark'], name: 'value', type: ['string'] }], help: 'The background color of the badge.' } }, - withColor(value): { - branding+: { - color: value, - }, - }, - '#withIcon': { 'function': { args: [{ default: null, enums: ['activity', 'airplay', 'alert-circle', 'alert-octagon', 'alert-triangle', 'align-center', 'align-justify', 'align-left', 'align-right', 'anchor', 'aperture', 'archive', 'arrow-down-circle', 'arrow-down-left', 'arrow-down-right', 'arrow-down', 'arrow-left-circle', 'arrow-left', 'arrow-right-circle', 'arrow-right', 'arrow-up-circle', 'arrow-up-left', 'arrow-up-right', 'arrow-up', 'at-sign', 'award', 'bar-chart-2', 'bar-chart', 'battery-charging', 'battery', 'bell-off', 'bell', 'bluetooth', 'bold', 'book-open', 'book', 'bookmark', 'box', 'briefcase', 'calendar', 'camera-off', 'camera', 'cast', 'check-circle', 'check-square', 'check', 'chevron-down', 'chevron-left', 'chevron-right', 'chevron-up', 'chevrons-down', 'chevrons-left', 'chevrons-right', 'chevrons-up', 'circle', 'clipboard', 'clock', 'cloud-drizzle', 'cloud-lightning', 'cloud-off', 'cloud-rain', 'cloud-snow', 'cloud', 'code', 'command', 'compass', 'copy', 'corner-down-left', 'corner-down-right', 'corner-left-down', 'corner-left-up', 'corner-right-down', 'corner-right-up', 'corner-up-left', 'corner-up-right', 'cpu', 'credit-card', 'crop', 'crosshair', 'database', 'delete', 'disc', 'dollar-sign', 'download-cloud', 'download', 'droplet', 'edit-2', 'edit-3', 'edit', 'external-link', 'eye-off', 'eye', 'fast-forward', 'feather', 'file-minus', 'file-plus', 'file-text', 'file', 'film', 'filter', 'flag', 'folder-minus', 'folder-plus', 'folder', 'gift', 'git-branch', 'git-commit', 'git-merge', 'git-pull-request', 'globe', 'grid', 'hard-drive', 'hash', 'headphones', 'heart', 'help-circle', 'home', 'image', 'inbox', 'info', 'italic', 'layers', 'layout', 'life-buoy', 'link-2', 'link', 'list', 'loader', 'lock', 'log-in', 'log-out', 'mail', 'map-pin', 'map', 'maximize-2', 'maximize', 'menu', 'message-circle', 'message-square', 'mic-off', 'mic', 'minimize-2', 'minimize', 'minus-circle', 'minus-square', 'minus', 'monitor', 'moon', 'more-horizontal', 'more-vertical', 'move', 'music', 'navigation-2', 'navigation', 'octagon', 'package', 'paperclip', 'pause-circle', 'pause', 'percent', 'phone-call', 'phone-forwarded', 'phone-incoming', 'phone-missed', 'phone-off', 'phone-outgoing', 'phone', 'pie-chart', 'play-circle', 'play', 'plus-circle', 'plus-square', 'plus', 'pocket', 'power', 'printer', 'radio', 'refresh-ccw', 'refresh-cw', 'repeat', 'rewind', 'rotate-ccw', 'rotate-cw', 'rss', 'save', 'scissors', 'search', 'send', 'server', 'settings', 'share-2', 'share', 'shield-off', 'shield', 'shopping-bag', 'shopping-cart', 'shuffle', 'sidebar', 'skip-back', 'skip-forward', 'slash', 'sliders', 'smartphone', 'speaker', 'square', 'star', 'stop-circle', 'sun', 'sunrise', 'sunset', 'table', 'tablet', 'tag', 'target', 'terminal', 'thermometer', 'thumbs-down', 'thumbs-up', 'toggle-left', 'toggle-right', 'trash-2', 'trash', 'trending-down', 'trending-up', 'triangle', 'truck', 'tv', 'type', 'umbrella', 'underline', 'unlock', 'upload-cloud', 'upload', 'user-check', 'user-minus', 'user-plus', 'user-x', 'user', 'users', 'video-off', 'video', 'voicemail', 'volume-1', 'volume-2', 'volume-x', 'volume', 'watch', 'wifi-off', 'wifi', 'wind', 'x-circle', 'x-square', 'x', 'zap-off', 'zap', 'zoom-in', 'zoom-out'], name: 'value', type: ['string'] }], help: 'The name of the Feather icon to use.' } }, - withIcon(value): { - branding+: { - icon: value, - }, - }, - }, - '#withDescription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A short description of the action.' } }, - withDescription(value): { - description: value, - }, - '#withInputs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Input parameters allow you to specify data that the action expects to use during runtime. GitHub stores input parameters as environment variables. Input ids with uppercase letters are converted to lowercase during runtime. We recommended using lowercase input ids.' } }, - withInputs(value): { - inputs: value, - }, - '#withInputsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Input parameters allow you to specify data that the action expects to use during runtime. GitHub stores input parameters as environment variables. Input ids with uppercase letters are converted to lowercase during runtime. We recommended using lowercase input ids.' } }, - withInputsMixin(value): { - inputs+: value, - }, - '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The name of your action. GitHub displays the `name` in the Actions tab to help visually identify actions in each job.' } }, - withName(value): { - name: value, - }, - '#withOutputs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, - withOutputs(value): { - outputs: value, - }, - '#withRuns': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object', 'object', 'object'] }], help: '' } }, - withRuns(value): { - runs: value, - }, - '#withRunsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object', 'object', 'object'] }], help: '' } }, - withRunsMixin(value): { - runs+: value, - }, - runs+: - { - '#withJavascript': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "Configures the path to the action's code and the application used to execute the code." } }, - withJavascript(value): { - runs+: { - javascript: 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, }, }, - '#withJavascriptMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "Configures the path to the action's code and the application used to execute the code." } }, - withJavascriptMixin(value): { - runs+: { - javascript+: 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, }, }, - javascript+: + push+: { - '#withMain': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The file that contains your action code. The application specified in `using` executes this file.' } }, - withMain(value): { - runs+: { - main: value, + '#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]), + }, }, }, - '#withPost': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Allows you to run a script at the end of a job, once the `main:` action has completed. For example, you can use `post:` to terminate certain processes or remove unneeded files. The application specified with the `using` syntax will execute this file. The `post:` action always runs by default but you can override this using `post-if`.' } }, - withPost(value): { - runs+: { - post: 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]), + }, }, }, - '#withPostIf': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Allows you to define conditions for the `post:` action execution. The `post:` action will only run if the conditions in `post-if` are met. If not set, then `post-if` defaults to `always()`.' } }, - withPostIf(value): { - runs+: { - 'post-if': 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]), + }, }, }, - '#withPre': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Allows you to run a script at the start of a job, before the `main:` action begins. For example, you can use `pre:` to run a prerequisite setup script. The application specified with the `using` syntax will execute this file. The `pre:` action always runs by default but you can override this using `pre-if`.' } }, - withPre(value): { - runs+: { - pre: 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]), + }, }, }, - '#withPreIf': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Allows you to define conditions for the `pre:` action execution. The `pre:` action will only run if the conditions in `pre-if` are met. If not set, then `pre-if` defaults to `always()`. Note that the `step` context is unavailable, as no steps have run yet.' } }, - withPreIf(value): { - runs+: { - 'pre-if': 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]), + }, }, }, - '#withUsing': { 'function': { args: [{ default: null, enums: ['node12', 'node16', 'node20'], name: 'value', type: ['string'] }], help: 'The application used to execute the code specified in `main`.' } }, - withUsing(value): { - runs+: { - using: 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]), + }, }, }, }, - '#withComposite': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Configures the path to the composite action, and the application used to execute the code.' } }, - withComposite(value): { - runs+: { - composite: 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, }, }, - '#withCompositeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Configures the path to the composite action, and the application used to execute the code.' } }, - withCompositeMixin(value): { - runs+: { - composite+: 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, }, }, - composite+: + registry_package+: { - '#withStep': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'The run steps that you plan to run in this action.' } }, - withStep(value): { - runs+: { - step: - (if std.isArray(value) - then value - else [value]), + '#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]), + }, }, }, - '#withStepMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'The run steps that you plan to run in this action.' } }, - withStepMixin(value): { - runs+: { - step+: - (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]), + }, }, }, - step+: - { - '#': { help: '', name: 'step' }, - '#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: 'Sets a map of environment variables for only that step.' } }, - withEnv(value): { - env: value, - }, - '#withEnvMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object', 'string'] }], help: 'Sets a map of environment variables for only that step.' } }, - 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.' } }, - withId(value): { - id: value, - }, - '#withIf': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['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: 'The name of the composite run step.' } }, - withName(value): { - name: value, - }, - '#withRun': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The command you want to run. This can be inline or a script in your action repository.' } }, - withRun(value): { - run: value, - }, - '#withShell': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The shell where you want to run the command.' } }, - withShell(value): { - shell: 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.' } }, - withUses(value): { - uses: value, - }, - '#withWith': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'A map of the input parameters defined by the action. Each input parameter is a key/value pair. Input parameters are set as environment variables. The variable is prefixed with INPUT_ and converted to upper case.' } }, - withWith(value): { - with: value, - }, - '#withWithMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'A map of the input parameters defined by the action. Each input parameter is a key/value pair. Input parameters are set as environment variables. The variable is prefixed with INPUT_ and converted to upper case.' } }, - withWithMixin(value): { - with+: value, - }, - '#withWorkingDirectory': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specifies the working directory where the command is run.' } }, - withWorkingDirectory(value): { - 'working-directory': 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]), }, }, - '#withUsing': { 'function': { args: [], help: "To use a composite run steps action, set this to 'composite'." } }, - withUsing(): { - runs+: { - using: 'composite', + }, + '#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]), + }, }, }, }, - '#withDocker': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Configures the image used for the Docker action.' } }, - withDocker(value): { - runs+: { - docker: 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, }, }, - '#withDockerMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Configures the image used for the Docker action.' } }, - withDockerMixin(value): { - runs+: { - docker+: 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, }, }, - docker+: + workflow_run+: { - '#withArgs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: "An array of strings that define the inputs for a Docker container. Inputs can include hardcoded strings. GitHub passes the `args` to the container's `ENTRYPOINT` when the container starts up.\nThe `args` are used in place of the `CMD` instruction in a `Dockerfile`. If you use `CMD` in your `Dockerfile`, use the guidelines ordered by preference:\n- Document required arguments in the action's README and omit them from the `CMD` instruction.\n- Use defaults that allow using the action without specifying any `args`.\n- If the action exposes a `--help` flag, or something similar, use that to make your action self-documenting." } }, - withArgs(value): { - runs+: { - args: - (if std.isArray(value) - then value - else [value]), - }, - }, - '#withArgsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: "An array of strings that define the inputs for a Docker container. Inputs can include hardcoded strings. GitHub passes the `args` to the container's `ENTRYPOINT` when the container starts up.\nThe `args` are used in place of the `CMD` instruction in a `Dockerfile`. If you use `CMD` in your `Dockerfile`, use the guidelines ordered by preference:\n- Document required arguments in the action's README and omit them from the `CMD` instruction.\n- Use defaults that allow using the action without specifying any `args`.\n- If the action exposes a `--help` flag, or something similar, use that to make your action self-documenting." } }, - withArgsMixin(value): { - runs+: { - args+: - (if std.isArray(value) - then value - else [value]), - }, - }, - '#withEntrypoint': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "Overrides the Docker `ENTRYPOINT` in the `Dockerfile`, or sets it if one wasn't already specified. Use `entrypoint` when the `Dockerfile` does not specify an `ENTRYPOINT` or you want to override the `ENTRYPOINT` instruction. If you omit `entrypoint`, the commands you specify in the Docker `ENTRYPOINT` instruction will execute. The Docker `ENTRYPOINT instruction has a *shell* form and *exec* form. The Docker `ENTRYPOINT` documentation recommends using the *exec* form of the `ENTRYPOINT` instruction." } }, - withEntrypoint(value): { - runs+: { - entrypoint: value, - }, - }, - '#withEnv': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object', 'string'] }], help: 'Specifies a key/value map of environment variables to set in the container environment.' } }, - withEnv(value): { - runs+: { - env: value, - }, - }, - '#withEnvMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object', 'string'] }], help: 'Specifies a key/value map of environment variables to set in the container environment.' } }, - withEnvMixin(value): { - runs+: { - env+: value, - }, - }, - env+: - { - '#withStringContainingExpressionSyntax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, - withStringContainingExpressionSyntax(value): { - runs+: { - env+: { - stringContainingExpressionSyntax: value, - }, - }, + '#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]), }, }, - '#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 base image name, a local `Dockerfile` in your repository, or a public image in Docker Hub or another registry. To reference a `Dockerfile` local to your repository, use a path relative to your action metadata file. The `docker` application will execute this file.' } }, - withImage(value): { - runs+: { - image: value, - }, - }, - '#withPostEntrypoint': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Allows you to run a cleanup script once the `runs.entrypoint` action has completed. GitHub Actions uses `docker run` to launch this action. Because GitHub Actions runs the script inside a new container using the same base image, the runtime state is different from the main `entrypoint` container. You can access any state you need in either the workspace, `HOME`, or as a `STATE_` variable. The `post-entrypoint:` action always runs by default but you can override this using `post-if`.' } }, - withPostEntrypoint(value): { - runs+: { - 'post-entrypoint': value, - }, - }, - '#withPostIf': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Allows you to define conditions for the `post:` action execution. The `post:` action will only run if the conditions in `post-if` are met. If not set, then `post-if` defaults to `always()`.' } }, - withPostIf(value): { - runs+: { - 'post-if': value, - }, }, - '#withPreEntrypoint': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Allows you to run a script before the `entrypoint` action begins. For example, you can use `pre-entrypoint:` to run a prerequisite setup script. GitHub Actions uses `docker run` to launch this action, and runs the script inside a new container that uses the same base image. This means that the runtime state is different from the main `entrypoint` container, and any states you require must be accessed in either the workspace, `HOME`, or as a `STATE_` variable. The `pre-entrypoint:` action always runs by default but you can override this using `pre-if`.' } }, - withPreEntrypoint(value): { - runs+: { - 'pre-entrypoint': 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]), + }, }, }, - '#withPreIf': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Allows you to define conditions for the `pre:` action execution. The `pre:` action will only run if the conditions in `pre-if` are met. If not set, then `pre-if` defaults to `always()`. Note that the `step` context is unavailable, as no steps have run yet.' } }, - withPreIf(value): { - runs+: { - 'pre-if': 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]), + }, }, }, - '#withUsing': { 'function': { args: [], help: "You must set this value to 'docker'." } }, - withUsing(): { - runs+: { - using: 'docker', + '#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]), + }, }, }, }, }, - input+: + '#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+: { - '#withDefault': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "A string representing the default value. The default value is used when an input parameter isn't specified in a workflow file." } }, - withDefault(value): { - default: value, + '#withActions': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, + withActions(value): { + permissions+: { + actions: value, + }, }, - '#withDeprecationMessage': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A string shown to users using the deprecated input.' } }, - withDeprecationMessage(value): { - deprecationMessage: value, + '#withAttestations': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, + withAttestations(value): { + permissions+: { + attestations: value, + }, }, - '#withDescription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A string description of the input parameter.' } }, - withDescription(value): { - description: value, + '#withChecks': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, + withChecks(value): { + permissions+: { + checks: value, + }, }, - '#withRequired': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'A boolean to indicate whether the action requires the input parameter. Set to `true` when the parameter is required.' } }, - withRequired(value=true): { - required: value, + '#withContents': { 'function': { args: [{ default: null, enums: ['read', 'write', 'none'], name: 'value', type: ['string'] }], help: '' } }, + withContents(value): { + permissions+: { + contents: value, + }, }, - }, - output+: - { - '#withDescription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A string description of the output parameter.' } }, - withDescription(value): { - description: 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, + }, }, - '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The value that the output parameter will be mapped to. You can set this to a string or an expression with context. For example, you can use the steps context to set the value of an output to the output value of a step.' } }, - withValue(value): { - value: 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/util.libsonnet b/util.libsonnet index 151c64e..0c48cfe 100644 --- a/util.libsonnet +++ b/util.libsonnet @@ -18,17 +18,20 @@ local d = import './vendor/github.com/jsonnet-libs/docsonnet/doc-util/main.libso ) ), - local manifestArray(arr, indent='', sep='\n') = + local plainManifest(doc) = + std.manifestYamlDoc( + doc, + indent_array_in_object=true, + quote_keys=false + ), + + local manifestArray(arr, indent='', sep='\n', manifestF=plainManifest) = indentDoc( std.join(sep, [ '-' + indentDoc( - std.manifestYamlDoc( - item, - indent_array_in_object=true, - quote_keys=false - ), - ' ' + manifestF(item), + ' ', )[1:] for item in arr ]), @@ -58,7 +61,22 @@ local d = import './vendor/github.com/jsonnet-libs/docsonnet/doc-util/main.libso local manifestSteps(steps, indent='') = indentDoc( 'steps:\n' - + manifestArray(steps, indent, sep='\n\n'), + + manifestArray( + steps, + indent, + sep='\n\n', + manifestF= + function(step) + manifestFields( + step, + ['name', 'id', 'if'] + + std.filter( + function(key) !std.member(['name', 'id', 'if', 'env'], key), + std.objectFields(step) + ) + + ['env'], + ), + ), indent, ), @@ -71,6 +89,13 @@ local d = import './vendor/github.com/jsonnet-libs/docsonnet/doc-util/main.libso ) ), + local pruneEmptyString(arr) = + std.filter( + function(s) s != '', + arr + ), + + '#manifestAction':: d.func.new( ||| `manifestAction` manifests an action in an opinionated Yaml format. @@ -98,7 +123,7 @@ local d = import './vendor/github.com/jsonnet-libs/docsonnet/doc-util/main.libso std.stripChars( std.join( '\n\n', - [ + pruneEmptyString([ manifestFields( action, [ @@ -127,7 +152,7 @@ local d = import './vendor/github.com/jsonnet-libs/docsonnet/doc-util/main.libso ), manifestSteps(action.runs.steps, ' '), manifestFields(action, ['branding']), - ] + ]) ), '\n', ), @@ -206,7 +231,7 @@ local d = import './vendor/github.com/jsonnet-libs/docsonnet/doc-util/main.libso std.stripChars( std.join( '\n\n', - [ + pruneEmptyString([ manifestFields( workflow, [ @@ -227,7 +252,7 @@ local d = import './vendor/github.com/jsonnet-libs/docsonnet/doc-util/main.libso sep='\n\n', ), manifestJobs(workflow.jobs), - ] + ]) ), '\n', ),