@schemastore/cloudbuild 0.0.1 → 0.0.6

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.
Files changed (4) hide show
  1. package/LICENSE +1 -1
  2. package/README.md +2 -2
  3. package/index.d.ts +177 -172
  4. package/package.json +4 -4
package/LICENSE CHANGED
@@ -1,6 +1,6 @@
1
1
  MIT License
2
2
 
3
- Copyright (c) Florian Keller. All rights reserved.
3
+ Copyright (c) Florian Imdahl. All rights reserved.
4
4
 
5
5
  Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  of this software and associated documentation files (the "Software"), to deal
package/README.md CHANGED
@@ -5,8 +5,8 @@
5
5
  This package contains type definitions for cloudbuild.
6
6
 
7
7
  ## Details
8
- Files were exported from https://github.com/ffflorian/schemastore-updater/tree/master/schemas/cloudbuild.
8
+ Files were exported from https://github.com/ffflorian/schemastore-updater/tree/main/schemas/cloudbuild.
9
9
 
10
10
  ## Additional Details
11
- * Last updated: Fri, Jul 05, 2019, 15:12:46 GMT
11
+ * Last updated: Tue, Jan 17, 2023, 20:16:45 GMT
12
12
  * Dependencies: none
package/index.d.ts CHANGED
@@ -59,173 +59,9 @@ export interface GoogleCloudBuildBuildConfigFile {
59
59
  * `FAILURE`.
60
60
  */
61
61
  images?: string[];
62
- /**
63
- * Special options for this build.
64
- */
65
- options?: {
66
- /**
67
- * Compute Engine machine type on which to run the build.
68
- */
69
- machineType?: "UNSPECIFIED" | "N1_HIGHCPU_8" | "N1_HIGHCPU_32";
70
- /**
71
- * Global list of volumes to mount for ALL build steps
72
- *
73
- * Each volume is created as an empty volume prior to starting the build
74
- * process. Upon completion of the build, volumes and their contents are
75
- * discarded. Global volume names and paths cannot conflict with the volumes
76
- * defined a build step.
77
- *
78
- * Using a global volume in a build with only one step is not valid as
79
- * it is indicative of a build request with an incorrect configuration.
80
- */
81
- volumes?: Volume[];
82
- /**
83
- * Option to define build log streaming behavior to Google Cloud
84
- * Storage.
85
- */
86
- logStreamingOption?: "STREAM_DEFAULT" | "STREAM_ON" | "STREAM_OFF";
87
- /**
88
- * Option to specify a `WorkerPool` for the build. User specifies the pool
89
- * with the format "[WORKERPOOL_PROJECT_ID]/[WORKERPOOL_NAME]".
90
- * This is an experimental field.
91
- */
92
- workerPool?: string;
93
- /**
94
- * A list of global environment variable definitions that will exist for all
95
- * build steps in this build. If a variable is defined in both globally and in
96
- * a build step, the variable will use the build step value.
97
- *
98
- * The elements are of the form "KEY=VALUE" for the environment variable "KEY"
99
- * being given the value "VALUE".
100
- */
101
- env?: string[];
102
- /**
103
- * Option to specify the logging mode, which determines where the logs are
104
- * stored.
105
- */
106
- logging?: "LOGGING_UNSPECIFIED" | "LEGACY" | "GCS_ONLY";
107
- /**
108
- * Requested verifiability options.
109
- */
110
- requestedVerifyOption?: "NOT_VERIFIED" | "VERIFIED";
111
- /**
112
- * Option to specify behavior when there is an error in the substitution
113
- * checks.
114
- */
115
- substitutionOption?: "MUST_MATCH" | "ALLOW_LOOSE";
116
- /**
117
- * Requested disk size for the VM that runs the build. Note that this is *NOT*
118
- * "disk free"; some of the space will be used by the operating system and
119
- * build utilities. Also note that this is the minimum disk size that will be
120
- * allocated for the build -- the build may run with a larger disk than
121
- * requested. At present, the maximum disk size is 1000GB; builds that request
122
- * more than the maximum are rejected with an error.
123
- */
124
- diskSizeGb?: string;
125
- /**
126
- * A list of global environment variables, which are encrypted using a Cloud
127
- * Key Management Service crypto key. These values must be specified in the
128
- * build's `Secret`. These variables will be available to all build steps
129
- * in this build.
130
- */
131
- secretEnv?: string[];
132
- /**
133
- * Requested hash for SourceProvenance.
134
- */
135
- sourceProvenanceHash?: ("NONE" | "SHA256" | "MD5")[];
136
- [k: string]: any;
137
- };
138
- /**
139
- * The location of the source files to build.
140
- */
141
- source?: {
142
- storageSource?: StorageSource;
143
- /**
144
- * If provided, get the source from this location in a Cloud Source
145
- * Repository.
146
- */
147
- repoSource?: {
148
- /**
149
- * Name of the tag to build.
150
- */
151
- tagName?: string;
152
- /**
153
- * ID of the project that owns the Cloud Source Repository. If omitted, the
154
- * project ID requesting the build is assumed.
155
- */
156
- projectId?: string;
157
- /**
158
- * Name of the Cloud Source Repository. If omitted, the name "default" is
159
- * assumed.
160
- */
161
- repoName?: string;
162
- /**
163
- * Explicit commit SHA to build.
164
- */
165
- commitSha?: string;
166
- /**
167
- * Directory, relative to the source root, in which to run the build.
168
- *
169
- * This must be a relative path. If a step's `dir` is specified and is an
170
- * absolute path, this value is ignored for that step's execution.
171
- */
172
- dir?: string;
173
- /**
174
- * Name of the branch to build.
175
- */
176
- branchName?: string;
177
- [k: string]: any;
178
- };
179
- [k: string]: any;
180
- };
181
- /**
182
- * Artifacts produced by the build that should be uploaded upon
183
- * successful completion of all build steps.
184
- */
185
- artifacts?: {
186
- /**
187
- * A list of objects to be uploaded to Cloud Storage upon successful
188
- * completion of all build steps.
189
- *
190
- * Files in the workspace matching specified paths globs will be uploaded to
191
- * the specified Cloud Storage location using the builder service account's
192
- * credentials.
193
- *
194
- * The location and generation of the uploaded objects will be stored in the
195
- * Build resource's results field.
196
- *
197
- * If any objects fail to be pushed, the build is marked FAILURE.
198
- */
199
- objects?: {
200
- /**
201
- * Cloud Storage bucket and optional object path, in the form
202
- * "gs://bucket/path/to/somewhere/". (see [Bucket Name
203
- * Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
204
- *
205
- * Files in the workspace matching any path pattern will be uploaded to
206
- * Cloud Storage with this location as a prefix.
207
- */
208
- location?: string;
209
- /**
210
- * Path globs used to match files in the build's workspace.
211
- */
212
- paths?: string[];
213
- [k: string]: any;
214
- };
215
- /**
216
- * A list of images to be pushed upon the successful completion of all build
217
- * steps.
218
- *
219
- * The images will be pushed using the builder service account's credentials.
220
- *
221
- * The digests of the pushed images will be stored in the Build resource's
222
- * results field.
223
- *
224
- * If any of the images fail to be pushed, the build is marked FAILURE.
225
- */
226
- images?: string[];
227
- [k: string]: any;
228
- };
62
+ options?: BuildOptions;
63
+ source?: Source;
64
+ artifacts?: Artifacts;
229
65
  /**
230
66
  * Amount of time that this build should be allowed to run, to second
231
67
  * granularity. If this amount of time elapses, work on the build will cease
@@ -238,7 +74,7 @@ export interface GoogleCloudBuildBuildConfigFile {
238
74
  * Secrets to decrypt using Cloud Key Management Service.
239
75
  */
240
76
  secrets?: Secret[];
241
- [k: string]: any;
77
+ [k: string]: unknown;
242
78
  }
