projen 0.52.22 → 0.52.26
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.jsii +139 -107
- package/changelog.md +1 -1
- package/docs/api/API.md +42 -39
- package/lib/awscdk/auto-discover.d.ts +14 -46
- package/lib/awscdk/auto-discover.js +8 -22
- package/lib/awscdk/awscdk-app-java.d.ts +10 -32
- package/lib/awscdk/awscdk-app-java.js +5 -9
- package/lib/awscdk/awscdk-app-ts.d.ts +15 -35
- package/lib/awscdk/awscdk-app-ts.js +6 -14
- package/lib/awscdk/awscdk-construct.d.ts +14 -28
- package/lib/awscdk/awscdk-construct.js +8 -16
- package/lib/awscdk/awscdk-deps-java.d.ts +1 -8
- package/lib/awscdk/awscdk-deps-java.js +3 -10
- package/lib/awscdk/awscdk-deps-js.d.ts +1 -8
- package/lib/awscdk/awscdk-deps-js.js +3 -10
- package/lib/awscdk/awscdk-deps.d.ts +28 -67
- package/lib/awscdk/awscdk-deps.js +5 -12
- package/lib/awscdk/cdk-config.d.ts +19 -51
- package/lib/awscdk/cdk-config.js +13 -11
- package/lib/awscdk/cdk-tasks.d.ts +7 -24
- package/lib/awscdk/cdk-tasks.js +3 -8
- package/lib/awscdk/integration-test.d.ts +7 -29
- package/lib/awscdk/integration-test.js +3 -8
- package/lib/awscdk/lambda-function.d.ts +22 -50
- package/lib/awscdk/lambda-function.js +11 -24
- package/lib/build/build-workflow.d.ts +33 -78
- package/lib/build/build-workflow.js +15 -25
- package/lib/cdk/auto-discover-base.d.ts +11 -34
- package/lib/cdk/auto-discover-base.js +5 -15
- package/lib/cdk/construct-lib.d.ts +8 -22
- package/lib/cdk/construct-lib.js +3 -8
- package/lib/cdk/integration-test-base.d.ts +12 -38
- package/lib/cdk/integration-test-base.js +2 -8
- package/lib/cdk/jsii-docgen.d.ts +6 -12
- package/lib/cdk/jsii-docgen.js +6 -8
- package/lib/cdk/jsii-project.d.ts +16 -95
- package/lib/cdk/jsii-project.js +3 -10
- package/lib/cdk8s/auto-discover.d.ts +6 -23
- package/lib/cdk8s/auto-discover.js +6 -15
- package/lib/cdk8s/cdk8s-app-ts.d.ts +21 -43
- package/lib/cdk8s/cdk8s-app-ts.js +4 -7
- package/lib/cdk8s/cdk8s-construct.d.ts +12 -27
- package/lib/cdk8s/cdk8s-construct.js +3 -7
- package/lib/cdk8s/integration-test.d.ts +2 -9
- package/lib/cdk8s/integration-test.js +3 -8
- package/lib/cdktf/cdktf-construct.d.ts +3 -12
- package/lib/cdktf/cdktf-construct.js +3 -7
- package/lib/component.d.ts +4 -17
- package/lib/component.js +6 -19
- package/lib/dependencies.d.ts +44 -77
- package/lib/dependencies.js +50 -38
- package/lib/dev-env.d.ts +26 -53
- package/lib/dev-env.js +9 -19
- package/lib/docker-compose.d.ts +83 -209
- package/lib/docker-compose.js +38 -61
- package/lib/file.d.ts +24 -71
- package/lib/file.js +4 -16
- package/lib/gitattributes.d.ts +3 -14
- package/lib/gitattributes.js +5 -16
- package/lib/github/auto-approve.d.ts +7 -23
- package/lib/github/auto-approve.js +3 -8
- package/lib/github/auto-merge.d.ts +7 -29
- package/lib/github/auto-merge.js +7 -16
- package/lib/github/dependabot.d.ts +54 -147
- package/lib/github/dependabot.js +81 -22
- package/lib/github/github-project.d.ts +26 -70
- package/lib/github/github-project.js +5 -10
- package/lib/github/github.d.ts +19 -58
- package/lib/github/github.js +9 -30
- package/lib/github/mergify.d.ts +9 -54
- package/lib/github/mergify.js +2 -14
- package/lib/github/pr-template.d.ts +3 -13
- package/lib/github/pr-template.js +3 -8
- package/lib/github/pull-request-lint.d.ts +8 -28
- package/lib/github/pull-request-lint.js +3 -9
- package/lib/github/stale.d.ts +17 -47
- package/lib/github/stale.js +6 -10
- package/lib/github/task-workflow.d.ts +21 -63
- package/lib/github/task-workflow.js +3 -8
- package/lib/github/workflows-model.d.ts +199 -582
- package/lib/github/workflows-model.js +5 -4
- package/lib/github/workflows.d.ts +14 -41
- package/lib/github/workflows.js +8 -16
- package/lib/gitlab/configuration-model.d.ts +145 -947
- package/lib/gitlab/configuration-model.js +11 -28
- package/lib/gitlab/configuration.d.ts +31 -121
- package/lib/gitlab/configuration.js +14 -49
- package/lib/gitlab/gitlab-configuration.d.ts +2 -13
- package/lib/gitlab/gitlab-configuration.js +4 -15
- package/lib/gitlab/nested-configuration.d.ts +1 -9
- package/lib/gitlab/nested-configuration.js +3 -8
- package/lib/gitpod.d.ts +71 -167
- package/lib/gitpod.js +75 -42
- package/lib/ignore-file.d.ts +4 -23
- package/lib/ignore-file.js +6 -25
- package/lib/ini.d.ts +2 -14
- package/lib/ini.js +3 -13
- package/lib/java/java-project.d.ts +29 -70
- package/lib/java/java-project.js +10 -17
- package/lib/java/junit.d.ts +5 -17
- package/lib/java/junit.js +3 -8
- package/lib/java/maven-compile.d.ts +4 -13
- package/lib/java/maven-compile.js +3 -8
- package/lib/java/maven-packaging.d.ts +6 -21
- package/lib/java/maven-packaging.js +3 -8
- package/lib/java/maven-sample.d.ts +2 -12
- package/lib/java/maven-sample.js +3 -8
- package/lib/java/pom.d.ts +38 -100
- package/lib/java/pom.js +13 -25
- package/lib/java/projenrc.d.ts +7 -22
- package/lib/java/projenrc.js +3 -8
- package/lib/javascript/bundler.d.ts +30 -72
- package/lib/javascript/bundler.js +13 -21
- package/lib/javascript/eslint.d.ts +27 -84
- package/lib/javascript/eslint.js +11 -30
- package/lib/javascript/jest.d.ts +91 -344
- package/lib/javascript/jest.js +6 -23
- package/lib/javascript/node-package.d.ts +111 -259
- package/lib/javascript/node-package.js +64 -81
- package/lib/javascript/node-project.d.ts +112 -220
- package/lib/javascript/node-project.js +54 -73
- package/lib/javascript/npm-config.d.ts +9 -19
- package/lib/javascript/npm-config.js +9 -16
- package/lib/javascript/prettier.d.ts +65 -196
- package/lib/javascript/prettier.js +70 -46
- package/lib/javascript/projenrc.d.ts +2 -12
- package/lib/javascript/projenrc.js +3 -8
- package/lib/javascript/typescript-config.d.ts +62 -158
- package/lib/javascript/typescript-config.js +31 -18
- package/lib/javascript/upgrade-dependencies.d.ts +35 -94
- package/lib/javascript/upgrade-dependencies.js +21 -51
- package/lib/json.d.ts +3 -17
- package/lib/json.js +3 -13
- package/lib/license.d.ts +3 -20
- package/lib/license.js +2 -13
- package/lib/logger.d.ts +18 -62
- package/lib/logger.js +17 -37
- package/lib/makefile.d.ts +14 -45
- package/lib/makefile.js +7 -25
- package/lib/object-file.d.ts +19 -39
- package/lib/object-file.js +17 -28
- package/lib/option-hints.d.ts +4 -13
- package/lib/option-hints.js +11 -5
- package/lib/project-build.d.ts +7 -26
- package/lib/project-build.js +3 -8
- package/lib/project.d.ts +64 -186
- package/lib/project.js +43 -91
- package/lib/projects.d.ts +11 -32
- package/lib/projects.js +4 -8
- package/lib/projenrc-json.d.ts +2 -12
- package/lib/projenrc-json.js +3 -8
- package/lib/python/pip.d.ts +7 -23
- package/lib/python/pip.js +8 -17
- package/lib/python/poetry.d.ts +36 -121
- package/lib/python/poetry.js +12 -26
- package/lib/python/projenrc.d.ts +4 -15
- package/lib/python/projenrc.js +3 -8
- package/lib/python/pytest.d.ts +3 -16
- package/lib/python/pytest.js +2 -8
- package/lib/python/python-deps.d.ts +7 -21
- package/lib/python/python-deps.js +1 -1
- package/lib/python/python-env.d.ts +1 -6
- package/lib/python/python-env.js +1 -1
- package/lib/python/python-packaging.d.ts +12 -34
- package/lib/python/python-packaging.js +1 -1
- package/lib/python/python-project.d.ts +34 -79
- package/lib/python/python-project.js +7 -20
- package/lib/python/python-sample.d.ts +2 -9
- package/lib/python/python-sample.js +3 -8
- package/lib/python/requirements-file.d.ts +4 -19
- package/lib/python/requirements-file.js +5 -15
- package/lib/python/setuppy.d.ts +11 -39
- package/lib/python/setuppy.js +3 -13
- package/lib/python/setuptools.d.ts +2 -14
- package/lib/python/setuptools.js +3 -8
- package/lib/python/venv.d.ts +4 -14
- package/lib/python/venv.js +4 -11
- package/lib/readme.d.ts +7 -16
- package/lib/readme.js +5 -7
- package/lib/release/publisher.d.ts +103 -206
- package/lib/release/publisher.js +47 -59
- package/lib/release/release-trigger.d.ts +16 -48
- package/lib/release/release-trigger.js +8 -18
- package/lib/release/release.d.ts +50 -110
- package/lib/release/release.js +9 -24
- package/lib/sample-file.d.ts +14 -47
- package/lib/sample-file.js +9 -30
- package/lib/semver.d.ts +4 -21
- package/lib/semver.js +6 -20
- package/lib/source-code.d.ts +7 -23
- package/lib/source-code.js +7 -19
- package/lib/task-model.d.ts +21 -61
- package/lib/task-model.js +1 -1
- package/lib/task-runtime.d.ts +7 -24
- package/lib/task-runtime.js +7 -20
- package/lib/task.d.ts +29 -73
- package/lib/task.js +28 -61
- package/lib/tasks.d.ts +12 -34
- package/lib/tasks.js +14 -36
- package/lib/testing.d.ts +6 -10
- package/lib/testing.js +8 -12
- package/lib/textfile.d.ts +9 -24
- package/lib/textfile.js +9 -19
- package/lib/toml.d.ts +2 -14
- package/lib/toml.js +3 -13
- package/lib/typescript/projenrc.d.ts +4 -14
- package/lib/typescript/projenrc.js +3 -8
- package/lib/typescript/typescript-typedoc.d.ts +1 -6
- package/lib/typescript/typescript-typedoc.js +3 -8
- package/lib/typescript/typescript.d.ts +24 -82
- package/lib/typescript/typescript.js +6 -15
- package/lib/version.d.ts +9 -38
- package/lib/version.js +2 -11
- package/lib/vscode/devcontainer.d.ts +10 -30
- package/lib/vscode/devcontainer.js +10 -26
- package/lib/vscode/launch-config.d.ts +18 -97
- package/lib/vscode/launch-config.js +9 -15
- package/lib/vscode/vscode.d.ts +0 -9
- package/lib/vscode/vscode.js +2 -11
- package/lib/web/next.d.ts +19 -60
- package/lib/web/next.js +6 -20
- package/lib/web/postcss.d.ts +3 -24
- package/lib/web/postcss.js +3 -8
- package/lib/web/react.d.ts +13 -60
- package/lib/web/react.js +7 -32
- package/lib/web/tailwind.d.ts +1 -15
- package/lib/web/tailwind.js +3 -7
- package/lib/xmlfile.d.ts +2 -14
- package/lib/xmlfile.js +3 -13
- package/lib/yaml.d.ts +4 -19
- package/lib/yaml.js +3 -13
- package/node_modules/xmlbuilder2/node_modules/@types/node/README.md +1 -1
- package/node_modules/xmlbuilder2/node_modules/@types/node/buffer.d.ts +90 -0
- package/node_modules/xmlbuilder2/node_modules/@types/node/package.json +2 -2
- package/package.json +4 -4
- package/releasetag.txt +1 -1
- package/version.txt +1 -1
|
@@ -1,25 +1,16 @@
|
|
|
1
1
|
/**
|
|
2
|
-
*
|
|
3
|
-
*
|
|
4
|
-
* @experimental
|
|
2
|
+
* A GitHub Workflow job definition.
|
|
5
3
|
*/
|
|
6
4
|
export interface Job {
|
|
7
5
|
/**
|
|
8
|
-
*
|
|
9
|
-
*
|
|
10
|
-
* The machine can be either a
|
|
6
|
+
* The type of machine to run the job on. The machine can be either a
|
|
11
7
|
* GitHub-hosted runner or a self-hosted runner.
|
|
12
8
|
*
|
|
13
|
-
* @
|
|
14
|
-
* @example
|
|
15
|
-
*
|
|
16
|
-
* ["ubuntu-latest"]
|
|
9
|
+
* @example ["ubuntu-latest"]
|
|
17
10
|
*/
|
|
18
11
|
readonly runsOn: string[];
|
|
19
12
|
/**
|
|
20
|
-
*
|
|
21
|
-
*
|
|
22
|
-
* Steps can run commands,
|
|
13
|
+
* A job contains a sequence of tasks called steps. Steps can run commands,
|
|
23
14
|
* run setup tasks, or run an action in your repository, a public repository,
|
|
24
15
|
* or an action published in a Docker registry. Not all steps run actions,
|
|
25
16
|
* but all actions run as a step. Each step runs in its own process in the
|
|
@@ -27,28 +18,23 @@ export interface Job {
|
|
|
27
18
|
* Because steps run in their own process, changes to environment variables
|
|
28
19
|
* are not preserved between steps. GitHub provides built-in steps to set up
|
|
29
20
|
* and complete a job.
|
|
30
|
-
*
|
|
31
|
-
* @experimental
|
|
32
21
|
*/
|
|
33
22
|
readonly steps: JobStep[];
|
|
34
23
|
/**
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
* @experimental
|
|
24
|
+
* The name of the job displayed on GitHub.
|
|
38
25
|
*/
|
|
39
26
|
readonly name?: string;
|
|
40
27
|
/**
|
|
41
|
-
*
|
|
42
|
-
*
|
|
43
|
-
* It can be a string or array of strings. If a job fails, all jobs
|
|
28
|
+
* Identifies any jobs that must complete successfully before this job will
|
|
29
|
+
* run. It can be a string or array of strings. If a job fails, all jobs
|
|
44
30
|
* that need it are skipped unless the jobs use a conditional expression
|
|
45
31
|
* that causes the job to continue.
|
|
46
|
-
*
|
|
47
|
-
* @experimental
|
|
48
32
|
*/
|
|
49
33
|
readonly needs?: string[];
|
|
50
34
|
/**
|
|
51
|
-
*
|
|
35
|
+
* You can modify the default permissions granted to the GITHUB_TOKEN, adding
|
|
36
|
+
* or removing access as required, so that you only allow the minimum required
|
|
37
|
+
* access.
|
|
52
38
|
*
|
|
53
39
|
* Use `{ contents: READ }` if your job only needs to clone code.
|
|
54
40
|
*
|
|
@@ -57,23 +43,18 @@ export interface Job {
|
|
|
57
43
|
* access.
|
|
58
44
|
*
|
|
59
45
|
* @see https://docs.github.com/en/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token
|
|
60
|
-
* @experimental
|
|
61
46
|
*/
|
|
62
47
|
readonly permissions: JobPermissions;
|
|
63
48
|
/**
|
|
64
|
-
*
|
|
65
|
-
*
|
|
66
|
-
* All environment protection rules
|
|
49
|
+
* The environment that the job references. All environment protection rules
|
|
67
50
|
* must pass before a job referencing the environment is sent to a runner.
|
|
68
51
|
*
|
|
69
52
|
* @see https://docs.github.com/en/actions/reference/environments
|
|
70
|
-
* @experimental
|
|
71
53
|
*/
|
|
72
54
|
readonly environment?: unknown;
|
|
73
55
|
/**
|
|
74
|
-
*
|
|
75
|
-
*
|
|
76
|
-
* A concurrency group can be any
|
|
56
|
+
* Concurrency ensures that only a single job or workflow using the same
|
|
57
|
+
* concurrency group will run at a time. A concurrency group can be any
|
|
77
58
|
* string or expression. The expression can use any context except for the
|
|
78
59
|
* secrets context.
|
|
79
60
|
*
|
|
@@ -81,379 +62,224 @@ export interface Job {
|
|
|
81
62
|
*/
|
|
82
63
|
readonly concurrency?: unknown;
|
|
83
64
|
/**
|
|
84
|
-
*
|
|
85
|
-
*
|
|
86
|
-
* Job outputs are available to all downstream
|
|
65
|
+
* A map of outputs for a job. Job outputs are available to all downstream
|
|
87
66
|
* jobs that depend on this job.
|
|
88
|
-
*
|
|
89
|
-
* @experimental
|
|
90
67
|
*/
|
|
91
68
|
readonly outputs?: Record<string, JobStepOutput>;
|
|
92
69
|
/**
|
|
93
|
-
*
|
|
94
|
-
*
|
|
95
|
-
* You can also set environment variables for the entire workflow or an
|
|
70
|
+
* A map of environment variables that are available to all steps in the
|
|
71
|
+
* job. You can also set environment variables for the entire workflow or an
|
|
96
72
|
* individual step.
|
|
97
|
-
*
|
|
98
|
-
* @experimental
|
|
99
73
|
*/
|
|
100
74
|
readonly env?: Record<string, string>;
|
|
101
75
|
/**
|
|
102
|
-
*
|
|
103
|
-
*
|
|
104
|
-
* You
|
|
76
|
+
* A map of default settings that will apply to all steps in the job. You
|
|
105
77
|
* can also set default settings for the entire workflow.
|
|
106
|
-
*
|
|
107
|
-
* @experimental
|
|
108
78
|
*/
|
|
109
79
|
readonly defaults?: JobDefaults;
|
|
110
80
|
/**
|
|
111
|
-
*
|
|
112
|
-
*
|
|
113
|
-
* You can use any supported context and expression to
|
|
81
|
+
* You can use the if conditional to prevent a job from running unless a
|
|
82
|
+
* condition is met. You can use any supported context and expression to
|
|
114
83
|
* create a conditional.
|
|
115
|
-
*
|
|
116
|
-
* @experimental
|
|
117
84
|
*/
|
|
118
85
|
readonly if?: string;
|
|
119
86
|
/**
|
|
120
|
-
*
|
|
87
|
+
* The maximum number of minutes to let a job run before GitHub
|
|
88
|
+
* automatically cancels it.
|
|
121
89
|
*
|
|
122
90
|
* @default 360
|
|
123
|
-
* @experimental
|
|
124
91
|
*/
|
|
125
92
|
readonly timeoutMinutes?: number;
|
|
126
93
|
/**
|
|
127
|
-
*
|
|
128
|
-
*
|
|
129
|
-
* You can define different
|
|
94
|
+
* A strategy creates a build matrix for your jobs. You can define different
|
|
130
95
|
* variations to run each job in.
|
|
131
|
-
*
|
|
132
|
-
* @experimental
|
|
133
96
|
*/
|
|
134
97
|
readonly strategy?: JobStrategy;
|
|
135
98
|
/**
|
|
136
|
-
*
|
|
137
|
-
*
|
|
138
|
-
* Set to true to
|
|
99
|
+
* Prevents a workflow run from failing when a job fails. Set to true to
|
|
139
100
|
* allow a workflow run to pass when this job fails.
|
|
140
|
-
*
|
|
141
|
-
* @experimental
|
|
142
101
|
*/
|
|
143
102
|
readonly continueOnError?: boolean;
|
|
144
103
|
/**
|
|
145
|
-
*
|
|
146
|
-
*
|
|
147
|
-
* If you have steps that use both script and container actions,
|
|
104
|
+
* A container to run any steps in a job that don't already specify a
|
|
105
|
+
* container. If you have steps that use both script and container actions,
|
|
148
106
|
* the container actions will run as sibling containers on the same network
|
|
149
107
|
* with the same volume mounts.
|
|
150
|
-
*
|
|
151
|
-
* @experimental
|
|
152
108
|
*/
|
|
153
109
|
readonly container?: ContainerOptions;
|
|
154
110
|
/**
|
|
155
|
-
*
|
|
156
|
-
*
|
|
157
|
-
* Service
|
|
111
|
+
* Used to host service containers for a job in a workflow. Service
|
|
158
112
|
* containers are useful for creating databases or cache services like Redis.
|
|
159
113
|
* The runner automatically creates a Docker network and manages the life
|
|
160
114
|
* cycle of the service containers.
|
|
161
|
-
*
|
|
162
|
-
* @experimental
|
|
163
115
|
*/
|
|
164
116
|
readonly services?: Record<string, ContainerOptions>;
|
|
165
117
|
/**
|
|
166
|
-
*
|
|
167
|
-
*
|
|
168
|
-
* Traslates into `actions/setup-xxx` steps at
|
|
118
|
+
* Tools required for this job. Traslates into `actions/setup-xxx` steps at
|
|
169
119
|
* the beginning of the job.
|
|
170
|
-
*
|
|
171
|
-
* @experimental
|
|
172
120
|
*/
|
|
173
121
|
readonly tools?: Tools;
|
|
174
122
|
}
|
|
175
123
|
/**
|
|
176
|
-
*
|
|
177
|
-
*
|
|
178
|
-
* @experimental
|
|
124
|
+
* Supported tools.
|
|
179
125
|
*/
|
|
180
126
|
export interface Tools {
|
|
181
127
|
/**
|
|
182
|
-
*
|
|
183
|
-
*
|
|
128
|
+
* Setup java (temurin distribution).
|
|
184
129
|
* @default - not installed
|
|
185
|
-
* @experimental
|
|
186
130
|
*/
|
|
187
131
|
readonly java?: ToolRequirement;
|
|
188
132
|
/**
|
|
189
|
-
*
|
|
190
|
-
*
|
|
133
|
+
* Setup python.
|
|
191
134
|
* @default - not installed
|
|
192
|
-
* @experimental
|
|
193
135
|
*/
|
|
194
136
|
readonly python?: ToolRequirement;
|
|
195
137
|
/**
|
|
196
|
-
*
|
|
197
|
-
*
|
|
138
|
+
* Setup golang.
|
|
198
139
|
* @default - not installed
|
|
199
|
-
* @experimental
|
|
200
140
|
*/
|
|
201
141
|
readonly go?: ToolRequirement;
|
|
202
142
|
/**
|
|
203
|
-
*
|
|
204
|
-
*
|
|
143
|
+
* Setup node.js
|
|
205
144
|
* @default - not installed
|
|
206
|
-
* @experimental
|
|
207
145
|
*/
|
|
208
146
|
readonly node?: ToolRequirement;
|
|
209
147
|
/**
|
|
210
|
-
*
|
|
211
|
-
*
|
|
148
|
+
* Setup .NET Core
|
|
212
149
|
* @default - not installed
|
|
213
|
-
* @experimental
|
|
214
150
|
*/
|
|
215
151
|
readonly dotnet?: ToolRequirement;
|
|
216
152
|
}
|
|
217
153
|
/**
|
|
218
|
-
*
|
|
219
|
-
*
|
|
220
|
-
* @experimental
|
|
154
|
+
* Version requirement for tools.
|
|
221
155
|
*/
|
|
222
156
|
export interface ToolRequirement {
|
|
223
|
-
/**
|
|
224
|
-
* @experimental
|
|
225
|
-
*/
|
|
226
157
|
readonly version: string;
|
|
227
158
|
}
|
|
228
159
|
/**
|
|
229
|
-
*
|
|
230
|
-
*
|
|
231
|
-
* If you
|
|
160
|
+
* The available scopes and access values for workflow permissions. If you
|
|
232
161
|
* specify the access for any of these scopes, all those that are not
|
|
233
162
|
* specified are set to `JobPermission.NONE`, instead of the default behavior
|
|
234
163
|
* when none is specified.
|
|
235
|
-
*
|
|
236
|
-
* @experimental
|
|
237
164
|
*/
|
|
238
165
|
export interface JobPermissions {
|
|
239
|
-
/**
|
|
240
|
-
* @experimental
|
|
241
|
-
*/
|
|
242
166
|
readonly actions?: JobPermission;
|
|
243
|
-
/**
|
|
244
|
-
* @experimental
|
|
245
|
-
*/
|
|
246
167
|
readonly checks?: JobPermission;
|
|
247
|
-
/**
|
|
248
|
-
* @experimental
|
|
249
|
-
*/
|
|
250
168
|
readonly contents?: JobPermission;
|
|
251
|
-
/**
|
|
252
|
-
* @experimental
|
|
253
|
-
*/
|
|
254
169
|
readonly deployments?: JobPermission;
|
|
255
|
-
/**
|
|
256
|
-
* @experimental
|
|
257
|
-
*/
|
|
258
170
|
readonly issues?: JobPermission;
|
|
259
|
-
/**
|
|
260
|
-
* @experimental
|
|
261
|
-
*/
|
|
262
171
|
readonly packages?: JobPermission;
|
|
263
|
-
/**
|
|
264
|
-
* @experimental
|
|
265
|
-
*/
|
|
266
172
|
readonly pullRequests?: JobPermission;
|
|
267
|
-
/**
|
|
268
|
-
* @experimental
|
|
269
|
-
*/
|
|
270
173
|
readonly repositoryProjects?: JobPermission;
|
|
271
|
-
/**
|
|
272
|
-
* @experimental
|
|
273
|
-
*/
|
|
274
174
|
readonly securityEvents?: JobPermission;
|
|
275
|
-
/**
|
|
276
|
-
* @experimental
|
|
277
|
-
*/
|
|
278
175
|
readonly statuses?: JobPermission;
|
|
279
176
|
}
|
|
280
177
|
/**
|
|
281
|
-
*
|
|
282
|
-
*
|
|
283
|
-
* @experimental
|
|
178
|
+
* Access level for workflow permission scopes.
|
|
284
179
|
*/
|
|
285
180
|
export declare enum JobPermission {
|
|
286
|
-
/**
|
|
287
|
-
* (experimental) Read-only access.
|
|
288
|
-
*
|
|
289
|
-
* @experimental
|
|
290
|
-
*/
|
|
181
|
+
/** Read-only access */
|
|
291
182
|
READ = "read",
|
|
292
|
-
/**
|
|
293
|
-
* (experimental) Read-write access.
|
|
294
|
-
*
|
|
295
|
-
* @experimental
|
|
296
|
-
*/
|
|
183
|
+
/** Read-write access */
|
|
297
184
|
WRITE = "write",
|
|
298
|
-
/**
|
|
299
|
-
* (experimental) No access at all.
|
|
300
|
-
*
|
|
301
|
-
* @experimental
|
|
302
|
-
*/
|
|
185
|
+
/** No access at all */
|
|
303
186
|
NONE = "none"
|
|
304
187
|
}
|
|
305
188
|
/**
|
|
306
|
-
*
|
|
307
|
-
*
|
|
308
|
-
* @experimental
|
|
189
|
+
* An output binding for a job.
|
|
309
190
|
*/
|
|
310
191
|
export interface JobStepOutput {
|
|
311
192
|
/**
|
|
312
|
-
*
|
|
313
|
-
*
|
|
314
|
-
* @experimental
|
|
193
|
+
* The ID of the step that exposes the output.
|
|
315
194
|
*/
|
|
316
195
|
readonly stepId: string;
|
|
317
196
|
/**
|
|
318
|
-
*
|
|
319
|
-
*
|
|
320
|
-
* @experimental
|
|
197
|
+
* The name of the job output that is being bound.
|
|
321
198
|
*/
|
|
322
199
|
readonly outputName: string;
|
|
323
200
|
}
|
|
324
201
|
/**
|
|
325
|
-
*
|
|
326
|
-
*
|
|
327
|
-
* @experimental
|
|
202
|
+
* Default settings for all steps in the job.
|
|
328
203
|
*/
|
|
329
204
|
export interface JobDefaults {
|
|
330
|
-
/**
|
|
331
|
-
* (experimental) Default run settings.
|
|
332
|
-
*
|
|
333
|
-
* @experimental
|
|
334
|
-
*/
|
|
205
|
+
/** Default run settings. */
|
|
335
206
|
readonly run?: RunSettings;
|
|
336
207
|
}
|
|
337
208
|
/**
|
|
338
|
-
*
|
|
339
|
-
*
|
|
340
|
-
* @experimental
|
|
209
|
+
* Run settings for a job.
|
|
341
210
|
*/
|
|
342
211
|
export interface RunSettings {
|
|
343
212
|
/**
|
|
344
|
-
*
|
|
213
|
+
* Which shell to use for running the step.
|
|
345
214
|
*
|
|
346
|
-
* @
|
|
347
|
-
* @example
|
|
348
|
-
*
|
|
349
|
-
* "bash"
|
|
215
|
+
* @example "bash"
|
|
350
216
|
*/
|
|
351
217
|
readonly shell?: string;
|
|
352
218
|
/**
|
|
353
|
-
*
|
|
354
|
-
*
|
|
355
|
-
* @experimental
|
|
219
|
+
* Working directory to use when running the step.
|
|
356
220
|
*/
|
|
357
221
|
readonly workingDirectory?: string;
|
|
358
222
|
}
|
|
359
223
|
/**
|
|
360
|
-
*
|
|
361
|
-
*
|
|
362
|
-
* @experimental
|
|
224
|
+
* A job step.
|
|
363
225
|
*/
|
|
364
226
|
export interface JobStep {
|
|
365
227
|
/**
|
|
366
|
-
*
|
|
367
|
-
*
|
|
368
|
-
* You can use the id to reference the
|
|
228
|
+
* A unique identifier for the step. You can use the id to reference the
|
|
369
229
|
* step in contexts.
|
|
370
|
-
*
|
|
371
|
-
* @experimental
|
|
372
230
|
*/
|
|
373
231
|
readonly id?: string;
|
|
374
232
|
/**
|
|
375
|
-
*
|
|
376
|
-
*
|
|
377
|
-
* You can use any supported context and expression to
|
|
233
|
+
* You can use the if conditional to prevent a job from running unless a
|
|
234
|
+
* condition is met. You can use any supported context and expression to
|
|
378
235
|
* create a conditional.
|
|
379
|
-
*
|
|
380
|
-
* @experimental
|
|
381
236
|
*/
|
|
382
237
|
readonly if?: string;
|
|
383
238
|
/**
|
|
384
|
-
*
|
|
385
|
-
*
|
|
386
|
-
* @experimental
|
|
239
|
+
* A name for your step to display on GitHub.
|
|
387
240
|
*/
|
|
388
241
|
readonly name?: string;
|
|
389
242
|
/**
|
|
390
|
-
*
|
|
391
|
-
*
|
|
392
|
-
* An action is a
|
|
243
|
+
* Selects an action to run as part of a step in your job. An action is a
|
|
393
244
|
* reusable unit of code. You can use an action defined in the same
|
|
394
245
|
* repository as the workflow, a public repository, or in a published Docker
|
|
395
246
|
* container image.
|
|
396
|
-
*
|
|
397
|
-
* @experimental
|
|
398
247
|
*/
|
|
399
248
|
readonly uses?: string;
|
|
400
249
|
/**
|
|
401
|
-
*
|
|
402
|
-
*
|
|
403
|
-
* If you do
|
|
250
|
+
* Runs command-line programs using the operating system's shell. If you do
|
|
404
251
|
* not provide a name, the step name will default to the text specified in
|
|
405
252
|
* the run command.
|
|
406
|
-
*
|
|
407
|
-
* @experimental
|
|
408
253
|
*/
|
|
409
254
|
readonly run?: string;
|
|
410
255
|
/**
|
|
411
|
-
*
|
|
412
|
-
*
|
|
413
|
-
* Each input parameter
|
|
256
|
+
* A map of the input parameters defined by the action. Each input parameter
|
|
414
257
|
* is a key/value pair. Input parameters are set as environment variables.
|
|
415
258
|
* The variable is prefixed with INPUT_ and converted to upper case.
|
|
416
|
-
*
|
|
417
|
-
* @experimental
|
|
418
259
|
*/
|
|
419
260
|
readonly with?: Record<string, any>;
|
|
420
261
|
/**
|
|
421
|
-
*
|
|
422
|
-
*
|
|
262
|
+
* Sets environment variables for steps to use in the runner environment.
|
|
423
263
|
* You can also set environment variables for the entire workflow or a job.
|
|
424
|
-
*
|
|
425
|
-
* @experimental
|
|
426
264
|
*/
|
|
427
265
|
readonly env?: Record<string, string>;
|
|
428
266
|
/**
|
|
429
|
-
*
|
|
430
|
-
*
|
|
431
|
-
* Set to true to allow a job
|
|
267
|
+
* Prevents a job from failing when a step fails. Set to true to allow a job
|
|
432
268
|
* to pass when this step fails.
|
|
433
|
-
*
|
|
434
|
-
* @experimental
|
|
435
269
|
*/
|
|
436
270
|
readonly continueOnError?: boolean;
|
|
437
271
|
/**
|
|
438
|
-
*
|
|
439
|
-
*
|
|
440
|
-
* @experimental
|
|
272
|
+
* The maximum number of minutes to run the step before killing the process.
|
|
441
273
|
*/
|
|
442
274
|
readonly timeoutMinutes?: number;
|
|
443
275
|
}
|
|
444
276
|
/**
|
|
445
|
-
*
|
|
446
|
-
*
|
|
447
|
-
* You can define different
|
|
277
|
+
* A strategy creates a build matrix for your jobs. You can define different
|
|
448
278
|
* variations to run each job in.
|
|
449
|
-
*
|
|
450
|
-
* @experimental
|
|
451
279
|
*/
|
|
452
280
|
export interface JobStrategy {
|
|
453
281
|
/**
|
|
454
|
-
*
|
|
455
|
-
*
|
|
456
|
-
* A matrix allows
|
|
282
|
+
* You can define a matrix of different job configurations. A matrix allows
|
|
457
283
|
* you to create multiple jobs by performing variable substitution in a
|
|
458
284
|
* single job definition. For example, you can use a matrix to create jobs
|
|
459
285
|
* for more than one supported version of a programming language, operating
|
|
@@ -462,341 +288,240 @@ export interface JobStrategy {
|
|
|
462
288
|
*
|
|
463
289
|
* A job matrix can generate a maximum of 256 jobs per workflow run. This
|
|
464
290
|
* limit also applies to self-hosted runners.
|
|
465
|
-
*
|
|
466
|
-
* @experimental
|
|
467
291
|
*/
|
|
468
292
|
readonly matrix?: JobMatrix;
|
|
469
293
|
/**
|
|
470
|
-
*
|
|
471
|
-
*
|
|
472
|
-
* Default: true
|
|
473
|
-
*
|
|
474
|
-
* @experimental
|
|
294
|
+
* When set to true, GitHub cancels all in-progress jobs if any matrix job
|
|
295
|
+
* fails. Default: true
|
|
475
296
|
*/
|
|
476
297
|
readonly failFast?: boolean;
|
|
477
298
|
/**
|
|
478
|
-
*
|
|
479
|
-
*
|
|
480
|
-
* By default, GitHub will maximize the number of jobs
|
|
299
|
+
* The maximum number of jobs that can run simultaneously when using a
|
|
300
|
+
* matrix job strategy. By default, GitHub will maximize the number of jobs
|
|
481
301
|
* run in parallel depending on the available runners on GitHub-hosted
|
|
482
302
|
* virtual machines.
|
|
483
|
-
*
|
|
484
|
-
* @experimental
|
|
485
303
|
*/
|
|
486
304
|
readonly maxParallel?: number;
|
|
487
305
|
}
|
|
488
306
|
declare type JobMatrixValue = string | boolean | number;
|
|
489
307
|
/**
|
|
490
|
-
*
|
|
491
|
-
*
|
|
492
|
-
* @experimental
|
|
308
|
+
* A job matrix.
|
|
493
309
|
*/
|
|
494
310
|
export interface JobMatrix {
|
|
495
311
|
/**
|
|
496
|
-
*
|
|
497
|
-
*
|
|
498
|
-
* The keys you
|
|
312
|
+
* Each option you define in the matrix has a key and value. The keys you
|
|
499
313
|
* define become properties in the matrix context and you can reference the
|
|
500
314
|
* property in other areas of your workflow file. For example, if you define
|
|
501
315
|
* the key os that contains an array of operating systems, you can use the
|
|
502
316
|
* matrix.os property as the value of the runs-on keyword to create a job
|
|
503
317
|
* for each operating system.
|
|
504
|
-
*
|
|
505
|
-
* @experimental
|
|
506
318
|
*/
|
|
507
319
|
readonly domain?: Record<string, JobMatrixValue[]>;
|
|
508
320
|
/**
|
|
509
|
-
*
|
|
510
|
-
*
|
|
511
|
-
* For example, if you want to use a specific version of npm
|
|
321
|
+
* You can add additional configuration options to a build matrix job that
|
|
322
|
+
* already exists. For example, if you want to use a specific version of npm
|
|
512
323
|
* when the job that uses windows-latest and version 8 of node runs, you can
|
|
513
324
|
* use include to specify that additional option.
|
|
514
|
-
*
|
|
515
|
-
* @experimental
|
|
516
325
|
*/
|
|
517
326
|
readonly include?: Array<Record<string, JobMatrixValue>>;
|
|
518
327
|
/**
|
|
519
|
-
*
|
|
520
|
-
*
|
|
521
|
-
* Using exclude removes a job defined by the
|
|
328
|
+
* You can remove a specific configurations defined in the build matrix
|
|
329
|
+
* using the exclude option. Using exclude removes a job defined by the
|
|
522
330
|
* build matrix.
|
|
523
|
-
*
|
|
524
|
-
* @experimental
|
|
525
331
|
*/
|
|
526
332
|
readonly exclude?: Array<Record<string, JobMatrixValue>>;
|
|
527
333
|
}
|
|
528
334
|
/**
|
|
529
|
-
*
|
|
530
|
-
*
|
|
531
|
-
* @experimental
|
|
335
|
+
* Options petaining to container environments.
|
|
532
336
|
*/
|
|
533
337
|
export interface ContainerOptions {
|
|
534
338
|
/**
|
|
535
|
-
*
|
|
536
|
-
*
|
|
537
|
-
* The value can
|
|
339
|
+
* The Docker image to use as the container to run the action. The value can
|
|
538
340
|
* be the Docker Hub image name or a registry name.
|
|
539
|
-
*
|
|
540
|
-
* @experimental
|
|
541
341
|
*/
|
|
542
342
|
readonly image: string;
|
|
543
343
|
/**
|
|
544
|
-
*
|
|
545
|
-
*
|
|
344
|
+
* f the image's container registry requires authentication to pull the
|
|
345
|
+
* image, you can use credentials to set a map of the username and password.
|
|
546
346
|
* The credentials are the same values that you would provide to the docker
|
|
547
347
|
* login command.
|
|
548
|
-
*
|
|
549
|
-
* @experimental
|
|
550
348
|
*/
|
|
551
349
|
readonly credentials?: ContainerCredentials;
|
|
552
350
|
/**
|
|
553
|
-
*
|
|
554
|
-
*
|
|
555
|
-
* @experimental
|
|
351
|
+
* Sets a map of environment variables in the container.
|
|
556
352
|
*/
|
|
557
353
|
readonly env?: Record<string, string>;
|
|
558
354
|
/**
|
|
559
|
-
*
|
|
560
|
-
*
|
|
561
|
-
* @experimental
|
|
355
|
+
* Sets an array of ports to expose on the container.
|
|
562
356
|
*/
|
|
563
357
|
readonly ports?: number[];
|
|
564
358
|
/**
|
|
565
|
-
*
|
|
566
|
-
*
|
|
567
|
-
* You can use volumes to
|
|
359
|
+
* Sets an array of volumes for the container to use. You can use volumes to
|
|
568
360
|
* share data between services or other steps in a job. You can specify
|
|
569
361
|
* named Docker volumes, anonymous Docker volumes, or bind mounts on the
|
|
570
362
|
* host.
|
|
571
363
|
*
|
|
572
364
|
* To specify a volume, you specify the source and destination path:
|
|
573
365
|
* `<source>:<destinationPath>`.
|
|
574
|
-
*
|
|
575
|
-
* @experimental
|
|
576
366
|
*/
|
|
577
367
|
readonly volumes?: string[];
|
|
578
368
|
/**
|
|
579
|
-
*
|
|
369
|
+
* Additional Docker container resource options.
|
|
580
370
|
*
|
|
581
371
|
* @see https://docs.docker.com/engine/reference/commandline/create/#options
|
|
582
|
-
* @experimental
|
|
583
372
|
*/
|
|
584
373
|
readonly options?: string[];
|
|
585
374
|
}
|
|
586
375
|
/**
|
|
587
|
-
*
|
|
588
|
-
*
|
|
589
|
-
* @experimental
|
|
376
|
+
* Credentials to use to authenticate to Docker registries.
|
|
590
377
|
*/
|
|
591
378
|
export interface ContainerCredentials {
|
|
592
|
-
/**
|
|
593
|
-
* (experimental) The username.
|
|
594
|
-
*
|
|
595
|
-
* @experimental
|
|
596
|
-
*/
|
|
379
|
+
/** The username. */
|
|
597
380
|
readonly username: string;
|
|
598
|
-
/**
|
|
599
|
-
* (experimental) The password.
|
|
600
|
-
*
|
|
601
|
-
* @experimental
|
|
602
|
-
*/
|
|
381
|
+
/** The password. */
|
|
603
382
|
readonly password: string;
|
|
604
383
|
}
|
|
605
384
|
/**
|
|
606
|
-
*
|
|
385
|
+
* The set of available triggers for GitHub Workflows.
|
|
607
386
|
*
|
|
608
387
|
* @see https://docs.github.com/en/actions/reference/events-that-trigger-workflows
|
|
609
|
-
* @experimental
|
|
610
388
|
*/
|
|
611
389
|
export interface Triggers {
|
|
612
390
|
/**
|
|
613
|
-
*
|
|
614
|
-
*
|
|
615
|
-
* Scheduled workflows run on the latest commit on the default or
|
|
391
|
+
* You can schedule a workflow to run at specific UTC times using POSIX cron
|
|
392
|
+
* syntax. Scheduled workflows run on the latest commit on the default or
|
|
616
393
|
* base branch. The shortest interval you can run scheduled workflows is
|
|
617
394
|
* once every 5 minutes.
|
|
618
395
|
*
|
|
619
396
|
* @see https://pubs.opengroup.org/onlinepubs/9699919799/utilities/crontab.html#tag_20_25_07
|
|
620
|
-
* @experimental
|
|
621
397
|
*/
|
|
622
398
|
readonly schedule?: CronScheduleOptions[];
|
|
623
399
|
/**
|
|
624
|
-
*
|
|
625
|
-
*
|
|
626
|
-
* When the
|
|
400
|
+
* You can configure custom-defined input properties, default input values,
|
|
401
|
+
* and required inputs for the event directly in your workflow. When the
|
|
627
402
|
* workflow runs, you can access the input values in the github.event.inputs
|
|
628
403
|
* context.
|
|
629
|
-
*
|
|
630
|
-
* @experimental
|
|
631
404
|
*/
|
|
632
405
|
readonly workflowDispatch?: WorkflowDispatchOptions;
|
|
633
406
|
/**
|
|
634
|
-
*
|
|
635
|
-
*
|
|
636
|
-
*
|
|
407
|
+
* You can use the GitHub API to trigger a webhook event called
|
|
408
|
+
* repository_dispatch when you want to trigger a workflow for activity that
|
|
409
|
+
* happens outside of GitHub.
|
|
637
410
|
*/
|
|
638
411
|
readonly repositoryDispatch?: RepositoryDispatchOptions;
|
|
639
412
|
/**
|
|
640
|
-
*
|
|
641
|
-
*
|
|
413
|
+
* Can be called from another workflow
|
|
642
414
|
* @see https://docs.github.com/en/actions/learn-github-actions/reusing-workflows
|
|
643
|
-
* @experimental
|
|
644
415
|
*/
|
|
645
416
|
readonly workflowCall?: WorkflowCallOptions;
|
|
646
417
|
/**
|
|
647
|
-
*
|
|
648
|
-
*
|
|
649
|
-
* @experimental
|
|
418
|
+
* Runs your workflow anytime the branch_protection_rule event occurs.
|
|
650
419
|
*/
|
|
651
420
|
readonly branchProtectionRule?: BranchProtectionRuleOptions;
|
|
652
421
|
/**
|
|
653
|
-
*
|
|
654
|
-
*
|
|
655
|
-
* @experimental
|
|
422
|
+
* Runs your workflow anytime the check_run event occurs.
|
|
656
423
|
*/
|
|
657
424
|
readonly checkRun?: CheckRunOptions;
|
|
658
425
|
/**
|
|
659
|
-
*
|
|
660
|
-
*
|
|
661
|
-
* @experimental
|
|
426
|
+
* Runs your workflow anytime the check_suite event occurs.
|
|
662
427
|
*/
|
|
663
428
|
readonly checkSuite?: CheckSuiteOptions;
|
|
664
429
|
/**
|
|
665
|
-
*
|
|
666
|
-
*
|
|
667
|
-
* @experimental
|
|
430
|
+
* Runs your workflow anytime someone creates a branch or tag, which
|
|
431
|
+
* triggers the create event.
|
|
668
432
|
*/
|
|
669
433
|
readonly create?: CreateOptions;
|
|
670
434
|
/**
|
|
671
|
-
*
|
|
672
|
-
*
|
|
673
|
-
* @experimental
|
|
435
|
+
* Runs your workflow anytime someone deletes a branch or tag, which
|
|
436
|
+
* triggers the delete event.
|
|
674
437
|
*/
|
|
675
438
|
readonly delete?: DeleteOptions;
|
|
676
439
|
/**
|
|
677
|
-
*
|
|
678
|
-
*
|
|
679
|
-
* Deployments created with a commit SHA may not have
|
|
440
|
+
* Runs your workflow anytime someone creates a deployment, which triggers
|
|
441
|
+
* the deployment event. Deployments created with a commit SHA may not have
|
|
680
442
|
* a Git ref.
|
|
681
|
-
*
|
|
682
|
-
* @experimental
|
|
683
443
|
*/
|
|
684
444
|
readonly deployment?: DeploymentOptions;
|
|
685
445
|
/**
|
|
686
|
-
*
|
|
687
|
-
*
|
|
688
|
-
* Deployments created with a
|
|
446
|
+
* Runs your workflow anytime a third party provides a deployment status,
|
|
447
|
+
* which triggers the deployment_status event. Deployments created with a
|
|
689
448
|
* commit SHA may not have a Git ref.
|
|
690
|
-
*
|
|
691
|
-
* @experimental
|
|
692
449
|
*/
|
|
693
450
|
readonly deploymentStatus?: DeploymentStatusOptions;
|
|
694
451
|
/**
|
|
695
|
-
*
|
|
696
|
-
*
|
|
697
|
-
* More than one activity type triggers this event.
|
|
698
|
-
*
|
|
452
|
+
* Runs your workflow anytime the discussion event occurs. More than one activity type triggers this event.
|
|
699
453
|
* @see https://docs.github.com/en/graphql/guides/using-the-graphql-api-for-discussions
|
|
700
|
-
* @experimental
|
|
701
454
|
*/
|
|
702
455
|
readonly discussion?: DiscussionOptions;
|
|
703
456
|
/**
|
|
704
|
-
*
|
|
705
|
-
*
|
|
706
|
-
* More than one activity type triggers this event.
|
|
707
|
-
*
|
|
457
|
+
* Runs your workflow anytime the discussion_comment event occurs. More than one activity type triggers this event.
|
|
708
458
|
* @see https://docs.github.com/en/graphql/guides/using-the-graphql-api-for-discussions
|
|
709
|
-
* @experimental
|
|
710
459
|
*/
|
|
711
460
|
readonly discussionComment?: DiscussionCommentOptions;
|
|
712
461
|
/**
|
|
713
|
-
*
|
|
714
|
-
*
|
|
715
|
-
* @experimental
|
|
462
|
+
* Runs your workflow anytime when someone forks a repository, which
|
|
463
|
+
* triggers the fork event.
|
|
716
464
|
*/
|
|
717
465
|
readonly fork?: ForkOptions;
|
|
718
466
|
/**
|
|
719
|
-
*
|
|
720
|
-
*
|
|
721
|
-
* @experimental
|
|
467
|
+
* Runs your workflow when someone creates or updates a Wiki page, which
|
|
468
|
+
* triggers the gollum event.
|
|
722
469
|
*/
|
|
723
470
|
readonly gollum?: GollumOptions;
|
|
724
471
|
/**
|
|
725
|
-
*
|
|
726
|
-
*
|
|
727
|
-
* @experimental
|
|
472
|
+
* Runs your workflow anytime the issue_comment event occurs.
|
|
728
473
|
*/
|
|
729
474
|
readonly issueComment?: IssueCommentOptions;
|
|
730
475
|
/**
|
|
731
|
-
*
|
|
732
|
-
*
|
|
733
|
-
* @experimental
|
|
476
|
+
* Runs your workflow anytime the issues event occurs.
|
|
734
477
|
*/
|
|
735
478
|
readonly issues?: IssuesOptions;
|
|
736
479
|
/**
|
|
737
|
-
*
|
|
738
|
-
*
|
|
739
|
-
* @experimental
|
|
480
|
+
* Runs your workflow anytime the label event occurs.
|
|
740
481
|
*/
|
|
741
482
|
readonly label?: LabelOptions;
|
|
742
483
|
/**
|
|
743
|
-
*
|
|
744
|
-
*
|
|
745
|
-
* @experimental
|
|
484
|
+
* Runs your workflow anytime the milestone event occurs.
|
|
746
485
|
*/
|
|
747
486
|
readonly milestone?: MilestoneOptions;
|
|
748
487
|
/**
|
|
749
|
-
*
|
|
750
|
-
*
|
|
751
|
-
* @experimental
|
|
488
|
+
* Runs your workflow anytime someone pushes to a GitHub Pages-enabled
|
|
489
|
+
* branch, which triggers the page_build event.
|
|
752
490
|
*/
|
|
753
491
|
readonly pageBuild?: PageBuildOptions;
|
|
754
492
|
/**
|
|
755
|
-
*
|
|
756
|
-
*
|
|
757
|
-
* @experimental
|
|
493
|
+
* Runs your workflow anytime the project event occurs.
|
|
758
494
|
*/
|
|
759
495
|
readonly project?: ProjectOptions;
|
|
760
496
|
/**
|
|
761
|
-
*
|
|
762
|
-
*
|
|
763
|
-
* @experimental
|
|
497
|
+
* Runs your workflow anytime the project_card event occurs.
|
|
764
498
|
*/
|
|
765
499
|
readonly projectCard?: ProjectCardOptions;
|
|
766
500
|
/**
|
|
767
|
-
*
|
|
768
|
-
*
|
|
769
|
-
* @experimental
|
|
501
|
+
* Runs your workflow anytime the project_column event occurs.
|
|
770
502
|
*/
|
|
771
503
|
readonly projectColumn?: ProjectColumnOptions;
|
|
772
504
|
/**
|
|
773
|
-
*
|
|
774
|
-
*
|
|
775
|
-
* @experimental
|
|
505
|
+
* Runs your workflow anytime someone makes a private repository public,
|
|
506
|
+
* which triggers the public event.
|
|
776
507
|
*/
|
|
777
508
|
readonly public?: PublicOptions;
|
|
778
509
|
/**
|
|
779
|
-
*
|
|
780
|
-
*
|
|
781
|
-
* @experimental
|
|
510
|
+
* Runs your workflow anytime the pull_request event occurs.
|
|
782
511
|
*/
|
|
783
512
|
readonly pullRequest?: PullRequestOptions;
|
|
784
513
|
/**
|
|
785
|
-
*
|
|
786
|
-
*
|
|
787
|
-
* @experimental
|
|
514
|
+
* Runs your workflow anytime the pull_request_review event occurs.
|
|
788
515
|
*/
|
|
789
516
|
readonly pullRequestReview?: PullRequestReviewOptions;
|
|
790
517
|
/**
|
|
791
|
-
*
|
|
792
|
-
*
|
|
793
|
-
* @experimental
|
|
518
|
+
* Runs your workflow anytime a comment on a pull request's unified diff is
|
|
519
|
+
* modified, which triggers the pull_request_review_comment event.
|
|
794
520
|
*/
|
|
795
521
|
readonly pullRequestReviewComment?: PullRequestReviewCommentOptions;
|
|
796
522
|
/**
|
|
797
|
-
*
|
|
798
|
-
*
|
|
799
|
-
* This prevents
|
|
523
|
+
* This event runs in the context of the base of the pull request, rather
|
|
524
|
+
* than in the merge commit as the pull_request event does. This prevents
|
|
800
525
|
* executing unsafe workflow code from the head of the pull request that
|
|
801
526
|
* could alter your repository or steal any secrets you use in your workflow.
|
|
802
527
|
* This event allows you to do things like create workflows that label and
|
|
@@ -812,484 +537,376 @@ export interface Triggers {
|
|
|
812
537
|
* the cache contents were altered.
|
|
813
538
|
*
|
|
814
539
|
* @see https://securitylab.github.com/research/github-actions-preventing-pwn-requests
|
|
815
|
-
* @experimental
|
|
816
540
|
*/
|
|
817
541
|
readonly pullRequestTarget?: PullRequestTargetOptions;
|
|
818
542
|
/**
|
|
819
|
-
*
|
|
820
|
-
*
|
|
821
|
-
* @experimental
|
|
543
|
+
* Runs your workflow when someone pushes to a repository branch, which
|
|
544
|
+
* triggers the push event.
|
|
822
545
|
*/
|
|
823
546
|
readonly push?: PushOptions;
|
|
824
547
|
/**
|
|
825
|
-
*
|
|
826
|
-
*
|
|
827
|
-
* @experimental
|
|
548
|
+
* Runs your workflow anytime a package is published or updated.
|
|
828
549
|
*/
|
|
829
550
|
readonly registryPackage?: RegistryPackageOptions;
|
|
830
551
|
/**
|
|
831
|
-
*
|
|
832
|
-
*
|
|
833
|
-
* @experimental
|
|
552
|
+
* Runs your workflow anytime the release event occurs.
|
|
834
553
|
*/
|
|
835
554
|
readonly release?: ReleaseOptions;
|
|
836
555
|
/**
|
|
837
|
-
*
|
|
838
|
-
*
|
|
839
|
-
* @experimental
|
|
556
|
+
* Runs your workflow anytime the status of a Git commit changes, which
|
|
557
|
+
* triggers the status event.
|
|
840
558
|
*/
|
|
841
559
|
readonly status?: StatusOptions;
|
|
842
560
|
/**
|
|
843
|
-
*
|
|
844
|
-
*
|
|
845
|
-
* @experimental
|
|
561
|
+
* Runs your workflow anytime the watch event occurs.
|
|
846
562
|
*/
|
|
847
563
|
readonly watch?: WatchOptions;
|
|
848
564
|
/**
|
|
849
|
-
*
|
|
850
|
-
*
|
|
851
|
-
* A workflow run is triggered regardless of the result of the
|
|
565
|
+
* This event occurs when a workflow run is requested or completed, and
|
|
566
|
+
* allows you to execute a workflow based on the finished result of another
|
|
567
|
+
* workflow. A workflow run is triggered regardless of the result of the
|
|
852
568
|
* previous workflow.
|
|
853
|
-
*
|
|
854
|
-
* @experimental
|
|
855
569
|
*/
|
|
856
570
|
readonly workflowRun?: WorkflowRunOptions;
|
|
857
571
|
}
|
|
858
572
|
/**
|
|
859
|
-
*
|
|
860
|
-
*
|
|
861
|
-
* @experimental
|
|
573
|
+
* CRON schedule options.
|
|
862
574
|
*/
|
|
863
575
|
export interface CronScheduleOptions {
|
|
864
576
|
/**
|
|
865
577
|
* @see https://pubs.opengroup.org/onlinepubs/9699919799/utilities/crontab.html#tag_20_25_07
|
|
866
|
-
* @experimental
|
|
867
578
|
*/
|
|
868
579
|
readonly cron: string;
|
|
869
580
|
}
|
|
870
581
|
/**
|
|
871
|
-
*
|
|
872
|
-
*
|
|
873
|
-
* @experimental
|
|
582
|
+
* Repository dispatch options.
|
|
874
583
|
*/
|
|
875
584
|
export interface RepositoryDispatchOptions {
|
|
876
585
|
/**
|
|
877
|
-
*
|
|
586
|
+
* Which activity types to trigger on.
|
|
878
587
|
*
|
|
879
|
-
* @experimental
|
|
880
588
|
* @defaults - all activity types
|
|
881
589
|
*/
|
|
882
590
|
readonly types?: string[];
|
|
883
591
|
}
|
|
884
592
|
/**
|
|
885
|
-
*
|
|
886
|
-
*
|
|
887
|
-
* @experimental
|
|
593
|
+
* Branch Protection Rule options
|
|
888
594
|
*/
|
|
889
595
|
export interface BranchProtectionRuleOptions {
|
|
890
596
|
/**
|
|
891
|
-
*
|
|
597
|
+
* Which activity types to trigger on.
|
|
892
598
|
*
|
|
893
|
-
* @experimental
|
|
894
599
|
* @defaults - all activity types
|
|
895
600
|
*/
|
|
896
601
|
readonly types?: Array<"created" | "edited" | "deleted">;
|
|
897
602
|
}
|
|
898
603
|
/**
|
|
899
|
-
*
|
|
900
|
-
*
|
|
901
|
-
* @experimental
|
|
604
|
+
* Check run options.
|
|
902
605
|
*/
|
|
903
606
|
export interface CheckRunOptions {
|
|
904
607
|
/**
|
|
905
|
-
*
|
|
608
|
+
* Which activity types to trigger on.
|
|
906
609
|
*
|
|
907
|
-
* @experimental
|
|
908
610
|
* @defaults - all activity types
|
|
909
611
|
*/
|
|
910
612
|
readonly types?: Array<"create" | "rerequested" | "completed" | "requested_action">;
|
|
911
613
|
}
|
|
912
614
|
/**
|
|
913
|
-
*
|
|
914
|
-
*
|
|
915
|
-
* @experimental
|
|
615
|
+
* Check suite options
|
|
916
616
|
*/
|
|
917
617
|
export interface CheckSuiteOptions {
|
|
918
618
|
/**
|
|
919
|
-
*
|
|
619
|
+
* Which activity types to trigger on.
|
|
920
620
|
*
|
|
921
|
-
* @experimental
|
|
922
621
|
* @defaults - all activity types
|
|
923
622
|
*/
|
|
924
623
|
readonly types?: Array<"completed" | "requested" | "rerequested">;
|
|
925
624
|
}
|
|
926
625
|
/**
|
|
927
|
-
*
|
|
928
|
-
*
|
|
929
|
-
* @experimental
|
|
626
|
+
* Discussion options
|
|
930
627
|
*/
|
|
931
628
|
export interface DiscussionOptions {
|
|
932
629
|
/**
|
|
933
|
-
*
|
|
630
|
+
* Which activity types to trigger on.
|
|
934
631
|
*
|
|
935
|
-
* @experimental
|
|
936
632
|
* @defaults - all activity types
|
|
937
633
|
*/
|
|
938
634
|
readonly types?: Array<"created" | "edited" | "transferred" | "pinned" | "unpinned" | "labeled" | "unlabeled" | "locked" | "unlocked" | "category_changed" | "answered" | "unanswered">;
|
|
939
635
|
}
|
|
940
636
|
/**
|
|
941
|
-
*
|
|
942
|
-
*
|
|
943
|
-
* @experimental
|
|
637
|
+
* Discussion comment options
|
|
944
638
|
*/
|
|
945
639
|
export interface DiscussionCommentOptions {
|
|
946
640
|
/**
|
|
947
|
-
*
|
|
641
|
+
* Which activity types to trigger on.
|
|
948
642
|
*
|
|
949
|
-
* @experimental
|
|
950
643
|
* @defaults - all activity types
|
|
951
644
|
*/
|
|
952
645
|
readonly types?: Array<"created" | "edited" | "deleted">;
|
|
953
646
|
}
|
|
954
647
|
/**
|
|
955
|
-
*
|
|
956
|
-
*
|
|
957
|
-
* @experimental
|
|
648
|
+
* Issue comment options
|
|
958
649
|
*/
|
|
959
650
|
export interface IssueCommentOptions {
|
|
960
651
|
/**
|
|
961
|
-
*
|
|
652
|
+
* Which activity types to trigger on.
|
|
962
653
|
*
|
|
963
|
-
* @experimental
|
|
964
654
|
* @defaults - all activity types
|
|
965
655
|
*/
|
|
966
656
|
readonly types?: Array<"created" | "edited" | "deleted">;
|
|
967
657
|
}
|
|
968
658
|
/**
|
|
969
|
-
*
|
|
970
|
-
*
|
|
971
|
-
* @experimental
|
|
659
|
+
* Issues options
|
|
972
660
|
*/
|
|
973
661
|
export interface IssuesOptions {
|
|
974
662
|
/**
|
|
975
|
-
*
|
|
663
|
+
* Which activity types to trigger on.
|
|
976
664
|
*
|
|
977
|
-
* @experimental
|
|
978
665
|
* @defaults - all activity types
|
|
979
666
|
*/
|
|
980
667
|
readonly types?: Array<"opened" | "edited" | "deleted" | "transferred" | "pinned" | "unpinned" | "closed" | "reopened" | "assigned" | "unassigned" | "labeled" | "unlabeled" | "locked" | "unlocked" | "milestoned" | "demilestoned">;
|
|
981
668
|
}
|
|
982
669
|
/**
|
|
983
|
-
*
|
|
984
|
-
*
|
|
985
|
-
* @experimental
|
|
670
|
+
* label options
|
|
986
671
|
*/
|
|
987
672
|
export interface LabelOptions {
|
|
988
673
|
/**
|
|
989
|
-
*
|
|
674
|
+
* Which activity types to trigger on.
|
|
990
675
|
*
|
|
991
|
-
* @experimental
|
|
992
676
|
* @defaults - all activity types
|
|
993
677
|
*/
|
|
994
678
|
readonly types?: Array<"created" | "edited" | "deleted">;
|
|
995
679
|
}
|
|
996
680
|
/**
|
|
997
|
-
*
|
|
998
|
-
*
|
|
999
|
-
* @experimental
|
|
681
|
+
* Milestone options
|
|
1000
682
|
*/
|
|
1001
683
|
export interface MilestoneOptions {
|
|
1002
684
|
/**
|
|
1003
|
-
*
|
|
685
|
+
* Which activity types to trigger on.
|
|
1004
686
|
*
|
|
1005
|
-
* @experimental
|
|
1006
687
|
* @defaults - all activity types
|
|
1007
688
|
*/
|
|
1008
689
|
readonly types?: Array<"created" | "closed" | "opened" | "edited" | "deleted">;
|
|
1009
690
|
}
|
|
1010
691
|
/**
|
|
1011
|
-
*
|
|
1012
|
-
*
|
|
1013
|
-
* @experimental
|
|
692
|
+
* Project options
|
|
1014
693
|
*/
|
|
1015
694
|
export interface ProjectOptions {
|
|
1016
695
|
/**
|
|
1017
|
-
*
|
|
696
|
+
* Which activity types to trigger on.
|
|
1018
697
|
*
|
|
1019
|
-
* @experimental
|
|
1020
698
|
* @defaults - all activity types
|
|
1021
699
|
*/
|
|
1022
700
|
readonly types?: Array<"created" | "updated" | "closed" | "reopened" | "edited" | "deleted">;
|
|
1023
701
|
}
|
|
1024
702
|
/**
|
|
1025
|
-
*
|
|
1026
|
-
*
|
|
1027
|
-
* @experimental
|
|
703
|
+
* Project card options
|
|
1028
704
|
*/
|
|
1029
705
|
export interface ProjectCardOptions {
|
|
1030
706
|
/**
|
|
1031
|
-
*
|
|
707
|
+
* Which activity types to trigger on.
|
|
1032
708
|
*
|
|
1033
|
-
* @experimental
|
|
1034
709
|
* @defaults - all activity types
|
|
1035
710
|
*/
|
|
1036
711
|
readonly types?: Array<"created" | "moved" | "converted" | "edited" | "deleted">;
|
|
1037
712
|
}
|
|
1038
713
|
/**
|
|
1039
|
-
*
|
|
1040
|
-
*
|
|
1041
|
-
* @experimental
|
|
714
|
+
* Probject column options
|
|
1042
715
|
*/
|
|
1043
716
|
export interface ProjectColumnOptions {
|
|
1044
717
|
/**
|
|
1045
|
-
*
|
|
718
|
+
* Which activity types to trigger on.
|
|
1046
719
|
*
|
|
1047
|
-
* @experimental
|
|
1048
720
|
* @defaults - all activity types
|
|
1049
721
|
*/
|
|
1050
722
|
readonly types?: Array<"created" | "updated" | "moved" | "deleted">;
|
|
1051
723
|
}
|
|
1052
724
|
/**
|
|
1053
|
-
*
|
|
1054
|
-
*
|
|
1055
|
-
* @experimental
|
|
725
|
+
* Pull request options
|
|
1056
726
|
*/
|
|
1057
727
|
export interface PullRequestOptions {
|
|
1058
728
|
/**
|
|
1059
|
-
*
|
|
729
|
+
* Which activity types to trigger on.
|
|
1060
730
|
*
|
|
1061
|
-
* @experimental
|
|
1062
731
|
* @defaults - all activity types
|
|
1063
732
|
*/
|
|
1064
733
|
readonly types?: Array<"assigned" | "unassigned" | "labeled" | "unlabeled" | "opened" | "edited" | "closed" | "reopened" | "synchronize" | "ready_for_review" | "locked" | "unlocked" | "review_requested" | "review_request_removed">;
|
|
1065
734
|
}
|
|
1066
735
|
/**
|
|
1067
|
-
*
|
|
1068
|
-
*
|
|
1069
|
-
* @experimental
|
|
736
|
+
* Pull request review options
|
|
1070
737
|
*/
|
|
1071
738
|
export interface PullRequestReviewOptions {
|
|
1072
739
|
/**
|
|
1073
|
-
*
|
|
740
|
+
* Which activity types to trigger on.
|
|
1074
741
|
*
|
|
1075
|
-
* @experimental
|
|
1076
742
|
* @defaults - all activity types
|
|
1077
743
|
*/
|
|
1078
744
|
readonly types?: Array<"submitted" | "edited" | "dismissed">;
|
|
1079
745
|
}
|
|
1080
746
|
/**
|
|
1081
|
-
*
|
|
1082
|
-
*
|
|
1083
|
-
* @experimental
|
|
747
|
+
* Pull request review comment options
|
|
1084
748
|
*/
|
|
1085
749
|
export interface PullRequestReviewCommentOptions {
|
|
1086
750
|
/**
|
|
1087
|
-
*
|
|
751
|
+
* Which activity types to trigger on.
|
|
1088
752
|
*
|
|
1089
|
-
* @experimental
|
|
1090
753
|
* @defaults - all activity types
|
|
1091
754
|
*/
|
|
1092
755
|
readonly types?: Array<"created" | "edited" | "deleted">;
|
|
1093
756
|
}
|
|
1094
757
|
/**
|
|
1095
|
-
*
|
|
1096
|
-
*
|
|
1097
|
-
* @experimental
|
|
758
|
+
* Pull request target options.
|
|
1098
759
|
*/
|
|
1099
760
|
export interface PullRequestTargetOptions extends PushOptions {
|
|
1100
761
|
/**
|
|
1101
|
-
*
|
|
762
|
+
* Which activity types to trigger on.
|
|
1102
763
|
*
|
|
1103
|
-
* @experimental
|
|
1104
764
|
* @defaults - all activity types
|
|
1105
765
|
*/
|
|
1106
766
|
readonly types?: Array<"assigned" | "unassigned" | "labeled" | "unlabeled" | "opened" | "edited" | "closed" | "reopened" | "synchronize" | "ready_for_review" | "locked" | "unlocked" | "review_requested" | "review_request_removed">;
|
|
1107
767
|
}
|
|
1108
768
|
/**
|
|
1109
|
-
*
|
|
1110
|
-
*
|
|
1111
|
-
* @experimental
|
|
769
|
+
* Options for push-like events.
|
|
1112
770
|
*/
|
|
1113
771
|
export interface PushOptions {
|
|
1114
772
|
/**
|
|
1115
|
-
*
|
|
1116
|
-
*
|
|
1117
|
-
* For a pull_request event, only
|
|
773
|
+
* When using the push and pull_request events, you can configure a workflow
|
|
774
|
+
* to run on specific branches or tags. For a pull_request event, only
|
|
1118
775
|
* branches and tags on the base are evaluated. If you define only tags or
|
|
1119
776
|
* only branches, the workflow won't run for events affecting the undefined
|
|
1120
777
|
* Git ref.
|
|
1121
778
|
*
|
|
1122
779
|
* @see https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet
|
|
1123
|
-
* @experimental
|
|
1124
780
|
*/
|
|
1125
781
|
readonly branches?: string[];
|
|
1126
782
|
/**
|
|
1127
|
-
*
|
|
1128
|
-
*
|
|
1129
|
-
* For a pull_request event, only
|
|
783
|
+
* When using the push and pull_request events, you can configure a workflow
|
|
784
|
+
* to run on specific branches or tags. For a pull_request event, only
|
|
1130
785
|
* branches and tags on the base are evaluated. If you define only tags or
|
|
1131
786
|
* only branches, the workflow won't run for events affecting the undefined
|
|
1132
787
|
* Git ref.
|
|
1133
788
|
*
|
|
1134
789
|
* @see https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet
|
|
1135
|
-
* @experimental
|
|
1136
790
|
*/
|
|
1137
791
|
readonly tags?: string[];
|
|
1138
792
|
/**
|
|
1139
|
-
*
|
|
1140
|
-
*
|
|
1141
|
-
* Path filters are not
|
|
793
|
+
* When using the push and pull_request events, you can configure a workflow
|
|
794
|
+
* to run when at least one file does not match paths-ignore or at least one
|
|
795
|
+
* modified file matches the configured paths. Path filters are not
|
|
1142
796
|
* evaluated for pushes to tags.
|
|
1143
797
|
*
|
|
1144
798
|
* @see https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet
|
|
1145
|
-
* @experimental
|
|
1146
799
|
*/
|
|
1147
800
|
readonly paths?: string[];
|
|
1148
801
|
}
|
|
1149
802
|
/**
|
|
1150
|
-
*
|
|
1151
|
-
*
|
|
1152
|
-
* @experimental
|
|
803
|
+
* Registry package options
|
|
1153
804
|
*/
|
|
1154
805
|
export interface RegistryPackageOptions {
|
|
1155
806
|
/**
|
|
1156
|
-
*
|
|
807
|
+
* Which activity types to trigger on.
|
|
1157
808
|
*
|
|
1158
|
-
* @experimental
|
|
1159
809
|
* @defaults - all activity types
|
|
1160
810
|
*/
|
|
1161
811
|
readonly types?: Array<"published" | "updated">;
|
|
1162
812
|
}
|
|
1163
813
|
/**
|
|
1164
|
-
*
|
|
1165
|
-
*
|
|
1166
|
-
* @experimental
|
|
814
|
+
* Release options
|
|
1167
815
|
*/
|
|
1168
816
|
export interface ReleaseOptions {
|
|
1169
817
|
/**
|
|
1170
|
-
*
|
|
818
|
+
* Which activity types to trigger on.
|
|
1171
819
|
*
|
|
1172
|
-
* @experimental
|
|
1173
820
|
* @defaults - all activity types
|
|
1174
821
|
*/
|
|
1175
822
|
readonly types?: Array<"published" | "unpublished" | "created" | "edited" | "deleted" | "prereleased" | "released">;
|
|
1176
823
|
}
|
|
1177
824
|
/**
|
|
1178
|
-
*
|
|
1179
|
-
*
|
|
1180
|
-
* @experimental
|
|
825
|
+
* Watch options
|
|
1181
826
|
*/
|
|
1182
827
|
export interface WatchOptions {
|
|
1183
828
|
/**
|
|
1184
|
-
*
|
|
829
|
+
* Which activity types to trigger on.
|
|
1185
830
|
*
|
|
1186
|
-
* @experimental
|
|
1187
831
|
* @defaults - all activity types
|
|
1188
832
|
*/
|
|
1189
833
|
readonly types?: Array<"started">;
|
|
1190
834
|
}
|
|
1191
835
|
/**
|
|
1192
|
-
*
|
|
1193
|
-
*
|
|
1194
|
-
* @experimental
|
|
836
|
+
* Workflow run options
|
|
1195
837
|
*/
|
|
1196
838
|
export interface WorkflowRunOptions {
|
|
1197
839
|
/**
|
|
1198
|
-
*
|
|
840
|
+
* Which workflow to trigger on.
|
|
1199
841
|
*
|
|
1200
|
-
* @experimental
|
|
1201
842
|
* @defaults - any workflows
|
|
1202
843
|
*/
|
|
1203
844
|
readonly workflows?: Array<string>;
|
|
1204
845
|
/**
|
|
1205
|
-
*
|
|
846
|
+
* Which activity types to trigger on.
|
|
1206
847
|
*
|
|
1207
|
-
* @experimental
|
|
1208
848
|
* @defaults - all activity types
|
|
1209
849
|
*/
|
|
1210
850
|
readonly types?: Array<"completed" | "requested">;
|
|
1211
851
|
/**
|
|
1212
|
-
*
|
|
852
|
+
* Which branches or branch-ignore to limit the trigger to.
|
|
1213
853
|
*
|
|
1214
|
-
* @experimental
|
|
1215
854
|
* @defaults - no branch limits
|
|
1216
855
|
*/
|
|
1217
856
|
readonly branches?: Array<string>;
|
|
1218
857
|
}
|
|
1219
858
|
/**
|
|
1220
|
-
*
|
|
1221
|
-
*
|
|
1222
|
-
* @experimental
|
|
859
|
+
* The Workflow dispatch event accepts no options.
|
|
1223
860
|
*/
|
|
1224
861
|
export interface WorkflowDispatchOptions {
|
|
1225
862
|
}
|
|
1226
863
|
/**
|
|
1227
|
-
*
|
|
1228
|
-
*
|
|
1229
|
-
* @experimental
|
|
864
|
+
* The Workflow Call event accepts no options.
|
|
1230
865
|
*/
|
|
1231
866
|
export interface WorkflowCallOptions {
|
|
1232
867
|
}
|
|
1233
868
|
/**
|
|
1234
|
-
*
|
|
1235
|
-
*
|
|
1236
|
-
* @experimental
|
|
869
|
+
* The Create event accepts no options.
|
|
1237
870
|
*/
|
|
1238
871
|
export interface CreateOptions {
|
|
1239
872
|
}
|
|
1240
873
|
/**
|
|
1241
|
-
*
|
|
1242
|
-
*
|
|
1243
|
-
* @experimental
|
|
874
|
+
* The Delete event accepts no options.
|
|
1244
875
|
*/
|
|
1245
876
|
export interface DeleteOptions {
|
|
1246
877
|
}
|
|
1247
878
|
/**
|
|
1248
|
-
*
|
|
1249
|
-
*
|
|
1250
|
-
* @experimental
|
|
879
|
+
* The Deployment event accepts no options.
|
|
1251
880
|
*/
|
|
1252
881
|
export interface DeploymentOptions {
|
|
1253
882
|
}
|
|
1254
883
|
/**
|
|
1255
|
-
*
|
|
1256
|
-
*
|
|
1257
|
-
* @experimental
|
|
884
|
+
* The Deployment status event accepts no options.
|
|
1258
885
|
*/
|
|
1259
886
|
export interface DeploymentStatusOptions {
|
|
1260
887
|
}
|
|
1261
888
|
/**
|
|
1262
|
-
*
|
|
1263
|
-
*
|
|
1264
|
-
* @experimental
|
|
889
|
+
* The Fork event accepts no options.
|
|
1265
890
|
*/
|
|
1266
891
|
export interface ForkOptions {
|
|
1267
892
|
}
|
|
1268
893
|
/**
|
|
1269
|
-
*
|
|
1270
|
-
*
|
|
1271
|
-
* @experimental
|
|
894
|
+
* The Gollum event accepts no options.
|
|
1272
895
|
*/
|
|
1273
896
|
export interface GollumOptions {
|
|
1274
897
|
}
|
|
1275
898
|
/**
|
|
1276
|
-
*
|
|
1277
|
-
*
|
|
1278
|
-
* @experimental
|
|
899
|
+
* The Page build event accepts no options.
|
|
1279
900
|
*/
|
|
1280
901
|
export interface PageBuildOptions {
|
|
1281
902
|
}
|
|
1282
903
|
/**
|
|
1283
|
-
*
|
|
1284
|
-
*
|
|
1285
|
-
* @experimental
|
|
904
|
+
* The Public event accepts no options.
|
|
1286
905
|
*/
|
|
1287
906
|
export interface PublicOptions {
|
|
1288
907
|
}
|
|
1289
908
|
/**
|
|
1290
|
-
*
|
|
1291
|
-
*
|
|
1292
|
-
* @experimental
|
|
909
|
+
* The Status event accepts no options.
|
|
1293
910
|
*/
|
|
1294
911
|
export interface StatusOptions {
|
|
1295
912
|
}
|