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,1212 +1,461 @@
|
|
|
1
1
|
/**
|
|
2
|
-
*
|
|
3
|
-
*
|
|
2
|
+
* Cache Definition.
|
|
4
3
|
* @see https://docs.gitlab.com/ee/ci/yaml/#cache
|
|
5
|
-
* @experimental
|
|
6
4
|
*/
|
|
7
5
|
export interface Cache {
|
|
8
|
-
/**
|
|
9
|
-
* (experimental) Defines when to save the cache, based on the status of the job (Default: Job Success).
|
|
10
|
-
*
|
|
11
|
-
* @experimental
|
|
12
|
-
*/
|
|
6
|
+
/** Defines when to save the cache, based on the status of the job (Default: Job Success). */
|
|
13
7
|
readonly when?: CacheWhen;
|
|
14
8
|
}
|
|
15
9
|
/**
|
|
16
|
-
*
|
|
17
|
-
*
|
|
10
|
+
* Configure when artifacts are uploaded depended on job status.
|
|
18
11
|
* @see https://docs.gitlab.com/ee/ci/yaml/#cachewhen
|
|
19
|
-
* @experimental
|
|
20
12
|
*/
|
|
21
13
|
export declare enum CacheWhen {
|
|
22
|
-
/**
|
|
23
|
-
* (experimental) Upload artifacts regardless of job status.
|
|
24
|
-
*
|
|
25
|
-
* @experimental
|
|
26
|
-
*/
|
|
14
|
+
/** Upload artifacts regardless of job status. */
|
|
27
15
|
ALWAYS = "always",
|
|
28
|
-
/**
|
|
29
|
-
* (experimental) Upload artifacts only when the job fails.
|
|
30
|
-
*
|
|
31
|
-
* @experimental
|
|
32
|
-
*/
|
|
16
|
+
/** Upload artifacts only when the job fails. */
|
|
33
17
|
ON_FAILURE = "on_failure",
|
|
34
|
-
/**
|
|
35
|
-
* (experimental) Upload artifacts only when the job succeeds (this is the default).
|
|
36
|
-
*
|
|
37
|
-
* @experimental
|
|
38
|
-
*/
|
|
18
|
+
/** Upload artifacts only when the job succeeds (this is the default). */
|
|
39
19
|
ON_SUCCESS = "on_success"
|
|
40
20
|
}
|
|
41
21
|
/**
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
* Jobs that do not define one or more of the listed keywords use the value defined in the default section.
|
|
45
|
-
*
|
|
22
|
+
* Default settings for the CI Configuration. Jobs that do not define one or more of the listed keywords use the value defined in the default section.
|
|
46
23
|
* @see https://docs.gitlab.com/ee/ci/yaml/#default
|
|
47
|
-
* @experimental
|
|
48
24
|
*/
|
|
49
25
|
export interface Default {
|
|
50
|
-
/**
|
|
51
|
-
* @experimental
|
|
52
|
-
*/
|
|
53
26
|
readonly afterScript?: string[];
|
|
54
|
-
/**
|
|
55
|
-
* @experimental
|
|
56
|
-
*/
|
|
57
27
|
readonly artifacts?: Artifacts;
|
|
58
|
-
/**
|
|
59
|
-
* @experimental
|
|
60
|
-
*/
|
|
61
28
|
readonly beforeScript?: string[];
|
|
62
|
-
/**
|
|
63
|
-
* @experimental
|
|
64
|
-
*/
|
|
65
29
|
readonly cache?: Cache;
|
|
66
|
-
/**
|
|
67
|
-
* @experimental
|
|
68
|
-
*/
|
|
69
30
|
readonly image?: Image;
|
|
70
|
-
/**
|
|
71
|
-
* @experimental
|
|
72
|
-
*/
|
|
73
31
|
readonly interruptible?: boolean;
|
|
74
|
-
/**
|
|
75
|
-
* @experimental
|
|
76
|
-
*/
|
|
77
32
|
readonly retry?: Retry;
|
|
78
|
-
/**
|
|
79
|
-
* @experimental
|
|
80
|
-
*/
|
|
81
33
|
readonly services?: Service[];
|
|
82
|
-
/**
|
|
83
|
-
* @experimental
|
|
84
|
-
*/
|
|
85
34
|
readonly tags?: string[];
|
|
86
|
-
/**
|
|
87
|
-
* @experimental
|
|
88
|
-
*/
|
|
89
35
|
readonly timeout?: string;
|
|
90
36
|
}
|
|
91
37
|
/**
|
|
92
|
-
*
|
|
93
|
-
*
|
|
94
|
-
* Artifacts are sent to Gitlab where they can be downloaded.
|
|
95
|
-
*
|
|
38
|
+
* Used to specify a list of files and directories that should be attached to the job if it
|
|
39
|
+
* succeeds. Artifacts are sent to Gitlab where they can be downloaded.
|
|
96
40
|
* @see https://docs.gitlab.com/ee/ci/yaml/#artifacts
|
|
97
|
-
* @experimental
|
|
98
41
|
*/
|
|
99
42
|
export interface Artifacts {
|
|
100
|
-
/**
|
|
101
|
-
* (experimental) A list of paths to files/folders that should be excluded in the artifact.
|
|
102
|
-
*
|
|
103
|
-
* @experimental
|
|
104
|
-
*/
|
|
43
|
+
/** A list of paths to files/folders that should be excluded in the artifact. */
|
|
105
44
|
readonly exclude?: string[];
|
|
106
|
-
/**
|
|
107
|
-
* (experimental) How long artifacts should be kept.
|
|
108
|
-
*
|
|
109
|
-
* They are saved 30 days by default. Artifacts that have expired are removed periodically via cron job. Supports a wide variety of formats, e.g. '1 week', '3 mins 4 sec', '2 hrs 20 min', '2h20min', '6 mos 1 day', '47 yrs 6 mos and 4d', '3 weeks and 2 days'.
|
|
110
|
-
*
|
|
111
|
-
* @experimental
|
|
112
|
-
*/
|
|
45
|
+
/** How long artifacts should be kept. They are saved 30 days by default. Artifacts that have expired are removed periodically via cron job. Supports a wide variety of formats, e.g. '1 week', '3 mins 4 sec', '2 hrs 20 min', '2h20min', '6 mos 1 day', '47 yrs 6 mos and 4d', '3 weeks and 2 days'. */
|
|
113
46
|
readonly expireIn?: string;
|
|
114
|
-
/**
|
|
115
|
-
* (experimental) Can be used to expose job artifacts in the merge request UI.
|
|
116
|
-
*
|
|
117
|
-
* GitLab will add a link <expose_as> to the relevant merge request that points to the artifact.
|
|
118
|
-
*
|
|
119
|
-
* @experimental
|
|
120
|
-
*/
|
|
47
|
+
/** Can be used to expose job artifacts in the merge request UI. GitLab will add a link <expose_as> to the relevant merge request that points to the artifact. */
|
|
121
48
|
readonly exposeAs?: string;
|
|
122
|
-
/**
|
|
123
|
-
* (experimental) Name for the archive created on job success.
|
|
124
|
-
*
|
|
125
|
-
* Can use variables in the name, e.g. '$CI_JOB_NAME'
|
|
126
|
-
*
|
|
127
|
-
* @experimental
|
|
128
|
-
*/
|
|
49
|
+
/** Name for the archive created on job success. Can use variables in the name, e.g. '$CI_JOB_NAME' */
|
|
129
50
|
readonly name?: string;
|
|
130
|
-
/**
|
|
131
|
-
* (experimental) A list of paths to files/folders that should be included in the artifact.
|
|
132
|
-
*
|
|
133
|
-
* @experimental
|
|
134
|
-
*/
|
|
51
|
+
/** A list of paths to files/folders that should be included in the artifact. */
|
|
135
52
|
readonly paths?: string[];
|
|
136
|
-
/**
|
|
137
|
-
* (experimental) Reports will be uploaded as artifacts, and often displayed in the Gitlab UI, such as in Merge Requests.
|
|
138
|
-
*
|
|
139
|
-
* @experimental
|
|
140
|
-
*/
|
|
53
|
+
/** Reports will be uploaded as artifacts, and often displayed in the Gitlab UI, such as in Merge Requests.*/
|
|
141
54
|
readonly reports?: Reports;
|
|
142
|
-
/**
|
|
143
|
-
* (experimental) Whether to add all untracked files (along with 'artifacts.paths') to the artifact.
|
|
144
|
-
*
|
|
145
|
-
* @experimental
|
|
146
|
-
*/
|
|
55
|
+
/** Whether to add all untracked files (along with 'artifacts.paths') to the artifact.*/
|
|
147
56
|
readonly untracked?: boolean;
|
|
148
|
-
/**
|
|
149
|
-
* (experimental) Configure when artifacts are uploaded depended on job status.
|
|
150
|
-
*
|
|
151
|
-
* @experimental
|
|
152
|
-
*/
|
|
57
|
+
/** Configure when artifacts are uploaded depended on job status.*/
|
|
153
58
|
readonly when?: CacheWhen;
|
|
154
59
|
}
|
|
155
60
|
/**
|
|
156
|
-
*
|
|
157
|
-
*
|
|
61
|
+
* Reports will be uploaded as artifacts, and often displayed in the Gitlab UI, such as in
|
|
62
|
+
* Merge Requests.
|
|
158
63
|
* @see https://docs.gitlab.com/ee/ci/yaml/#artifactsreports
|
|
159
|
-
* @experimental
|
|
160
64
|
*/
|
|
161
65
|
export interface Reports {
|
|
162
|
-
/**
|
|
163
|
-
* (experimental) Path for file(s) that should be parsed as Cobertura XML coverage report.
|
|
164
|
-
*
|
|
165
|
-
* @experimental
|
|
166
|
-
*/
|
|
66
|
+
/** Path for file(s) that should be parsed as Cobertura XML coverage report*/
|
|
167
67
|
readonly cobertura?: string[];
|
|
168
|
-
/**
|
|
169
|
-
* (experimental) Path to file or list of files with code quality report(s) (such as Code Climate).
|
|
170
|
-
*
|
|
171
|
-
* @experimental
|
|
172
|
-
*/
|
|
68
|
+
/** Path to file or list of files with code quality report(s) (such as Code Climate).*/
|
|
173
69
|
readonly codequality?: string[];
|
|
174
|
-
/**
|
|
175
|
-
* (experimental) Path to file or list of files with Container scanning vulnerabilities report(s).
|
|
176
|
-
*
|
|
177
|
-
* @experimental
|
|
178
|
-
*/
|
|
70
|
+
/** Path to file or list of files with Container scanning vulnerabilities report(s).*/
|
|
179
71
|
readonly containerScanning?: string[];
|
|
180
|
-
/**
|
|
181
|
-
* (experimental) Path to file or list of files with DAST vulnerabilities report(s).
|
|
182
|
-
*
|
|
183
|
-
* @experimental
|
|
184
|
-
*/
|
|
72
|
+
/** Path to file or list of files with DAST vulnerabilities report(s).*/
|
|
185
73
|
readonly dast?: string[];
|
|
186
|
-
/**
|
|
187
|
-
* (experimental) Path to file or list of files with Dependency scanning vulnerabilities report(s).
|
|
188
|
-
*
|
|
189
|
-
* @experimental
|
|
190
|
-
*/
|
|
74
|
+
/** Path to file or list of files with Dependency scanning vulnerabilities report(s).*/
|
|
191
75
|
readonly dependencyScanning?: string[];
|
|
192
|
-
/**
|
|
193
|
-
* (experimental) Path to file or list of files containing runtime-created variables for this job.
|
|
194
|
-
*
|
|
195
|
-
* @experimental
|
|
196
|
-
*/
|
|
76
|
+
/** Path to file or list of files containing runtime-created variables for this job.*/
|
|
197
77
|
readonly dotenv?: string[];
|
|
198
|
-
/**
|
|
199
|
-
* (experimental) Path for file(s) that should be parsed as JUnit XML result.
|
|
200
|
-
*
|
|
201
|
-
* @experimental
|
|
202
|
-
*/
|
|
78
|
+
/** Path for file(s) that should be parsed as JUnit XML result*/
|
|
203
79
|
readonly junit?: string[];
|
|
204
|
-
/**
|
|
205
|
-
* (experimental) Deprecated in 12.8: Path to file or list of files with license report(s).
|
|
206
|
-
*
|
|
207
|
-
* @experimental
|
|
208
|
-
*/
|
|
80
|
+
/** Deprecated in 12.8: Path to file or list of files with license report(s).*/
|
|
209
81
|
readonly licenseManagement?: string[];
|
|
210
|
-
/**
|
|
211
|
-
* (experimental) Path to file or list of files with license report(s).
|
|
212
|
-
*
|
|
213
|
-
* @experimental
|
|
214
|
-
*/
|
|
82
|
+
/** Path to file or list of files with license report(s).*/
|
|
215
83
|
readonly licenseScanning?: string[];
|
|
216
|
-
/**
|
|
217
|
-
* (experimental) Path to file or list of files containing code intelligence (Language Server Index Format).
|
|
218
|
-
*
|
|
219
|
-
* @experimental
|
|
220
|
-
*/
|
|
84
|
+
/** Path to file or list of files containing code intelligence (Language Server Index Format).*/
|
|
221
85
|
readonly lsif?: string[];
|
|
222
|
-
/**
|
|
223
|
-
* (experimental) Path to file or list of files with custom metrics report(s).
|
|
224
|
-
*
|
|
225
|
-
* @experimental
|
|
226
|
-
*/
|
|
86
|
+
/** Path to file or list of files with custom metrics report(s).*/
|
|
227
87
|
readonly metrics?: string[];
|
|
228
|
-
/**
|
|
229
|
-
* (experimental) Path to file or list of files with performance metrics report(s).
|
|
230
|
-
*
|
|
231
|
-
* @experimental
|
|
232
|
-
*/
|
|
88
|
+
/** Path to file or list of files with performance metrics report(s).*/
|
|
233
89
|
readonly performance?: string[];
|
|
234
|
-
/**
|
|
235
|
-
* (experimental) Path to file or list of files with requirements report(s).
|
|
236
|
-
*
|
|
237
|
-
* @experimental
|
|
238
|
-
*/
|
|
90
|
+
/** Path to file or list of files with requirements report(s).*/
|
|
239
91
|
readonly requirements?: string[];
|
|
240
|
-
/**
|
|
241
|
-
* (experimental) Path to file or list of files with SAST vulnerabilities report(s).
|
|
242
|
-
*
|
|
243
|
-
* @experimental
|
|
244
|
-
*/
|
|
92
|
+
/** Path to file or list of files with SAST vulnerabilities report(s).*/
|
|
245
93
|
readonly sast?: string[];
|
|
246
|
-
/**
|
|
247
|
-
* (experimental) Path to file or list of files with secret detection report(s).
|
|
248
|
-
*
|
|
249
|
-
* @experimental
|
|
250
|
-
*/
|
|
94
|
+
/** Path to file or list of files with secret detection report(s).*/
|
|
251
95
|
readonly secretDetection?: string[];
|
|
252
|
-
/**
|
|
253
|
-
* (experimental) Path to file or list of files with terraform plan(s).
|
|
254
|
-
*
|
|
255
|
-
* @experimental
|
|
256
|
-
*/
|
|
96
|
+
/** Path to file or list of files with terraform plan(s).*/
|
|
257
97
|
readonly terraform?: string[];
|
|
258
98
|
}
|
|
259
99
|
/**
|
|
260
|
-
*
|
|
261
|
-
*
|
|
262
|
-
* Job configuration
|
|
100
|
+
* Specifies the docker image to use for the job or globally for all jobs. Job configuration
|
|
263
101
|
* takes precedence over global setting. Requires a certain kind of Gitlab runner executor.
|
|
264
|
-
*
|
|
265
102
|
* @see https://docs.gitlab.com/ee/ci/yaml/#image
|
|
266
|
-
* @experimental
|
|
267
103
|
*/
|
|
268
104
|
export interface Image {
|
|
269
|
-
/**
|
|
270
|
-
* (experimental) Command or script that should be executed as the container's entrypoint.
|
|
271
|
-
*
|
|
272
|
-
* It will be translated to Docker's --entrypoint option while creating the container. The syntax is similar to Dockerfile's ENTRYPOINT directive, where each shell token is a separate string in the array.
|
|
273
|
-
*
|
|
274
|
-
* @experimental
|
|
275
|
-
*/
|
|
105
|
+
/** Command or script that should be executed as the container's entrypoint. It will be translated to Docker's --entrypoint option while creating the container. The syntax is similar to Dockerfile's ENTRYPOINT directive, where each shell token is a separate string in the array.*/
|
|
276
106
|
readonly entrypoint?: any[];
|
|
277
|
-
/**
|
|
278
|
-
* (experimental) Full name of the image that should be used.
|
|
279
|
-
*
|
|
280
|
-
* It should contain the Registry part if needed.
|
|
281
|
-
*
|
|
282
|
-
* @experimental
|
|
283
|
-
*/
|
|
107
|
+
/** Full name of the image that should be used. It should contain the Registry part if needed.*/
|
|
284
108
|
readonly name: string;
|
|
285
109
|
}
|
|
286
110
|
/**
|
|
287
|
-
*
|
|
288
|
-
*
|
|
289
|
-
* If not defined, defaults to 0 and jobs do not retry.
|
|
290
|
-
*
|
|
111
|
+
* How many times a job is retried if it fails. If not defined, defaults to 0 and jobs do not retry.
|
|
291
112
|
* @see https://docs.gitlab.com/ee/ci/yaml/#retry
|
|
292
|
-
* @experimental
|
|
293
113
|
*/
|
|
294
114
|
export interface Retry {
|
|
295
|
-
/**
|
|
296
|
-
* (experimental) 0 (default), 1, or 2.
|
|
297
|
-
*
|
|
298
|
-
* @experimental
|
|
299
|
-
*/
|
|
115
|
+
/** 0 (default), 1, or 2.*/
|
|
300
116
|
readonly max?: number;
|
|
301
|
-
/**
|
|
302
|
-
* (experimental) Either a single or array of error types to trigger job retry.
|
|
303
|
-
*
|
|
304
|
-
* @experimental
|
|
305
|
-
*/
|
|
117
|
+
/** Either a single or array of error types to trigger job retry.*/
|
|
306
118
|
readonly when?: any;
|
|
307
119
|
}
|
|
308
120
|
/**
|
|
309
|
-
*
|
|
310
|
-
*
|
|
311
|
-
* The service image is linked to the image specified in the @Default image keyword.
|
|
312
|
-
*
|
|
121
|
+
* Used to specify an additional Docker image to run scripts in. The service image is linked to the image specified in the @Default image keyword.
|
|
313
122
|
* @see https://docs.gitlab.com/ee/ci/yaml/#services
|
|
314
|
-
* @experimental
|
|
315
123
|
*/
|
|
316
124
|
export interface Service {
|
|
317
|
-
/**
|
|
318
|
-
* (experimental) Additional alias that can be used to access the service from the job's container.
|
|
319
|
-
*
|
|
320
|
-
* Read Accessing the services for more information.
|
|
321
|
-
*
|
|
322
|
-
* @experimental
|
|
323
|
-
*/
|
|
125
|
+
/** Additional alias that can be used to access the service from the job's container. Read Accessing the services for more information.*/
|
|
324
126
|
readonly alias?: string;
|
|
325
|
-
/**
|
|
326
|
-
* (experimental) Command or script that should be used as the container's command.
|
|
327
|
-
*
|
|
328
|
-
* It will be translated to arguments passed to Docker after the image's name. The syntax is similar to Dockerfile's CMD directive, where each shell token is a separate string in the array.
|
|
329
|
-
*
|
|
330
|
-
* @experimental
|
|
331
|
-
*/
|
|
127
|
+
/** Command or script that should be used as the container's command. It will be translated to arguments passed to Docker after the image's name. The syntax is similar to Dockerfile's CMD directive, where each shell token is a separate string in the array.*/
|
|
332
128
|
readonly command?: string[];
|
|
333
|
-
/**
|
|
334
|
-
* (experimental) Command or script that should be executed as the container's entrypoint.
|
|
335
|
-
*
|
|
336
|
-
* It will be translated to Docker's --entrypoint option while creating the container. The syntax is similar to Dockerfile's ENTRYPOINT directive, where each shell token is a separate string in the array.
|
|
337
|
-
*
|
|
338
|
-
* @experimental
|
|
339
|
-
*/
|
|
129
|
+
/** Command or script that should be executed as the container's entrypoint. It will be translated to Docker's --entrypoint option while creating the container. The syntax is similar to Dockerfile's ENTRYPOINT directive, where each shell token is a separate string in the array.*/
|
|
340
130
|
readonly entrypoint?: string[];
|
|
341
|
-
/**
|
|
342
|
-
* (experimental) Full name of the image that should be used.
|
|
343
|
-
*
|
|
344
|
-
* It should contain the Registry part if needed.
|
|
345
|
-
*
|
|
346
|
-
* @experimental
|
|
347
|
-
*/
|
|
131
|
+
/** Full name of the image that should be used. It should contain the Registry part if needed.*/
|
|
348
132
|
readonly name: string;
|
|
349
133
|
}
|
|
350
134
|
/**
|
|
351
|
-
*
|
|
352
|
-
*
|
|
135
|
+
* An included YAML file.
|
|
353
136
|
* @see https://docs.gitlab.com/ee/ci/yaml/#include
|
|
354
|
-
* @experimental
|
|
355
137
|
*/
|
|
356
138
|
export interface Include {
|
|
357
|
-
/**
|
|
358
|
-
* (experimental) Relative path from local repository root (`/`) to the `yaml`/`yml` file template.
|
|
359
|
-
*
|
|
360
|
-
* The file must be on the same branch, and does not work across git submodules.
|
|
361
|
-
*
|
|
362
|
-
* @experimental
|
|
363
|
-
*/
|
|
139
|
+
/** Relative path from local repository root (`/`) to the `yaml`/`yml` file template. The file must be on the same branch, and does not work across git submodules.*/
|
|
364
140
|
readonly local?: string;
|
|
365
|
-
/**
|
|
366
|
-
* (experimental) Rules allows for an array of individual rule objects to be evaluated in order, until one matches and dynamically provides attributes to the job.
|
|
367
|
-
*
|
|
368
|
-
* @experimental
|
|
369
|
-
*/
|
|
141
|
+
/**Rules allows for an array of individual rule objects to be evaluated in order, until one matches and dynamically provides attributes to the job. */
|
|
370
142
|
readonly rules?: IncludeRule[];
|
|
371
|
-
/**
|
|
372
|
-
* (experimental) Files from another private project on the same GitLab instance.
|
|
373
|
-
*
|
|
374
|
-
* You can use `file` in combination with `project` only.
|
|
375
|
-
*
|
|
376
|
-
* @experimental
|
|
377
|
-
*/
|
|
143
|
+
/** Files from another private project on the same GitLab instance. You can use `file` in combination with `project` only. */
|
|
378
144
|
readonly file?: string[];
|
|
379
|
-
/**
|
|
380
|
-
* (experimental) Path to the project, e.g. `group/project`, or `group/sub-group/project`.
|
|
381
|
-
*
|
|
382
|
-
* @experimental
|
|
383
|
-
*/
|
|
145
|
+
/** Path to the project, e.g. `group/project`, or `group/sub-group/project`.*/
|
|
384
146
|
readonly project?: string;
|
|
385
|
-
/**
|
|
386
|
-
* (experimental) Branch/Tag/Commit-hash for the target project.
|
|
387
|
-
*
|
|
388
|
-
* @experimental
|
|
389
|
-
*/
|
|
147
|
+
/** Branch/Tag/Commit-hash for the target project.*/
|
|
390
148
|
readonly ref?: string;
|
|
391
|
-
/**
|
|
392
|
-
* (experimental) Use a `.gitlab-ci.yml` template as a base, e.g. `Nodejs.gitlab-ci.yml`.
|
|
393
|
-
*
|
|
394
|
-
* @experimental
|
|
395
|
-
*/
|
|
149
|
+
/** Use a `.gitlab-ci.yml` template as a base, e.g. `Nodejs.gitlab-ci.yml`.*/
|
|
396
150
|
readonly template?: string;
|
|
397
|
-
/**
|
|
398
|
-
* (experimental) URL to a `yaml`/`yml` template file using HTTP/HTTPS.
|
|
399
|
-
*
|
|
400
|
-
* @experimental
|
|
401
|
-
*/
|
|
151
|
+
/** URL to a `yaml`/`yml` template file using HTTP/HTTPS.*/
|
|
402
152
|
readonly remote?: string;
|
|
403
153
|
}
|
|
404
154
|
/**
|
|
405
|
-
*
|
|
406
|
-
*
|
|
155
|
+
* Rules allows for an array of individual rule objects to be evaluated in order, until one
|
|
156
|
+
* matches and dynamically provides attributes to the job.
|
|
407
157
|
* @see https://docs.gitlab.com/ee/ci/yaml/includes.html#use-rules-with-include
|
|
408
|
-
* @experimental
|
|
409
158
|
*/
|
|
410
159
|
export interface IncludeRule {
|
|
411
|
-
/**
|
|
412
|
-
* @experimental
|
|
413
|
-
*/
|
|
414
160
|
readonly allowFailure?: boolean | AllowFailure;
|
|
415
|
-
/**
|
|
416
|
-
* @experimental
|
|
417
|
-
*/
|
|
418
161
|
readonly changes?: string[];
|
|
419
|
-
/**
|
|
420
|
-
* @experimental
|
|
421
|
-
*/
|
|
422
162
|
readonly exists?: string[];
|
|
423
|
-
/**
|
|
424
|
-
* @experimental
|
|
425
|
-
*/
|
|
426
163
|
readonly if?: string;
|
|
427
|
-
/**
|
|
428
|
-
* @experimental
|
|
429
|
-
*/
|
|
430
164
|
readonly startIn?: string;
|
|
431
|
-
/**
|
|
432
|
-
* @experimental
|
|
433
|
-
*/
|
|
434
165
|
readonly variables?: Record<string, number | string>;
|
|
435
|
-
/**
|
|
436
|
-
* @experimental
|
|
437
|
-
*/
|
|
438
166
|
readonly when?: JobWhen;
|
|
439
167
|
}
|
|
440
168
|
/**
|
|
441
|
-
*
|
|
442
|
-
*
|
|
443
|
-
* The job fails for any other exit code.
|
|
169
|
+
* Exit code that are not considered failure. The job fails for any other exit code.
|
|
444
170
|
* You can list which exit codes are not considered failures. The job fails for any other
|
|
445
171
|
* exit code.
|
|
446
|
-
*
|
|
447
172
|
* @see https://docs.gitlab.com/ee/ci/yaml/#allow_failure
|
|
448
|
-
* @experimental
|
|
449
173
|
*/
|
|
450
174
|
export interface AllowFailure {
|
|
451
|
-
/**
|
|
452
|
-
* @experimental
|
|
453
|
-
*/
|
|
454
175
|
readonly exitCodes: number[] | number;
|
|
455
176
|
}
|
|
456
177
|
/**
|
|
457
|
-
*
|
|
458
|
-
*
|
|
459
|
-
* Defaults to 'on_success'.
|
|
460
|
-
*
|
|
178
|
+
* Describes the conditions for when to run the job. Defaults to 'on_success'.
|
|
461
179
|
* @see https://docs.gitlab.com/ee/ci/yaml/#when
|
|
462
|
-
* @experimental
|
|
463
180
|
*/
|
|
464
181
|
export declare enum JobWhen {
|
|
465
|
-
/**
|
|
466
|
-
* @experimental
|
|
467
|
-
*/
|
|
468
182
|
ALWAYS = "always",
|
|
469
|
-
/**
|
|
470
|
-
* @experimental
|
|
471
|
-
*/
|
|
472
183
|
DELAYED = "delayed",
|
|
473
|
-
/**
|
|
474
|
-
* @experimental
|
|
475
|
-
*/
|
|
476
184
|
MANUAL = "manual",
|
|
477
|
-
/**
|
|
478
|
-
* @experimental
|
|
479
|
-
*/
|
|
480
185
|
NEVER = "never",
|
|
481
|
-
/**
|
|
482
|
-
* @experimental
|
|
483
|
-
*/
|
|
484
186
|
ON_FAILURE = "on_failure",
|
|
485
|
-
/**
|
|
486
|
-
* @experimental
|
|
487
|
-
*/
|
|
488
187
|
ON_SUCCESS = "on_success"
|
|
489
188
|
}
|
|
490
189
|
/**
|
|
491
|
-
*
|
|
492
|
-
*
|
|
190
|
+
* Jobs are the most fundamental element of a .gitlab-ci.yml file.
|
|
493
191
|
* @see https://docs.gitlab.com/ee/ci/jobs/
|
|
494
|
-
* @experimental
|
|
495
192
|
*/
|
|
496
193
|
export interface Job {
|
|
497
|
-
/**
|
|
498
|
-
* @experimental
|
|
499
|
-
*/
|
|
500
194
|
readonly afterScript?: string[];
|
|
501
|
-
/**
|
|
502
|
-
* (experimental) Whether to allow the pipeline to continue running on job failure (Default: false).
|
|
503
|
-
*
|
|
504
|
-
* @experimental
|
|
505
|
-
*/
|
|
195
|
+
/** Whether to allow the pipeline to continue running on job failure (Default: false). */
|
|
506
196
|
readonly allowFailure?: boolean | AllowFailure;
|
|
507
|
-
/**
|
|
508
|
-
* @experimental
|
|
509
|
-
*/
|
|
510
197
|
readonly artifacts?: Artifacts;
|
|
511
|
-
/**
|
|
512
|
-
* @experimental
|
|
513
|
-
*/
|
|
514
198
|
readonly beforeScript?: string[];
|
|
515
|
-
/**
|
|
516
|
-
* @experimental
|
|
517
|
-
*/
|
|
518
199
|
readonly cache?: Cache;
|
|
519
|
-
/**
|
|
520
|
-
* (experimental) Must be a regular expression, optionally but recommended to be quoted, and must be surrounded with '/'.
|
|
521
|
-
*
|
|
522
|
-
* Example: '/Code coverage: \d+\.\d+/'
|
|
523
|
-
*
|
|
524
|
-
* @experimental
|
|
525
|
-
*/
|
|
200
|
+
/** Must be a regular expression, optionally but recommended to be quoted, and must be surrounded with '/'. Example: '/Code coverage: \d+\.\d+/'*/
|
|
526
201
|
readonly coverage?: string;
|
|
527
|
-
/**
|
|
528
|
-
* (experimental) Specify a list of job names from earlier stages from which artifacts should be loaded.
|
|
529
|
-
*
|
|
530
|
-
* By default, all previous artifacts are passed. Use an empty array to skip downloading artifacts.
|
|
531
|
-
*
|
|
532
|
-
* @experimental
|
|
533
|
-
*/
|
|
202
|
+
/** Specify a list of job names from earlier stages from which artifacts should be loaded. By default, all previous artifacts are passed. Use an empty array to skip downloading artifacts.*/
|
|
534
203
|
readonly dependencies?: string[];
|
|
535
|
-
/**
|
|
536
|
-
* (experimental) Used to associate environment metadata with a deploy.
|
|
537
|
-
*
|
|
538
|
-
* Environment can have a name and URL attached to it, and will be displayed under /environments under the project.
|
|
539
|
-
*
|
|
540
|
-
* @experimental
|
|
541
|
-
*/
|
|
204
|
+
/** Used to associate environment metadata with a deploy. Environment can have a name and URL attached to it, and will be displayed under /environments under the project.*/
|
|
542
205
|
readonly environment?: Environment | string;
|
|
543
|
-
/**
|
|
544
|
-
* (experimental) Job will run *except* for when these filtering options match.
|
|
545
|
-
*
|
|
546
|
-
* @experimental
|
|
547
|
-
*/
|
|
206
|
+
/** Job will run *except* for when these filtering options match.*/
|
|
548
207
|
readonly except?: string[] | Filter;
|
|
549
|
-
/**
|
|
550
|
-
* (experimental) The name of one or more jobs to inherit configuration from.
|
|
551
|
-
*
|
|
552
|
-
* @experimental
|
|
553
|
-
*/
|
|
208
|
+
/** The name of one or more jobs to inherit configuration from.*/
|
|
554
209
|
readonly extends?: string[];
|
|
555
|
-
/**
|
|
556
|
-
* @experimental
|
|
557
|
-
*/
|
|
558
210
|
readonly image?: Image;
|
|
559
|
-
/**
|
|
560
|
-
* (experimental) Controls inheritance of globally-defined defaults and variables.
|
|
561
|
-
*
|
|
562
|
-
* Boolean values control inheritance of all default: or variables: keywords. To inherit only a subset of default: or variables: keywords, specify what you wish to inherit. Anything not listed is not inherited.
|
|
563
|
-
*
|
|
564
|
-
* @experimental
|
|
565
|
-
*/
|
|
211
|
+
/** Controls inheritance of globally-defined defaults and variables. Boolean values control inheritance of all default: or variables: keywords. To inherit only a subset of default: or variables: keywords, specify what you wish to inherit. Anything not listed is not inherited.*/
|
|
566
212
|
readonly inherit?: Inherit;
|
|
567
|
-
/**
|
|
568
|
-
* @experimental
|
|
569
|
-
*/
|
|
570
213
|
readonly interruptible?: boolean;
|
|
571
|
-
/**
|
|
572
|
-
* (experimental) The list of jobs in previous stages whose sole completion is needed to start the current job.
|
|
573
|
-
*
|
|
574
|
-
* @experimental
|
|
575
|
-
*/
|
|
214
|
+
/** The list of jobs in previous stages whose sole completion is needed to start the current job.*/
|
|
576
215
|
readonly needs?: Array<Need | string>;
|
|
577
|
-
/**
|
|
578
|
-
* (experimental) Job will run *only* when these filtering options match.
|
|
579
|
-
*
|
|
580
|
-
* @experimental
|
|
581
|
-
*/
|
|
216
|
+
/** Job will run *only* when these filtering options match.*/
|
|
582
217
|
readonly only?: string[] | Filter;
|
|
583
|
-
/**
|
|
584
|
-
* (experimental) Parallel will split up a single job into several, and provide `CI_NODE_INDEX` and `CI_NODE_TOTAL` environment variables for the running jobs.
|
|
585
|
-
*
|
|
586
|
-
* @experimental
|
|
587
|
-
*/
|
|
218
|
+
/** Parallel will split up a single job into several, and provide `CI_NODE_INDEX` and `CI_NODE_TOTAL` environment variables for the running jobs.*/
|
|
588
219
|
readonly parallel?: Parallel | number;
|
|
589
|
-
/**
|
|
590
|
-
* (experimental) Indicates that the job creates a Release.
|
|
591
|
-
*
|
|
592
|
-
* @experimental
|
|
593
|
-
*/
|
|
220
|
+
/** Indicates that the job creates a Release.*/
|
|
594
221
|
readonly release?: Release;
|
|
595
|
-
/**
|
|
596
|
-
* (experimental) Limit job concurrency.
|
|
597
|
-
*
|
|
598
|
-
* Can be used to ensure that the Runner will not run certain jobs simultaneously.
|
|
599
|
-
*
|
|
600
|
-
* @experimental
|
|
601
|
-
*/
|
|
222
|
+
/** Limit job concurrency. Can be used to ensure that the Runner will not run certain jobs simultaneously.*/
|
|
602
223
|
readonly resourceGroup?: string;
|
|
603
|
-
/**
|
|
604
|
-
* @experimental
|
|
605
|
-
*/
|
|
606
224
|
readonly retry?: Retry;
|
|
607
|
-
/**
|
|
608
|
-
* (experimental) Rules allows for an array of individual rule objects to be evaluated in order, until one matches and dynamically provides attributes to the job.
|
|
609
|
-
*
|
|
610
|
-
* @experimental
|
|
611
|
-
*/
|
|
225
|
+
/**Rules allows for an array of individual rule objects to be evaluated in order, until one matches and dynamically provides attributes to the job. */
|
|
612
226
|
readonly rules?: IncludeRule[];
|
|
613
|
-
/**
|
|
614
|
-
* (experimental) Shell scripts executed by the Runner.
|
|
615
|
-
*
|
|
616
|
-
* The only required property of jobs. Be careful with special characters (e.g. `:`, `{`, `}`, `&`) and use single or double quotes to avoid issues.
|
|
617
|
-
*
|
|
618
|
-
* @experimental
|
|
619
|
-
*/
|
|
227
|
+
/** Shell scripts executed by the Runner. The only required property of jobs. Be careful with special characters (e.g. `:`, `{`, `}`, `&`) and use single or double quotes to avoid issues.*/
|
|
620
228
|
readonly script?: string[];
|
|
621
|
-
/**
|
|
622
|
-
* (experimental) CI/CD secrets.
|
|
623
|
-
*
|
|
624
|
-
* @experimental
|
|
625
|
-
*/
|
|
229
|
+
/** CI/CD secrets */
|
|
626
230
|
readonly secrets?: Record<string, Record<string, Secret>>;
|
|
627
|
-
/**
|
|
628
|
-
* @experimental
|
|
629
|
-
*/
|
|
630
231
|
readonly services?: Service[];
|
|
631
|
-
/**
|
|
632
|
-
* (experimental) Define what stage the job will run in.
|
|
633
|
-
*
|
|
634
|
-
* @experimental
|
|
635
|
-
*/
|
|
232
|
+
/** Define what stage the job will run in.*/
|
|
636
233
|
readonly stage?: string;
|
|
637
|
-
/**
|
|
638
|
-
* @experimental
|
|
639
|
-
*/
|
|
640
234
|
readonly startIn?: string;
|
|
641
|
-
/**
|
|
642
|
-
* @experimental
|
|
643
|
-
*/
|
|
644
235
|
readonly tags?: string[];
|
|
645
|
-
/**
|
|
646
|
-
* @experimental
|
|
647
|
-
*/
|
|
648
236
|
readonly timeout?: string;
|
|
649
|
-
/**
|
|
650
|
-
* (experimental) Trigger allows you to define downstream pipeline trigger.
|
|
651
|
-
*
|
|
652
|
-
* When a job created from trigger definition is started by GitLab, a downstream pipeline gets created. Read more: https://docs.gitlab.com/ee/ci/yaml/README.html#trigger
|
|
653
|
-
*
|
|
654
|
-
* @experimental
|
|
655
|
-
*/
|
|
237
|
+
/** Trigger allows you to define downstream pipeline trigger. When a job created from trigger definition is started by GitLab, a downstream pipeline gets created. Read more: https://docs.gitlab.com/ee/ci/yaml/README.html#trigger*/
|
|
656
238
|
readonly trigger?: Trigger | string;
|
|
657
|
-
/**
|
|
658
|
-
* (experimental) Configurable values that are passed to the Job.
|
|
659
|
-
*
|
|
660
|
-
* @experimental
|
|
661
|
-
*/
|
|
239
|
+
/** Configurable values that are passed to the Job. */
|
|
662
240
|
readonly variables?: Record<string, number | string>;
|
|
663
|
-
/**
|
|
664
|
-
* (experimental) Describes the conditions for when to run the job.
|
|
665
|
-
*
|
|
666
|
-
* Defaults to 'on_success'.
|
|
667
|
-
*
|
|
668
|
-
* @experimental
|
|
669
|
-
*/
|
|
241
|
+
/** Describes the conditions for when to run the job. Defaults to 'on_success'. */
|
|
670
242
|
readonly when?: JobWhen;
|
|
671
243
|
}
|
|
672
244
|
/**
|
|
673
|
-
*
|
|
674
|
-
*
|
|
675
|
-
* @experimental
|
|
245
|
+
* The environment that a job deploys to.
|
|
676
246
|
*/
|
|
677
247
|
export interface Environment {
|
|
678
|
-
/**
|
|
679
|
-
* (experimental) Specifies what this job will do.
|
|
680
|
-
*
|
|
681
|
-
* 'start' (default) indicates the job will start the deployment. 'prepare' indicates this will not affect the deployment. 'stop' indicates this will stop the deployment.
|
|
682
|
-
*
|
|
683
|
-
* @experimental
|
|
684
|
-
*/
|
|
248
|
+
/** Specifies what this job will do. 'start' (default) indicates the job will start the deployment. 'prepare' indicates this will not affect the deployment. 'stop' indicates this will stop the deployment.*/
|
|
685
249
|
readonly action?: Action;
|
|
686
|
-
/**
|
|
687
|
-
* (experimental) The amount of time it should take before Gitlab will automatically stop the environment.
|
|
688
|
-
*
|
|
689
|
-
* Supports a wide variety of formats, e.g. '1 week', '3 mins 4 sec', '2 hrs 20 min', '2h20min', '6 mos 1 day', '47 yrs 6 mos and 4d', '3 weeks and 2 days'.
|
|
690
|
-
*
|
|
691
|
-
* @experimental
|
|
692
|
-
*/
|
|
250
|
+
/** The amount of time it should take before Gitlab will automatically stop the environment. Supports a wide variety of formats, e.g. '1 week', '3 mins 4 sec', '2 hrs 20 min', '2h20min', '6 mos 1 day', '47 yrs 6 mos and 4d', '3 weeks and 2 days'.*/
|
|
693
251
|
readonly autoStopIn?: string;
|
|
694
|
-
/**
|
|
695
|
-
* (experimental) Explicitly specifies the tier of the deployment environment if non-standard environment name is used.
|
|
696
|
-
*
|
|
697
|
-
* @experimental
|
|
698
|
-
*/
|
|
252
|
+
/** Explicitly specifies the tier of the deployment environment if non-standard environment name is used.*/
|
|
699
253
|
readonly deploymentTier?: DeploymentTier;
|
|
700
|
-
/**
|
|
701
|
-
* (experimental) Used to configure the kubernetes deployment for this environment.
|
|
702
|
-
*
|
|
703
|
-
* This is currently not supported for kubernetes clusters that are managed by Gitlab.
|
|
704
|
-
*
|
|
705
|
-
* @experimental
|
|
706
|
-
*/
|
|
254
|
+
/** Used to configure the kubernetes deployment for this environment. This is currently not supported for kubernetes clusters that are managed by Gitlab.*/
|
|
707
255
|
readonly kubernetes?: KubernetesConfig;
|
|
708
|
-
/**
|
|
709
|
-
* (experimental) The name of the environment, e.g. 'qa', 'staging', 'production'.
|
|
710
|
-
*
|
|
711
|
-
* @experimental
|
|
712
|
-
*/
|
|
256
|
+
/** The name of the environment, e.g. 'qa', 'staging', 'production'.*/
|
|
713
257
|
readonly name: string;
|
|
714
|
-
/**
|
|
715
|
-
* (experimental) The name of a job to execute when the environment is about to be stopped.
|
|
716
|
-
*
|
|
717
|
-
* @experimental
|
|
718
|
-
*/
|
|
258
|
+
/** The name of a job to execute when the environment is about to be stopped.*/
|
|
719
259
|
readonly onStop?: string;
|
|
720
|
-
/**
|
|
721
|
-
* (experimental) When set, this will expose buttons in various places for the current environment in Gitlab, that will take you to the defined URL.
|
|
722
|
-
*
|
|
723
|
-
* @experimental
|
|
724
|
-
*/
|
|
260
|
+
/** When set, this will expose buttons in various places for the current environment in Gitlab, that will take you to the defined URL.*/
|
|
725
261
|
readonly url?: string;
|
|
726
262
|
}
|
|
727
263
|
/**
|
|
728
|
-
*
|
|
729
|
-
*
|
|
730
|
-
* 'start' (default) indicates the job will start the
|
|
264
|
+
* Specifies what this job will do. 'start' (default) indicates the job will start the
|
|
731
265
|
* deployment. 'prepare' indicates this will not affect the deployment. 'stop' indicates
|
|
732
266
|
* this will stop the deployment.
|
|
733
|
-
*
|
|
734
|
-
* @experimental
|
|
735
267
|
*/
|
|
736
268
|
export declare enum Action {
|
|
737
|
-
/**
|
|
738
|
-
* @experimental
|
|
739
|
-
*/
|
|
740
269
|
PREPARE = "prepare",
|
|
741
|
-
/**
|
|
742
|
-
* @experimental
|
|
743
|
-
*/
|
|
744
270
|
START = "start",
|
|
745
|
-
/**
|
|
746
|
-
* @experimental
|
|
747
|
-
*/
|
|
748
271
|
STOP = "stop"
|
|
749
272
|
}
|
|
750
273
|
/**
|
|
751
|
-
*
|
|
752
|
-
*
|
|
753
|
-
* @experimental
|
|
274
|
+
* Explicitly specifies the tier of the deployment environment if non-standard environment
|
|
275
|
+
* name is used.
|
|
754
276
|
*/
|
|
755
277
|
export declare enum DeploymentTier {
|
|
756
|
-
/**
|
|
757
|
-
* @experimental
|
|
758
|
-
*/
|
|
759
278
|
DEVELOPMENT = "development",
|
|
760
|
-
/**
|
|
761
|
-
* @experimental
|
|
762
|
-
*/
|
|
763
279
|
OTHER = "other",
|
|
764
|
-
/**
|
|
765
|
-
* @experimental
|
|
766
|
-
*/
|
|
767
280
|
PRODUCTION = "production",
|
|
768
|
-
/**
|
|
769
|
-
* @experimental
|
|
770
|
-
*/
|
|
771
281
|
STAGING = "staging",
|
|
772
|
-
/**
|
|
773
|
-
* @experimental
|
|
774
|
-
*/
|
|
775
282
|
TESTING = "testing"
|
|
776
283
|
}
|
|
777
284
|
/**
|
|
778
|
-
*
|
|
779
|
-
*
|
|
780
|
-
* This is currently not
|
|
285
|
+
* Used to configure the kubernetes deployment for this environment. This is currently not
|
|
781
286
|
* supported for kubernetes clusters that are managed by Gitlab.
|
|
782
|
-
*
|
|
783
|
-
* @experimental
|
|
784
287
|
*/
|
|
785
288
|
export interface KubernetesConfig {
|
|
786
|
-
/**
|
|
787
|
-
* (experimental) The kubernetes namespace where this environment should be deployed to.
|
|
788
|
-
*
|
|
789
|
-
* @experimental
|
|
790
|
-
*/
|
|
289
|
+
/** The kubernetes namespace where this environment should be deployed to.*/
|
|
791
290
|
readonly namespace?: string;
|
|
792
291
|
}
|
|
793
292
|
/**
|
|
794
|
-
*
|
|
795
|
-
*
|
|
796
|
-
* @experimental
|
|
293
|
+
* Filtering options for when a job will run.
|
|
797
294
|
*/
|
|
798
295
|
export interface Filter {
|
|
799
|
-
/**
|
|
800
|
-
* (experimental) Filter job creation based on files that were modified in a git push.
|
|
801
|
-
*
|
|
802
|
-
* @experimental
|
|
803
|
-
*/
|
|
296
|
+
/** Filter job creation based on files that were modified in a git push.*/
|
|
804
297
|
readonly changes?: string[];
|
|
805
|
-
/**
|
|
806
|
-
* (experimental) Filter job based on if Kubernetes integration is active.
|
|
807
|
-
*
|
|
808
|
-
* @experimental
|
|
809
|
-
*/
|
|
298
|
+
/** Filter job based on if Kubernetes integration is active.*/
|
|
810
299
|
readonly kubernetes?: KubernetesEnum;
|
|
811
|
-
/**
|
|
812
|
-
* (experimental) Control when to add jobs to a pipeline based on branch names or pipeline types.
|
|
813
|
-
*
|
|
814
|
-
* @experimental
|
|
815
|
-
*/
|
|
300
|
+
/** Control when to add jobs to a pipeline based on branch names or pipeline types. */
|
|
816
301
|
readonly refs?: string[];
|
|
817
|
-
/**
|
|
818
|
-
* (experimental) Filter job by checking comparing values of environment variables.
|
|
819
|
-
*
|
|
820
|
-
* Read more about variable expressions: https://docs.gitlab.com/ee/ci/variables/README.html#variables-expressions
|
|
821
|
-
*
|
|
822
|
-
* @experimental
|
|
823
|
-
*/
|
|
302
|
+
/** Filter job by checking comparing values of environment variables. Read more about variable expressions: https://docs.gitlab.com/ee/ci/variables/README.html#variables-expressions*/
|
|
824
303
|
readonly variables?: string[];
|
|
825
304
|
}
|
|
826
305
|
/**
|
|
827
306
|
* Filter job based on if Kubernetes integration is active.
|
|
828
307
|
*/
|
|
829
308
|
export declare enum KubernetesEnum {
|
|
830
|
-
/**
|
|
831
|
-
* (experimental) Filter job based on if Kubernetes integration is active.
|
|
832
|
-
*
|
|
833
|
-
* @experimental
|
|
834
|
-
*/
|
|
835
309
|
ACTIVE = "active"
|
|
836
310
|
}
|
|
837
311
|
/**
|
|
838
|
-
*
|
|
839
|
-
*
|
|
840
|
-
* Boolean values control
|
|
312
|
+
* Controls inheritance of globally-defined defaults and variables. Boolean values control
|
|
841
313
|
* inheritance of all default: or variables: keywords. To inherit only a subset of default:
|
|
842
314
|
* or variables: keywords, specify what you wish to inherit. Anything not listed is not
|
|
843
315
|
* inherited.
|
|
844
|
-
*
|
|
845
|
-
* @experimental
|
|
846
316
|
*/
|
|
847
317
|
export interface Inherit {
|
|
848
|
-
/**
|
|
849
|
-
* (experimental) Whether to inherit all globally-defined defaults or not.
|
|
850
|
-
*
|
|
851
|
-
* Or subset of inherited defaults
|
|
852
|
-
*
|
|
853
|
-
* @experimental
|
|
854
|
-
*/
|
|
318
|
+
/** Whether to inherit all globally-defined defaults or not. Or subset of inherited defaults*/
|
|
855
319
|
readonly default?: DefaultElement[] | boolean;
|
|
856
|
-
/**
|
|
857
|
-
* (experimental) Whether to inherit all globally-defined variables or not.
|
|
858
|
-
*
|
|
859
|
-
* Or subset of inherited variables
|
|
860
|
-
*
|
|
861
|
-
* @experimental
|
|
862
|
-
*/
|
|
320
|
+
/** Whether to inherit all globally-defined variables or not. Or subset of inherited variables*/
|
|
863
321
|
readonly variables?: string[] | boolean;
|
|
864
322
|
}
|
|
865
|
-
/**
|
|
866
|
-
* @experimental
|
|
867
|
-
*/
|
|
868
323
|
export declare enum DefaultElement {
|
|
869
|
-
/**
|
|
870
|
-
* @experimental
|
|
871
|
-
*/
|
|
872
324
|
AFTER_SCRIPT = "after_script",
|
|
873
|
-
/**
|
|
874
|
-
* @experimental
|
|
875
|
-
*/
|
|
876
325
|
ARTIFACTS = "artifacts",
|
|
877
|
-
/**
|
|
878
|
-
* @experimental
|
|
879
|
-
*/
|
|
880
326
|
BEFORE_SCRIPT = "before_script",
|
|
881
|
-
/**
|
|
882
|
-
* @experimental
|
|
883
|
-
*/
|
|
884
327
|
CACHE = "cache",
|
|
885
|
-
/**
|
|
886
|
-
* @experimental
|
|
887
|
-
*/
|
|
888
328
|
IMAGE = "image",
|
|
889
|
-
/**
|
|
890
|
-
* @experimental
|
|
891
|
-
*/
|
|
892
329
|
INTERRUPTIBLE = "interruptible",
|
|
893
|
-
/**
|
|
894
|
-
* @experimental
|
|
895
|
-
*/
|
|
896
330
|
RETRY = "retry",
|
|
897
|
-
/**
|
|
898
|
-
* @experimental
|
|
899
|
-
*/
|
|
900
331
|
SERVICES = "services",
|
|
901
|
-
/**
|
|
902
|
-
* @experimental
|
|
903
|
-
*/
|
|
904
332
|
TAGS = "tags",
|
|
905
|
-
/**
|
|
906
|
-
* @experimental
|
|
907
|
-
*/
|
|
908
333
|
TIMEOUT = "timeout"
|
|
909
334
|
}
|
|
910
335
|
/**
|
|
911
|
-
*
|
|
912
|
-
*
|
|
913
|
-
* @experimental
|
|
336
|
+
* A jobs in a previous stage whose sole completion is needed to start the current job.
|
|
914
337
|
*/
|
|
915
338
|
export interface Need {
|
|
916
|
-
/**
|
|
917
|
-
* @experimental
|
|
918
|
-
*/
|
|
919
339
|
readonly artifacts?: boolean;
|
|
920
|
-
/**
|
|
921
|
-
* @experimental
|
|
922
|
-
*/
|
|
923
340
|
readonly job: string;
|
|
924
|
-
/**
|
|
925
|
-
* @experimental
|
|
926
|
-
*/
|
|
927
341
|
readonly optional?: boolean;
|
|
928
|
-
/**
|
|
929
|
-
* @experimental
|
|
930
|
-
*/
|
|
931
342
|
readonly pipeline?: string;
|
|
932
|
-
/**
|
|
933
|
-
* @experimental
|
|
934
|
-
*/
|
|
935
343
|
readonly project?: string;
|
|
936
|
-
/**
|
|
937
|
-
* @experimental
|
|
938
|
-
*/
|
|
939
344
|
readonly ref?: string;
|
|
940
345
|
}
|
|
941
346
|
/**
|
|
942
|
-
*
|
|
943
|
-
*
|
|
944
|
-
* @experimental
|
|
347
|
+
* Used to run a job multiple times in parallel in a single pipeline.
|
|
945
348
|
*/
|
|
946
349
|
export interface Parallel {
|
|
947
|
-
/**
|
|
948
|
-
* (experimental) Defines different variables for jobs that are running in parallel.
|
|
949
|
-
*
|
|
950
|
-
* @experimental
|
|
951
|
-
*/
|
|
350
|
+
/** Defines different variables for jobs that are running in parallel.*/
|
|
952
351
|
readonly matrix: Record<string, any[]>[];
|
|
953
352
|
}
|
|
954
353
|
/**
|
|
955
|
-
*
|
|
956
|
-
*
|
|
957
|
-
* @experimental
|
|
354
|
+
* Indicates that the job creates a Release.
|
|
958
355
|
*/
|
|
959
356
|
export interface Release {
|
|
960
|
-
/**
|
|
961
|
-
* @experimental
|
|
962
|
-
*/
|
|
963
357
|
readonly assets?: Assets;
|
|
964
|
-
/**
|
|
965
|
-
* (experimental) Specifies the longer description of the Release.
|
|
966
|
-
*
|
|
967
|
-
* @experimental
|
|
968
|
-
*/
|
|
358
|
+
/** Specifies the longer description of the Release.*/
|
|
969
359
|
readonly description: string;
|
|
970
|
-
/**
|
|
971
|
-
* (experimental) The title of each milestone the release is associated with.
|
|
972
|
-
*
|
|
973
|
-
* @experimental
|
|
974
|
-
*/
|
|
360
|
+
/** The title of each milestone the release is associated with.*/
|
|
975
361
|
readonly milestones?: string[];
|
|
976
|
-
/**
|
|
977
|
-
* (experimental) The Release name.
|
|
978
|
-
*
|
|
979
|
-
* If omitted, it is populated with the value of release: tag_name.
|
|
980
|
-
*
|
|
981
|
-
* @experimental
|
|
982
|
-
*/
|
|
362
|
+
/** The Release name. If omitted, it is populated with the value of release: tag_name.*/
|
|
983
363
|
readonly name?: string;
|
|
984
|
-
/**
|
|
985
|
-
* (experimental) If the release: tag_name doesn’t exist yet, the release is created from ref.
|
|
986
|
-
*
|
|
987
|
-
* ref can be a commit SHA, another tag name, or a branch name.
|
|
988
|
-
*
|
|
989
|
-
* @experimental
|
|
990
|
-
*/
|
|
364
|
+
/** If the release: tag_name doesn’t exist yet, the release is created from ref. ref can be a commit SHA, another tag name, or a branch name.*/
|
|
991
365
|
readonly ref?: string;
|
|
992
|
-
/**
|
|
993
|
-
* (experimental) The date and time when the release is ready.
|
|
994
|
-
*
|
|
995
|
-
* Defaults to the current date and time if not defined. Should be enclosed in quotes and expressed in ISO 8601 format.
|
|
996
|
-
*
|
|
997
|
-
* @experimental
|
|
998
|
-
*/
|
|
366
|
+
/** The date and time when the release is ready. Defaults to the current date and time if not defined. Should be enclosed in quotes and expressed in ISO 8601 format.*/
|
|
999
367
|
readonly releasedAt?: string;
|
|
1000
|
-
/**
|
|
1001
|
-
* (experimental) The tag_name must be specified.
|
|
1002
|
-
*
|
|
1003
|
-
* It can refer to an existing Git tag or can be specified by the user.
|
|
1004
|
-
*
|
|
1005
|
-
* @experimental
|
|
1006
|
-
*/
|
|
368
|
+
/** The tag_name must be specified. It can refer to an existing Git tag or can be specified by the user.*/
|
|
1007
369
|
readonly tagName: string;
|
|
1008
370
|
}
|
|
1009
371
|
/**
|
|
1010
|
-
*
|
|
1011
|
-
*
|
|
1012
|
-
* @experimental
|
|
372
|
+
* Asset configuration for a release.
|
|
1013
373
|
*/
|
|
1014
374
|
export interface Assets {
|
|
1015
|
-
/**
|
|
1016
|
-
* (experimental) Include asset links in the release.
|
|
1017
|
-
*
|
|
1018
|
-
* @experimental
|
|
1019
|
-
*/
|
|
375
|
+
/** Include asset links in the release.*/
|
|
1020
376
|
readonly links: Link[];
|
|
1021
377
|
}
|
|
1022
378
|
/**
|
|
1023
|
-
*
|
|
1024
|
-
*
|
|
1025
|
-
* @experimental
|
|
379
|
+
* Link configuration for an asset.
|
|
1026
380
|
*/
|
|
1027
381
|
export interface Link {
|
|
1028
|
-
/**
|
|
1029
|
-
* (experimental) The redirect link to the url.
|
|
1030
|
-
*
|
|
1031
|
-
* @experimental
|
|
1032
|
-
*/
|
|
382
|
+
/** The redirect link to the url.*/
|
|
1033
383
|
readonly filepath?: string;
|
|
1034
|
-
/**
|
|
1035
|
-
* (experimental) The content kind of what users can download via url.
|
|
1036
|
-
*
|
|
1037
|
-
* @experimental
|
|
1038
|
-
*/
|
|
384
|
+
/** The content kind of what users can download via url.*/
|
|
1039
385
|
readonly linkType?: LinkType;
|
|
1040
|
-
/**
|
|
1041
|
-
* (experimental) The name of the link.
|
|
1042
|
-
*
|
|
1043
|
-
* @experimental
|
|
1044
|
-
*/
|
|
386
|
+
/** The name of the link.*/
|
|
1045
387
|
readonly name: string;
|
|
1046
|
-
/**
|
|
1047
|
-
* (experimental) The URL to download a file.
|
|
1048
|
-
*
|
|
1049
|
-
* @experimental
|
|
1050
|
-
*/
|
|
388
|
+
/** The URL to download a file.*/
|
|
1051
389
|
readonly url: string;
|
|
1052
390
|
}
|
|
1053
391
|
/**
|
|
1054
|
-
*
|
|
1055
|
-
*
|
|
1056
|
-
* @experimental
|
|
392
|
+
* The content kind of what users can download via url.
|
|
1057
393
|
*/
|
|
1058
394
|
export declare enum LinkType {
|
|
1059
|
-
/**
|
|
1060
|
-
* @experimental
|
|
1061
|
-
*/
|
|
1062
395
|
IMAGE = "image",
|
|
1063
|
-
/**
|
|
1064
|
-
* @experimental
|
|
1065
|
-
*/
|
|
1066
396
|
OTHER = "other",
|
|
1067
|
-
/**
|
|
1068
|
-
* @experimental
|
|
1069
|
-
*/
|
|
1070
397
|
PACKAGE = "package",
|
|
1071
|
-
/**
|
|
1072
|
-
* @experimental
|
|
1073
|
-
*/
|
|
1074
398
|
RUNBOOK = "runbook"
|
|
1075
399
|
}
|
|
1076
400
|
/**
|
|
1077
|
-
*
|
|
1078
|
-
*
|
|
1079
|
-
* @experimental
|
|
401
|
+
* A CI/CD secret
|
|
1080
402
|
*/
|
|
1081
403
|
export interface Secret {
|
|
1082
|
-
/**
|
|
1083
|
-
* @experimental
|
|
1084
|
-
*/
|
|
1085
404
|
readonly vault: VaultConfig;
|
|
1086
405
|
}
|
|
1087
406
|
/**
|
|
1088
|
-
*
|
|
1089
|
-
*
|
|
407
|
+
* Specification for a secret provided by a HashiCorp Vault.
|
|
1090
408
|
* @see https://www.vaultproject.io/
|
|
1091
|
-
* @experimental
|
|
1092
409
|
*/
|
|
1093
410
|
export interface VaultConfig {
|
|
1094
|
-
/**
|
|
1095
|
-
* @experimental
|
|
1096
|
-
*/
|
|
1097
411
|
readonly engine: Engine;
|
|
1098
|
-
/**
|
|
1099
|
-
* @experimental
|
|
1100
|
-
*/
|
|
1101
412
|
readonly field: string;
|
|
1102
|
-
/**
|
|
1103
|
-
* (experimental) Path to the secret.
|
|
1104
|
-
*
|
|
1105
|
-
* @experimental
|
|
1106
|
-
*/
|
|
413
|
+
/** Path to the secret. */
|
|
1107
414
|
readonly path: string;
|
|
1108
415
|
}
|
|
1109
416
|
/**
|
|
1110
|
-
*
|
|
1111
|
-
*
|
|
1112
|
-
* @experimental
|
|
417
|
+
* The engine configuration for a secret.
|
|
1113
418
|
*/
|
|
1114
419
|
export interface Engine {
|
|
1115
|
-
/**
|
|
1116
|
-
* (experimental) Name of the secrets engine.
|
|
1117
|
-
*
|
|
1118
|
-
* @experimental
|
|
1119
|
-
*/
|
|
420
|
+
/** Name of the secrets engine. */
|
|
1120
421
|
readonly name: string;
|
|
1121
|
-
/**
|
|
1122
|
-
* (experimental) Path to the secrets engine.
|
|
1123
|
-
*
|
|
1124
|
-
* @experimental
|
|
1125
|
-
*/
|
|
422
|
+
/** Path to the secrets engine. */
|
|
1126
423
|
readonly path: string;
|
|
1127
424
|
}
|
|
1128
425
|
/**
|
|
1129
|
-
*
|
|
1130
|
-
*
|
|
1131
|
-
* Read more:
|
|
1132
|
-
*
|
|
426
|
+
* Trigger a multi-project or a child pipeline. Read more:
|
|
427
|
+
* @see https://docs.gitlab.com/ee/ci/yaml/README.html#simple-trigger-syntax-for-multi-project-pipelines
|
|
1133
428
|
* @see https://docs.gitlab.com/ee/ci/yaml/README.html#trigger-syntax-for-child-pipeline
|
|
1134
|
-
* @experimental
|
|
1135
429
|
*/
|
|
1136
430
|
export interface Trigger {
|
|
1137
|
-
/**
|
|
1138
|
-
* (experimental) The branch name that a downstream pipeline will use.
|
|
1139
|
-
*
|
|
1140
|
-
* @experimental
|
|
1141
|
-
*/
|
|
431
|
+
/** The branch name that a downstream pipeline will use*/
|
|
1142
432
|
readonly branch?: string;
|
|
1143
|
-
/**
|
|
1144
|
-
* (experimental) Path to the project, e.g. `group/project`, or `group/sub-group/project`.
|
|
1145
|
-
*
|
|
1146
|
-
* @experimental
|
|
1147
|
-
*/
|
|
433
|
+
/** Path to the project, e.g. `group/project`, or `group/sub-group/project`.*/
|
|
1148
434
|
readonly project?: string;
|
|
1149
|
-
/**
|
|
1150
|
-
* (experimental) You can mirror the pipeline status from the triggered pipeline to the source bridge job by using strategy: depend.
|
|
1151
|
-
*
|
|
1152
|
-
* @experimental
|
|
1153
|
-
*/
|
|
435
|
+
/** You can mirror the pipeline status from the triggered pipeline to the source bridge job by using strategy: depend*/
|
|
1154
436
|
readonly strategy?: Strategy;
|
|
1155
|
-
/**
|
|
1156
|
-
* (experimental) A list of local files or artifacts from other jobs to define the pipeline.
|
|
1157
|
-
*
|
|
1158
|
-
* @experimental
|
|
1159
|
-
*/
|
|
437
|
+
/** A list of local files or artifacts from other jobs to define the pipeline */
|
|
1160
438
|
readonly include?: TriggerInclude[];
|
|
1161
439
|
}
|
|
1162
440
|
/**
|
|
1163
|
-
*
|
|
1164
|
-
*
|
|
441
|
+
* References a local file or an artifact from another job to define the pipeline
|
|
442
|
+
* configuration.
|
|
1165
443
|
* @see https://docs.gitlab.com/ee/ci/yaml/#triggerinclude
|
|
1166
|
-
* @experimental
|
|
1167
444
|
*/
|
|
1168
445
|
export interface TriggerInclude {
|
|
1169
|
-
/**
|
|
1170
|
-
* (experimental) Relative path from local repository root (`/`) to the local YAML file to define the pipeline configuration.
|
|
1171
|
-
*
|
|
1172
|
-
* @experimental
|
|
1173
|
-
*/
|
|
446
|
+
/** Relative path from local repository root (`/`) to the local YAML file to define the pipeline configuration.*/
|
|
1174
447
|
readonly local?: string;
|
|
1175
|
-
/**
|
|
1176
|
-
* (experimental) Name of the template YAML file to use in the pipeline configuration.
|
|
1177
|
-
*
|
|
1178
|
-
* @experimental
|
|
1179
|
-
*/
|
|
448
|
+
/** Name of the template YAML file to use in the pipeline configuration.*/
|
|
1180
449
|
readonly template?: string;
|
|
1181
|
-
/**
|
|
1182
|
-
* (experimental) Relative path to the generated YAML file which is extracted from the artifacts and used as the configuration for triggering the child pipeline.
|
|
1183
|
-
*
|
|
1184
|
-
* @experimental
|
|
1185
|
-
*/
|
|
450
|
+
/** Relative path to the generated YAML file which is extracted from the artifacts and used as the configuration for triggering the child pipeline.*/
|
|
1186
451
|
readonly artifact?: string;
|
|
1187
|
-
/**
|
|
1188
|
-
* (experimental) Job name which generates the artifact.
|
|
1189
|
-
*
|
|
1190
|
-
* @experimental
|
|
1191
|
-
*/
|
|
452
|
+
/** Job name which generates the artifact*/
|
|
1192
453
|
readonly job?: string;
|
|
1193
|
-
/**
|
|
1194
|
-
* (experimental) Relative path from repository root (`/`) to the pipeline configuration YAML file.
|
|
1195
|
-
*
|
|
1196
|
-
* @experimental
|
|
1197
|
-
*/
|
|
454
|
+
/** Relative path from repository root (`/`) to the pipeline configuration YAML file.*/
|
|
1198
455
|
readonly file?: string;
|
|
1199
|
-
/**
|
|
1200
|
-
* (experimental) Path to another private project under the same GitLab instance, like `group/project` or `group/sub-group/project`.
|
|
1201
|
-
*
|
|
1202
|
-
* @experimental
|
|
1203
|
-
*/
|
|
456
|
+
/** Path to another private project under the same GitLab instance, like `group/project` or `group/sub-group/project`.*/
|
|
1204
457
|
readonly project?: string;
|
|
1205
|
-
/**
|
|
1206
|
-
* (experimental) Branch/Tag/Commit hash for the target project.
|
|
1207
|
-
*
|
|
1208
|
-
* @experimental
|
|
1209
|
-
*/
|
|
458
|
+
/** Branch/Tag/Commit hash for the target project.*/
|
|
1210
459
|
readonly ref?: string;
|
|
1211
460
|
}
|
|
1212
461
|
/**
|
|
@@ -1215,94 +464,43 @@ export interface TriggerInclude {
|
|
|
1215
464
|
* @see https://docs.gitlab.com/ee/ci/yaml/#triggerstrategy
|
|
1216
465
|
*/
|
|
1217
466
|
export declare enum Strategy {
|
|
1218
|
-
/**
|
|
1219
|
-
* (experimental) You can mirror the pipeline status from the triggered pipeline to the source bridge job by using strategy: depend.
|
|
1220
|
-
*
|
|
1221
|
-
* @see https://docs.gitlab.com/ee/ci/yaml/#triggerstrategy
|
|
1222
|
-
* @experimental
|
|
1223
|
-
*/
|
|
1224
467
|
DEPEND = "depend"
|
|
1225
468
|
}
|
|
1226
469
|
/**
|
|
1227
|
-
*
|
|
1228
|
-
*
|
|
470
|
+
* Explains what the global variable is used for, what the acceptable values are.
|
|
1229
471
|
* @see https://docs.gitlab.com/ee/ci/yaml/#variables
|
|
1230
|
-
* @experimental
|
|
1231
472
|
*/
|
|
1232
473
|
export interface VariableConfig {
|
|
1233
|
-
/**
|
|
1234
|
-
* (experimental) Define a global variable that is prefilled when running a pipeline manually.
|
|
1235
|
-
*
|
|
1236
|
-
* Must be used with value.
|
|
1237
|
-
*
|
|
1238
|
-
* @experimental
|
|
1239
|
-
*/
|
|
474
|
+
/** Define a global variable that is prefilled when running a pipeline manually. Must be used with value. */
|
|
1240
475
|
readonly description?: string;
|
|
1241
|
-
/**
|
|
1242
|
-
* (experimental) The variable value.
|
|
1243
|
-
*
|
|
1244
|
-
* @experimental
|
|
1245
|
-
*/
|
|
476
|
+
/** The variable value. */
|
|
1246
477
|
readonly value?: string;
|
|
1247
478
|
}
|
|
1248
479
|
/**
|
|
1249
|
-
*
|
|
1250
|
-
*
|
|
480
|
+
* Used to control pipeline behavior.
|
|
1251
481
|
* @see https://docs.gitlab.com/ee/ci/yaml/#workflow
|
|
1252
|
-
* @experimental
|
|
1253
482
|
*/
|
|
1254
483
|
export interface Workflow {
|
|
1255
|
-
/**
|
|
1256
|
-
* (experimental) Used to control whether or not a whole pipeline is created.
|
|
1257
|
-
*
|
|
1258
|
-
* @experimental
|
|
1259
|
-
*/
|
|
484
|
+
/** Used to control whether or not a whole pipeline is created. */
|
|
1260
485
|
readonly rules?: WorkflowRule[];
|
|
1261
486
|
}
|
|
1262
487
|
/**
|
|
1263
|
-
*
|
|
1264
|
-
*
|
|
488
|
+
* Used to control whether or not a whole pipeline is created.
|
|
1265
489
|
* @see https://docs.gitlab.com/ee/ci/yaml/#workflowrules
|
|
1266
|
-
* @experimental
|
|
1267
490
|
*/
|
|
1268
491
|
export interface WorkflowRule {
|
|
1269
|
-
/**
|
|
1270
|
-
* @experimental
|
|
1271
|
-
*/
|
|
1272
492
|
readonly changes?: string[];
|
|
1273
|
-
/**
|
|
1274
|
-
* @experimental
|
|
1275
|
-
*/
|
|
1276
493
|
readonly exists?: string[];
|
|
1277
|
-
/**
|
|
1278
|
-
* @experimental
|
|
1279
|
-
*/
|
|
1280
494
|
readonly if?: string;
|
|
1281
|
-
/**
|
|
1282
|
-
* @experimental
|
|
1283
|
-
*/
|
|
1284
495
|
readonly variables?: Record<string, number | string>;
|
|
1285
|
-
/**
|
|
1286
|
-
* @experimental
|
|
1287
|
-
*/
|
|
1288
496
|
readonly when?: JobWhen;
|
|
1289
497
|
}
|
|
1290
498
|
/**
|
|
1291
|
-
*
|
|
1292
|
-
*
|
|
1293
|
-
* Defaults to 'on_success'.
|
|
499
|
+
* Describes the conditions for when to run the job. Defaults to 'on_success'.
|
|
1294
500
|
* The value can only be 'always' or 'never' when used with workflow.
|
|
1295
|
-
*
|
|
1296
501
|
* @see https://docs.gitlab.com/ee/ci/yaml/#workflowrules
|
|
1297
|
-
* @experimental
|
|
1298
502
|
*/
|
|
1299
503
|
export declare enum WorkflowWhen {
|
|
1300
|
-
/**
|
|
1301
|
-
* @experimental
|
|
1302
|
-
*/
|
|
1303
504
|
ALWAYS = "always",
|
|
1304
|
-
/**
|
|
1305
|
-
* @experimental
|
|
1306
|
-
*/
|
|
1307
505
|
NEVER = "never"
|
|
1308
506
|
}
|