243
79
  /**
244
80
  * A step in the build pipeline.
@@ -334,7 +170,7 @@ export interface BuildStep {
334
170
  * the step's execution.
335
171
  */
336
172
  dir?: string;
337
- [k: string]: any;
173
+ [k: string]: unknown;
338
174
  }
339
175
  /**
340
176
  * Volume describes a Docker container volume which is mounted into build steps
@@ -355,7 +191,91 @@ export interface Volume {
355
191
  * same build step or with certain reserved volume paths.
356
192
  */
357
193
  path?: string;
358
- [k: string]: any;
194
+ [k: string]: unknown;
195
+ }
196
+ /**
197
+ * Special options for this build.
198
+ */
199
+ export interface BuildOptions {
200
+ /**
201
+ * Compute Engine machine type on which to run the build.
202
+ */
203
+ machineType?: "UNSPECIFIED" | "N1_HIGHCPU_8" | "N1_HIGHCPU_32" | "E2_HIGHCPU_8" | "E2_HIGHCPU_32";
204
+ /**
205
+ * Global list of volumes to mount for ALL build steps
206
+ *
207
+ * Each volume is created as an empty volume prior to starting the build
208
+ * process. Upon completion of the build, volumes and their contents are
209
+ * discarded. Global volume names and paths cannot conflict with the volumes
210
+ * defined a build step.
211
+ *
212
+ * Using a global volume in a build with only one step is not valid as
213
+ * it is indicative of a build request with an incorrect configuration.
214
+ */
215
+ volumes?: Volume[];
216
+ /**
217
+ * Option to define build log streaming behavior to Google Cloud
218
+ * Storage.
219
+ */
220
+ logStreamingOption?: "STREAM_DEFAULT" | "STREAM_ON" | "STREAM_OFF";
221
+ /**
222
+ * Option to specify a `WorkerPool` for the build. User specifies the pool
223
+ * with the format "[WORKERPOOL_PROJECT_ID]/[WORKERPOOL_NAME]".
224
+ * This is an experimental field.
225
+ */
226
+ workerPool?: string;
227
+ /**
228
+ * A list of global environment variable definitions that will exist for all
229
+ * build steps in this build. If a variable is defined in both globally and in
230
+ * a build step, the variable will use the build step value.
231
+ *
232
+ * The elements are of the form "KEY=VALUE" for the environment variable "KEY"
233
+ * being given the value "VALUE".
234
+ */
235
+ env?: string[];
236
+ /**
237
+ * Option to specify the logging mode, which determines where the logs are
238
+ * stored.
239
+ */
240
+ logging?: "LOGGING_UNSPECIFIED" | "LEGACY" | "GCS_ONLY" | "CLOUD_LOGGING_ONLY" | "NONE";
241
+ /**
242
+ * Requested verifiability options.
243
+ */
244
+ requestedVerifyOption?: "NOT_VERIFIED" | "VERIFIED";
245
+ /**
246
+ * Option to specify behavior when there is an error in the substitution
247
+ * checks.
248
+ */
249
+ substitutionOption?: "MUST_MATCH" | "ALLOW_LOOSE";
250
+ /**
251
+ * Requested disk size for the VM that runs the build. Note that this is *NOT*
252
+ * "disk free"; some of the space will be used by the operating system and
253
+ * build utilities. Also note that this is the minimum disk size that will be
254
+ * allocated for the build -- the build may run with a larger disk than
255
+ * requested. At present, the maximum disk size is 1000GB; builds that request
256
+ * more than the maximum are rejected with an error.
257
+ */
258
+ diskSizeGb?: string;
259
+ /**
260
+ * A list of global environment variables, which are encrypted using a Cloud
261
+ * Key Management Service crypto key. These values must be specified in the
262
+ * build's `Secret`. These variables will be available to all build steps
263
+ * in this build.
264
+ */
265
+ secretEnv?: string[];
266
+ /**
267
+ * Requested hash for SourceProvenance.
268
+ */
269
+ sourceProvenanceHash?: ("NONE" | "SHA256" | "MD5")[];
270
+ [k: string]: unknown;
271
+ }
272
+ /**
273
+ * The location of the source files to build.
274
+ */
275
+ export interface Source {
276
+ storageSource?: StorageSource;
277
+ repoSource?: RepoSource;
278
+ [k: string]: unknown;
359
279
  }
360
280
  /**
361
281
  * If provided, get the source from this location in Google Cloud Storage.
@@ -379,7 +299,92 @@ export interface StorageSource {
379
299
  * build.
380
300
  */
381
301
  object?: string;
382
- [k: string]: any;
302
+ [k: string]: unknown;
303
+ }
304
+ /**
305
+ * If provided, get the source from this location in a Cloud Source
306
+ * Repository.
307
+ */
308
+ export interface RepoSource {
309
+ /**
310
+ * Name of the tag to build.
311
+ */
312
+ tagName?: string;
313
+ /**
314
+ * ID of the project that owns the Cloud Source Repository. If omitted, the
315
+ * project ID requesting the build is assumed.
316
+ */
317
+ projectId?: string;
318
+ /**
319
+ * Name of the Cloud Source Repository. If omitted, the name "default" is
320
+ * assumed.
321
+ */
322
+ repoName?: string;
323
+ /**
324
+ * Explicit commit SHA to build.
325
+ */
326
+ commitSha?: string;
327
+ /**
328
+ * Directory, relative to the source root, in which to run the build.
329
+ *
330
+ * This must be a relative path. If a step's `dir` is specified and is an
331
+ * absolute path, this value is ignored for that step's execution.
332
+ */
333
+ dir?: string;
334
+ /**
335
+ * Name of the branch to build.
336
+ */
337
+ branchName?: string;
338
+ [k: string]: unknown;
339
+ }
340
+ /**
341
+ * Artifacts produced by the build that should be uploaded upon
342
+ * successful completion of all build steps.
343
+ */
344
+ export interface Artifacts {
345
+ objects?: ArtifactObjects;
346
+ /**
347
+ * A list of images to be pushed upon the successful completion of all build
348
+ * steps.
349
+ *
350
+ * The images will be pushed using the builder service account's credentials.
351
+ *
352
+ * The digests of the pushed images will be stored in the Build resource's
353
+ * results field.
354
+ *
355
+ * If any of the images fail to be pushed, the build is marked FAILURE.
356
+ */
357
+ images?: string[];
358
+ [k: string]: unknown;
359
+ }
360
+ /**
361
+ * A list of objects to be uploaded to Cloud Storage upon successful
362
+ * completion of all build steps.
363
+ *
364
+ * Files in the workspace matching specified paths globs will be uploaded to
365
+ * the specified Cloud Storage location using the builder service account's
366
+ * credentials.
367
+ *
368
+ * The location and generation of the uploaded objects will be stored in the
369
+ * Build resource's results field.
370
+ *
371
+ * If any objects fail to be pushed, the build is marked FAILURE.
372
+ */
373
+ export interface ArtifactObjects {
374
+ /**
375
+ * Cloud Storage bucket and optional object path, in the form
376
+ * "gs://bucket/path/to/somewhere/". (see [Bucket Name
377
+ * Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
378
+ *
379
+ * Files in the workspace matching any path pattern will be uploaded to
380
+ * Cloud Storage with this location as a prefix.
381
+ */
382
+ location?: string;
383
+ /**
384
+ * Path globs used to match files in the build's workspace.
385
+ */
386
+ paths?: string[];
387
+ [k: string]: unknown;
383
388
  }
384
389
  /**
385
390
  * Pairs a set of secret environment variables containing encrypted
@@ -401,5 +406,5 @@ export interface Secret {
401
406
  secretEnv?: {
402
407
  [k: string]: string;
403
408
  };
404
- [k: string]: any;
409
+ [k: string]: unknown;
405
410
  }
package/package.json CHANGED
@@ -1,14 +1,14 @@
1
1
  {
2
- "author": "Florian Keller <github@floriankeller.de>",
2
+ "author": "Florian Imdahl <git@ffflorian.de>",
3
3
  "dependencies": {},
4
4
  "description": "TypeScript definitions for cloudbuild.",
5
5
  "license": "MIT",
6
6
  "main": "index.d.ts",
7
7
  "name": "@schemastore/cloudbuild",
8
- "repository": "https://github.com/ffflorian/schemastore-updater/tree/master/schemas/cloudbuild",
8
+ "repository": "https://github.com/ffflorian/schemastore-updater/tree/main/schemas/cloudbuild",
9
9
  "scripts": {},
10
- "typesPublisherContentHash": "f34346452b14c907f71fcc3f926aa1b4eedb0daada291e319151d3fe2891d337",
10
+ "typesPublisherContentHash": "0667c383101f7aac9a70d29edafb2792c710db18a84edc94c245c2d773e50882",
11
11
  "types": "index.d.ts",
12
- "version": "0.0.1",
12
+ "version": "0.0.6",
13
13
  "typeScriptVersion": "2.2"
14
14
  }