@git.zone/cli 12.1.1 → 12.3.0
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/assets/templates/npm/.package.json +1 -1
- package/assets/templates/service/.package.json +1 -1
- package/assets/templates/wcc/.package.json +1 -1
- package/assets/templates/website/.package.json +1 -1
- package/dist_ts/00_commitinfo_data.js +1 -1
- package/dist_ts/helpers.tssea.d.ts +2 -7
- package/dist_ts/helpers.tssea.js +20 -10
- package/dist_ts/helpers.versionsource.d.ts +23 -5
- package/dist_ts/helpers.versionsource.js +115 -37
- package/dist_ts/helpers.workflow.d.ts +60 -17
- package/dist_ts/helpers.workflow.js +156 -51
- package/dist_ts/mod_config/index.js +98 -31
- package/dist_ts/mod_release/classes.releasejournal.d.ts +63 -8
- package/dist_ts/mod_release/classes.releasejournal.js +283 -124
- package/dist_ts/mod_release/helpers.cargorelease.d.ts +4 -3
- package/dist_ts/mod_release/helpers.cargorelease.js +5 -4
- package/dist_ts/mod_release/helpers.fossglobalassets.d.ts +61 -0
- package/dist_ts/mod_release/helpers.fossglobalassets.js +580 -0
- package/dist_ts/mod_release/helpers.giteaassets.d.ts +15 -51
- package/dist_ts/mod_release/helpers.giteaassets.js +40 -507
- package/dist_ts/mod_release/helpers.releaseassets.d.ts +40 -0
- package/dist_ts/mod_release/helpers.releaseassets.js +349 -0
- package/dist_ts/mod_release/helpers.releaseassettransfer.d.ts +67 -0
- package/dist_ts/mod_release/helpers.releaseassettransfer.js +239 -0
- package/dist_ts/mod_release/helpers.releasecheck.js +3 -2
- package/dist_ts/mod_release/helpers.releasepreparation.d.ts +7 -6
- package/dist_ts/mod_release/helpers.releasepreparation.js +34 -7
- package/dist_ts/mod_release/helpers.releasepublication.d.ts +8 -2
- package/dist_ts/mod_release/helpers.releasepublication.js +218 -54
- package/dist_ts/mod_release/helpers.releaseversionsource.d.ts +7 -5
- package/dist_ts/mod_release/helpers.releaseversionsource.js +9 -7
- package/dist_ts/mod_release/index.d.ts +1 -1
- package/dist_ts/mod_release/index.js +109 -68
- package/dist_ts/mod_release/interfaces.fossglobalassets.d.ts +108 -0
- package/dist_ts/mod_release/interfaces.fossglobalassets.js +2 -0
- package/dist_ts/mod_release/interfaces.giteaassets.d.ts +9 -43
- package/dist_ts/mod_release/interfaces.releaseassets.d.ts +68 -0
- package/dist_ts/mod_release/interfaces.releaseassets.js +2 -0
- package/dist_ts/plugins.d.ts +1 -0
- package/dist_ts/plugins.js +1 -1
- package/package.json +3 -2
- package/readme.md +339 -41
- package/ts/00_commitinfo_data.ts +1 -1
- package/ts/helpers.tssea.ts +31 -10
- package/ts/helpers.versionsource.ts +176 -45
- package/ts/helpers.workflow.ts +288 -78
- package/ts/mod_config/index.ts +130 -38
- package/ts/mod_release/classes.releasejournal.ts +499 -180
- package/ts/mod_release/helpers.cargorelease.ts +8 -3
- package/ts/mod_release/helpers.fossglobalassets.ts +886 -0
- package/ts/mod_release/helpers.giteaassets.ts +127 -694
- package/ts/mod_release/helpers.releaseassets.ts +516 -0
- package/ts/mod_release/helpers.releaseassettransfer.ts +339 -0
- package/ts/mod_release/helpers.releasecheck.ts +3 -1
- package/ts/mod_release/helpers.releasepreparation.ts +55 -12
- package/ts/mod_release/helpers.releasepublication.ts +351 -69
- package/ts/mod_release/helpers.releaseversionsource.ts +11 -7
- package/ts/mod_release/index.ts +151 -90
- package/ts/mod_release/interfaces.fossglobalassets.ts +127 -0
- package/ts/mod_release/interfaces.giteaassets.ts +14 -47
- package/ts/mod_release/interfaces.releaseassets.ts +96 -0
- package/ts/plugins.ts +3 -0
package/ts/helpers.workflow.ts
CHANGED
|
@@ -16,10 +16,14 @@ import {
|
|
|
16
16
|
import { defaultNpmVerificationWindowMinutes } from "./mod_release/helpers.npmartifact.js";
|
|
17
17
|
import {
|
|
18
18
|
defaultGiteaAssetConcurrency,
|
|
19
|
-
defaultGiteaAssetTransferLimits,
|
|
20
19
|
maximumGiteaAssetConcurrency,
|
|
21
|
-
type IGiteaAssetTransferLimits,
|
|
22
20
|
} from "./mod_release/helpers.giteaassets.js";
|
|
21
|
+
import {
|
|
22
|
+
releaseAssetTargets,
|
|
23
|
+
type IReleaseAssetTransferLimits,
|
|
24
|
+
type TReleaseAssetTargetName,
|
|
25
|
+
} from "./mod_release/helpers.releaseassets.js";
|
|
26
|
+
import { defaultReleaseAssetTransferLimits } from "./mod_release/helpers.releaseassettransfer.js";
|
|
23
27
|
import {
|
|
24
28
|
planReleaseNpmPackages,
|
|
25
29
|
type IReleaseNpmPackageSet,
|
|
@@ -34,7 +38,12 @@ export type TConfirmationMode = "prompt" | "auto" | "plan";
|
|
|
34
38
|
export type TCommitStep =
|
|
35
39
|
"format" | "analyze" | "test" | "build" | "changelog" | "commit" | "push";
|
|
36
40
|
|
|
37
|
-
export type TReleaseTarget =
|
|
41
|
+
export type TReleaseTarget =
|
|
42
|
+
| "git"
|
|
43
|
+
| TReleaseAssetTargetName
|
|
44
|
+
| "npm"
|
|
45
|
+
| "cargo"
|
|
46
|
+
| "docker";
|
|
38
47
|
|
|
39
48
|
export interface ICommitWorkflowConfig {
|
|
40
49
|
confirmation?: TConfirmationMode;
|
|
@@ -83,7 +92,8 @@ export interface IReleaseNpmTargetConfig {
|
|
|
83
92
|
maxPublishBytes?: Record<string, number>;
|
|
84
93
|
}
|
|
85
94
|
|
|
86
|
-
|
|
95
|
+
/** The configuration every release asset target shares, under `release.targets.<target>`. */
|
|
96
|
+
export interface IReleaseAssetsTargetConfig {
|
|
87
97
|
enabled?: boolean;
|
|
88
98
|
apiOrigin?: string;
|
|
89
99
|
owner?: string;
|
|
@@ -96,6 +106,10 @@ export interface IReleaseGiteaAssetsTargetConfig {
|
|
|
96
106
|
stallTimeoutSeconds?: number;
|
|
97
107
|
/** Rate floor that bounds a whole transfer by its size; default 256. */
|
|
98
108
|
minimumKiBPerSecond?: number;
|
|
109
|
+
}
|
|
110
|
+
|
|
111
|
+
export interface IReleaseGiteaAssetsTargetConfig
|
|
112
|
+
extends IReleaseAssetsTargetConfig {
|
|
99
113
|
/**
|
|
100
114
|
* Attachments of a draft in progress at the same time, largest first;
|
|
101
115
|
* default 1, at most 2. Uploads never overlap and neither do verification
|
|
@@ -106,7 +120,7 @@ export interface IReleaseGiteaAssetsTargetConfig {
|
|
|
106
120
|
concurrency?: number;
|
|
107
121
|
}
|
|
108
122
|
|
|
109
|
-
export interface
|
|
123
|
+
export interface IResolvedReleaseAssetsConfiguration {
|
|
110
124
|
apiOrigin: string;
|
|
111
125
|
owner: string;
|
|
112
126
|
repository: string;
|
|
@@ -114,19 +128,22 @@ export interface IResolvedReleaseGiteaAssetsConfiguration {
|
|
|
114
128
|
manifestPath: string;
|
|
115
129
|
}
|
|
116
130
|
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
131
|
+
/** The identity of a release asset target's destination, validated alike for every target. */
|
|
132
|
+
export const resolveReleaseAssetsConfiguration = (
|
|
133
|
+
targetArg: TReleaseAssetTargetName,
|
|
134
|
+
configArg: IReleaseAssetsTargetConfig,
|
|
135
|
+
): IResolvedReleaseAssetsConfiguration => {
|
|
136
|
+
const { label } = releaseAssetTargets[targetArg];
|
|
120
137
|
const { apiOrigin, owner, repository, tokenEnv, manifestPath } = configArg;
|
|
121
138
|
let url: URL;
|
|
122
139
|
try {
|
|
123
140
|
url = new URL(apiOrigin!);
|
|
124
141
|
} catch {
|
|
125
|
-
throw new Error(
|
|
142
|
+
throw new Error(`${label} assets require a canonical HTTPS API origin.`);
|
|
126
143
|
}
|
|
127
144
|
if (url.protocol !== "https:" || url.origin !== apiOrigin) {
|
|
128
145
|
throw new Error(
|
|
129
|
-
|
|
146
|
+
`${label} assets require a credential-free canonical HTTPS API origin.`,
|
|
130
147
|
);
|
|
131
148
|
}
|
|
132
149
|
if (
|
|
@@ -136,10 +153,12 @@ export const resolveGiteaAssetsConfiguration = (
|
|
|
136
153
|
!/^[A-Za-z0-9][A-Za-z0-9._-]*$/.test(repository)
|
|
137
154
|
)
|
|
138
155
|
throw new Error(
|
|
139
|
-
|
|
156
|
+
`${label} assets require canonical owner and repository names.`,
|
|
140
157
|
);
|
|
141
158
|
if (typeof tokenEnv !== "string" || !/^[A-Z_][A-Z0-9_]*$/.test(tokenEnv)) {
|
|
142
|
-
throw new Error(
|
|
159
|
+
throw new Error(
|
|
160
|
+
`${label} assets require a token environment-variable name.`,
|
|
161
|
+
);
|
|
143
162
|
}
|
|
144
163
|
if (
|
|
145
164
|
typeof manifestPath !== "string" ||
|
|
@@ -152,12 +171,57 @@ export const resolveGiteaAssetsConfiguration = (
|
|
|
152
171
|
)
|
|
153
172
|
)
|
|
154
173
|
throw new Error(
|
|
155
|
-
|
|
174
|
+
`${label} asset manifestPath must be a canonical repository-relative JSON path.`,
|
|
156
175
|
);
|
|
157
176
|
return { apiOrigin, owner, repository, tokenEnv, manifestPath };
|
|
158
177
|
};
|
|
159
178
|
|
|
179
|
+
export const resolveGiteaAssetsConfiguration = (
|
|
180
|
+
configArg: IReleaseGiteaAssetsTargetConfig,
|
|
181
|
+
): IResolvedReleaseAssetsConfiguration =>
|
|
182
|
+
resolveReleaseAssetsConfiguration("giteaAssets", configArg);
|
|
183
|
+
|
|
184
|
+
/** Exactly the keys `release.targets.fossglobalAssets` accepts. */
|
|
185
|
+
const fossglobalAssetsTargetConfigKeys = Object.keys({
|
|
186
|
+
enabled: true,
|
|
187
|
+
apiOrigin: true,
|
|
188
|
+
owner: true,
|
|
189
|
+
repository: true,
|
|
190
|
+
tokenEnv: true,
|
|
191
|
+
manifestPath: true,
|
|
192
|
+
responseTimeoutSeconds: true,
|
|
193
|
+
stallTimeoutSeconds: true,
|
|
194
|
+
minimumKiBPerSecond: true,
|
|
195
|
+
} satisfies Record<keyof IReleaseAssetsTargetConfig, true>);
|
|
196
|
+
|
|
197
|
+
/**
|
|
198
|
+
* The fossglobalAssets destination. The target takes exactly the shared
|
|
199
|
+
* fields, so an unknown key is a typo or a setting it does not have.
|
|
200
|
+
*/
|
|
201
|
+
export const resolveFossglobalAssetsConfiguration = (
|
|
202
|
+
configArg: unknown,
|
|
203
|
+
): IResolvedReleaseAssetsConfiguration => {
|
|
204
|
+
if (
|
|
205
|
+
typeof configArg !== "object" ||
|
|
206
|
+
configArg === null ||
|
|
207
|
+
Array.isArray(configArg)
|
|
208
|
+
)
|
|
209
|
+
throw new Error("release.targets.fossglobalAssets must be an object.");
|
|
210
|
+
const unknownKeys = Object.keys(configArg).filter(
|
|
211
|
+
(keyArg) => !fossglobalAssetsTargetConfigKeys.includes(keyArg),
|
|
212
|
+
);
|
|
213
|
+
if (unknownKeys.length > 0)
|
|
214
|
+
throw new Error(
|
|
215
|
+
`release.targets.fossglobalAssets has unknown keys: ${unknownKeys.join(", ")}. Use ${fossglobalAssetsTargetConfigKeys.join(", ")}.`,
|
|
216
|
+
);
|
|
217
|
+
return resolveReleaseAssetsConfiguration(
|
|
218
|
+
"fossglobalAssets",
|
|
219
|
+
configArg as IReleaseAssetsTargetConfig,
|
|
220
|
+
);
|
|
221
|
+
};
|
|
222
|
+
|
|
160
223
|
const resolveWholeNumber = (
|
|
224
|
+
targetArg: TReleaseAssetTargetName,
|
|
161
225
|
valueArg: unknown,
|
|
162
226
|
keyArg: string,
|
|
163
227
|
defaultArg: number,
|
|
@@ -172,41 +236,55 @@ const resolveWholeNumber = (
|
|
|
172
236
|
valueArg > maximumArg
|
|
173
237
|
)
|
|
174
238
|
throw new Error(
|
|
175
|
-
`release.targets
|
|
239
|
+
`release.targets.${targetArg}.${keyArg} must be a whole number of ${unitArg} between 1 and ${maximumArg}`,
|
|
176
240
|
);
|
|
177
241
|
return valueArg;
|
|
178
242
|
};
|
|
179
243
|
|
|
180
244
|
/** Transfer bounds are tuning, not identity: they may change between resumes. */
|
|
181
|
-
export const
|
|
182
|
-
|
|
183
|
-
|
|
245
|
+
export const resolveReleaseAssetTransferLimits = (
|
|
246
|
+
targetArg: TReleaseAssetTargetName,
|
|
247
|
+
configArg: IReleaseAssetsTargetConfig,
|
|
248
|
+
): IReleaseAssetTransferLimits => ({
|
|
184
249
|
responseTimeoutMs:
|
|
185
250
|
resolveWholeNumber(
|
|
251
|
+
targetArg,
|
|
186
252
|
configArg.responseTimeoutSeconds,
|
|
187
253
|
"responseTimeoutSeconds",
|
|
188
|
-
|
|
254
|
+
defaultReleaseAssetTransferLimits.responseTimeoutMs / 1000,
|
|
189
255
|
3600,
|
|
190
256
|
"seconds",
|
|
191
257
|
) * 1000,
|
|
192
258
|
stallTimeoutMs:
|
|
193
259
|
resolveWholeNumber(
|
|
260
|
+
targetArg,
|
|
194
261
|
configArg.stallTimeoutSeconds,
|
|
195
262
|
"stallTimeoutSeconds",
|
|
196
|
-
|
|
263
|
+
defaultReleaseAssetTransferLimits.stallTimeoutMs / 1000,
|
|
197
264
|
3600,
|
|
198
265
|
"seconds",
|
|
199
266
|
) * 1000,
|
|
200
267
|
minimumBytesPerSecond:
|
|
201
268
|
resolveWholeNumber(
|
|
269
|
+
targetArg,
|
|
202
270
|
configArg.minimumKiBPerSecond,
|
|
203
271
|
"minimumKiBPerSecond",
|
|
204
|
-
|
|
272
|
+
defaultReleaseAssetTransferLimits.minimumBytesPerSecond / 1024,
|
|
205
273
|
1024 * 1024,
|
|
206
274
|
"KiB per second",
|
|
207
275
|
) * 1024,
|
|
208
276
|
});
|
|
209
277
|
|
|
278
|
+
export const resolveGiteaAssetTransferLimits = (
|
|
279
|
+
configArg: IReleaseGiteaAssetsTargetConfig,
|
|
280
|
+
): IReleaseAssetTransferLimits =>
|
|
281
|
+
resolveReleaseAssetTransferLimits("giteaAssets", configArg);
|
|
282
|
+
|
|
283
|
+
export const resolveFossglobalAssetTransferLimits = (
|
|
284
|
+
configArg: IReleaseAssetsTargetConfig,
|
|
285
|
+
): IReleaseAssetTransferLimits =>
|
|
286
|
+
resolveReleaseAssetTransferLimits("fossglobalAssets", configArg);
|
|
287
|
+
|
|
210
288
|
/**
|
|
211
289
|
* How many attachments of a draft are in progress at the same time. Like the
|
|
212
290
|
* transfer bounds this is tuning, not identity: it may change between resumes.
|
|
@@ -215,6 +293,7 @@ export const resolveGiteaAssetConcurrency = (
|
|
|
215
293
|
configArg: IReleaseGiteaAssetsTargetConfig,
|
|
216
294
|
): number =>
|
|
217
295
|
resolveWholeNumber(
|
|
296
|
+
"giteaAssets",
|
|
218
297
|
configArg.concurrency,
|
|
219
298
|
"concurrency",
|
|
220
299
|
defaultGiteaAssetConcurrency,
|
|
@@ -223,17 +302,19 @@ export const resolveGiteaAssetConcurrency = (
|
|
|
223
302
|
);
|
|
224
303
|
|
|
225
304
|
/** Match the resolved destination, without guessing SSH aliases or URL rewrites. */
|
|
226
|
-
export const
|
|
227
|
-
|
|
305
|
+
export const assertReleaseAssetsGitDestination = (
|
|
306
|
+
targetArg: TReleaseAssetTargetName,
|
|
307
|
+
configArg: IResolvedReleaseAssetsConfiguration,
|
|
228
308
|
destinationArg: string,
|
|
229
309
|
): void => {
|
|
310
|
+
const { label } = releaseAssetTargets[targetArg];
|
|
230
311
|
let destination: URL;
|
|
231
312
|
try {
|
|
232
313
|
const scp = destinationArg.match(/^(?:[^@/:]+@)?([^/:]+):([^/].*)$/);
|
|
233
314
|
destination = new URL(scp ? `ssh://${scp[1]}/${scp[2]}` : destinationArg);
|
|
234
315
|
} catch {
|
|
235
316
|
throw new Error(
|
|
236
|
-
|
|
317
|
+
`${label} assets require a provable SSH or HTTPS Git destination.`,
|
|
237
318
|
);
|
|
238
319
|
}
|
|
239
320
|
if (
|
|
@@ -248,7 +329,46 @@ export const assertGiteaAssetsGitDestination = (
|
|
|
248
329
|
`/${configArg.owner}/${configArg.repository}`
|
|
249
330
|
)
|
|
250
331
|
throw new Error(
|
|
251
|
-
|
|
332
|
+
`${label} assets and Git must select the same host and exact repository.`,
|
|
333
|
+
);
|
|
334
|
+
};
|
|
335
|
+
|
|
336
|
+
export const assertGiteaAssetsGitDestination = (
|
|
337
|
+
configArg: IResolvedReleaseAssetsConfiguration,
|
|
338
|
+
destinationArg: string,
|
|
339
|
+
): void =>
|
|
340
|
+
assertReleaseAssetsGitDestination("giteaAssets", configArg, destinationArg);
|
|
341
|
+
|
|
342
|
+
/** The release asset targets in release order. */
|
|
343
|
+
export const releaseAssetTargetNames: readonly TReleaseAssetTargetName[] = [
|
|
344
|
+
"giteaAssets",
|
|
345
|
+
"fossglobalAssets",
|
|
346
|
+
];
|
|
347
|
+
|
|
348
|
+
/** Only `enabled: true` enables a release asset target. */
|
|
349
|
+
const isReleaseAssetTargetEnabled = (
|
|
350
|
+
targetConfigArg: NonNullable<IReleaseWorkflowConfig["targets"]>,
|
|
351
|
+
targetArg: TReleaseAssetTargetName,
|
|
352
|
+
): boolean => {
|
|
353
|
+
const enabled = targetConfigArg[targetArg]?.enabled;
|
|
354
|
+
if (enabled !== undefined && typeof enabled !== "boolean")
|
|
355
|
+
throw new Error(`release.targets.${targetArg}.enabled must be true or false.`);
|
|
356
|
+
return enabled === true;
|
|
357
|
+
};
|
|
358
|
+
|
|
359
|
+
/**
|
|
360
|
+
* A release publishes its assets to one code host, so neither the
|
|
361
|
+
* configuration nor a command line may name two release asset targets.
|
|
362
|
+
*/
|
|
363
|
+
export const assertSingleReleaseAssetTarget = (
|
|
364
|
+
targetsArg: readonly string[],
|
|
365
|
+
): void => {
|
|
366
|
+
const assetTargets = releaseAssetTargetNames.filter((targetArg) =>
|
|
367
|
+
targetsArg.includes(targetArg),
|
|
368
|
+
);
|
|
369
|
+
if (assetTargets.length > 1)
|
|
370
|
+
throw new Error(
|
|
371
|
+
`Release targets ${assetTargets.join(" and ")} are exclusive: a release publishes its assets to one code host.`,
|
|
252
372
|
);
|
|
253
373
|
};
|
|
254
374
|
|
|
@@ -289,10 +409,34 @@ export interface IResolvedReleaseCargoConfiguration {
|
|
|
289
409
|
verificationWindowMinutes: number;
|
|
290
410
|
}
|
|
291
411
|
|
|
412
|
+
/**
|
|
413
|
+
* The Cargo workspace a release versions: `root` for projectType "rust",
|
|
414
|
+
* whose root workspace carries the version instead of a package.json, and
|
|
415
|
+
* `internal` for the `rust/` or `ts_rust/` workspace of a TypeScript project
|
|
416
|
+
* that configures `release.targets.cargo`, which shares package.json's
|
|
417
|
+
* version. Published crates always carry the version gitzone releases.
|
|
418
|
+
*/
|
|
419
|
+
export type TReleaseCargoWorkspace = "root" | "internal";
|
|
420
|
+
|
|
421
|
+
/**
|
|
422
|
+
* Which Cargo workspace the configuration versions, if any. A configured
|
|
423
|
+
* cargo target counts even while it is disabled: the version source is the
|
|
424
|
+
* project's, not one release's, so the crates keep the shared version also
|
|
425
|
+
* when a release does not publish them.
|
|
426
|
+
*/
|
|
427
|
+
export const resolveReleaseCargoWorkspace = (
|
|
428
|
+
projectTypeArg: unknown,
|
|
429
|
+
cargoTargetConfigArg: unknown,
|
|
430
|
+
): TReleaseCargoWorkspace | undefined => {
|
|
431
|
+
if (projectTypeArg === "rust") return "root";
|
|
432
|
+
return cargoTargetConfigArg === undefined ? undefined : "internal";
|
|
433
|
+
};
|
|
434
|
+
|
|
292
435
|
/** The keys `release.targets` accepts; anything else is a typo or a target this gitzone lacks. */
|
|
293
436
|
export const releaseTargetConfigKeys = [
|
|
294
437
|
"git",
|
|
295
438
|
"giteaAssets",
|
|
439
|
+
"fossglobalAssets",
|
|
296
440
|
"npm",
|
|
297
441
|
"docker",
|
|
298
442
|
"cargo",
|
|
@@ -415,6 +559,7 @@ export interface IReleaseWorkflowConfig {
|
|
|
415
559
|
git?: IReleaseGitTargetConfig;
|
|
416
560
|
npm?: IReleaseNpmTargetConfig;
|
|
417
561
|
giteaAssets?: IReleaseGiteaAssetsTargetConfig;
|
|
562
|
+
fossglobalAssets?: IReleaseAssetsTargetConfig;
|
|
418
563
|
docker?: IReleaseDockerTargetConfig;
|
|
419
564
|
cargo?: IReleaseCargoTargetConfig;
|
|
420
565
|
};
|
|
@@ -446,11 +591,11 @@ export interface IResolvedReleaseWorkflow {
|
|
|
446
591
|
testCommand: string;
|
|
447
592
|
buildCommand: string;
|
|
448
593
|
/**
|
|
449
|
-
*
|
|
450
|
-
*
|
|
451
|
-
*
|
|
594
|
+
* The Cargo workspace that carries the release version, read and written
|
|
595
|
+
* through the rsrepo engine; the release checkout fetches its locked Cargo
|
|
596
|
+
* dependencies. Absent when no Cargo workspace shares the version.
|
|
452
597
|
*/
|
|
453
|
-
|
|
598
|
+
cargoWorkspace?: TReleaseCargoWorkspace;
|
|
454
599
|
changelogFile: "changelog.md";
|
|
455
600
|
changelogPendingSection: "Pending";
|
|
456
601
|
changelogVersionHeading: "## {{date}} - {{version}}";
|
|
@@ -477,10 +622,12 @@ export interface IResolvedReleaseWorkflow {
|
|
|
477
622
|
npmMaxPublishBytes: Record<string, number>;
|
|
478
623
|
/** `@git.zone/cli.packageFiles` is configured, so preflight checks package.json files. */
|
|
479
624
|
packageFilesConfigured: boolean;
|
|
480
|
-
giteaAssets?:
|
|
481
|
-
giteaAssetTransfer?:
|
|
625
|
+
giteaAssets?: IResolvedReleaseAssetsConfiguration;
|
|
626
|
+
giteaAssetTransfer?: IReleaseAssetTransferLimits;
|
|
482
627
|
/** Attachments of a draft in progress at the same time. */
|
|
483
628
|
giteaAssetConcurrency?: number;
|
|
629
|
+
fossglobalAssets?: IResolvedReleaseAssetsConfiguration;
|
|
630
|
+
fossglobalAssetTransfer?: IReleaseAssetTransferLimits;
|
|
484
631
|
/** The cargo target's registries, member filter and verification window, when active. */
|
|
485
632
|
cargo?: IResolvedReleaseCargoConfiguration;
|
|
486
633
|
dockerEnabled: boolean;
|
|
@@ -518,10 +665,14 @@ export interface IResolvedReleaseResumeConfiguration {
|
|
|
518
665
|
npmAlreadyPublished: "success" | "error";
|
|
519
666
|
npmVerificationWindowMinutes: number;
|
|
520
667
|
cleanTestArtifacts: boolean;
|
|
521
|
-
giteaAssets?:
|
|
522
|
-
giteaAssetTransfer?:
|
|
668
|
+
giteaAssets?: IResolvedReleaseAssetsConfiguration;
|
|
669
|
+
giteaAssetTransfer?: IReleaseAssetTransferLimits;
|
|
523
670
|
giteaAssetConcurrency?: number;
|
|
671
|
+
fossglobalAssets?: IResolvedReleaseAssetsConfiguration;
|
|
672
|
+
fossglobalAssetTransfer?: IReleaseAssetTransferLimits;
|
|
524
673
|
cargo?: IResolvedReleaseCargoConfiguration;
|
|
674
|
+
/** The workspace the journaled crates come from; present with `cargo`. */
|
|
675
|
+
cargoWorkspace?: TReleaseCargoWorkspace;
|
|
525
676
|
}
|
|
526
677
|
|
|
527
678
|
export type TResolvedReleaseDockerConfiguration = Pick<
|
|
@@ -900,6 +1051,7 @@ const getTargetOverride = (argvArg: any): TReleaseTarget[] | undefined => {
|
|
|
900
1051
|
const validTargets: TReleaseTarget[] = [
|
|
901
1052
|
"git",
|
|
902
1053
|
"giteaAssets",
|
|
1054
|
+
"fossglobalAssets",
|
|
903
1055
|
"npm",
|
|
904
1056
|
"cargo",
|
|
905
1057
|
"docker",
|
|
@@ -942,6 +1094,7 @@ const getTargetOverride = (argvArg: any): TReleaseTarget[] | undefined => {
|
|
|
942
1094
|
const releaseTargetOrder: TReleaseTarget[] = [
|
|
943
1095
|
"git",
|
|
944
1096
|
"giteaAssets",
|
|
1097
|
+
"fossglobalAssets",
|
|
945
1098
|
"npm",
|
|
946
1099
|
"cargo",
|
|
947
1100
|
"docker",
|
|
@@ -959,7 +1112,8 @@ export const releaseNeedsIsolatedCheckout = (
|
|
|
959
1112
|
workflowArg.runBuild ||
|
|
960
1113
|
workflowArg.targets.includes("npm") ||
|
|
961
1114
|
workflowArg.targets.includes("cargo") ||
|
|
962
|
-
workflowArg.targets.includes("giteaAssets")
|
|
1115
|
+
workflowArg.targets.includes("giteaAssets") ||
|
|
1116
|
+
workflowArg.targets.includes("fossglobalAssets");
|
|
963
1117
|
|
|
964
1118
|
const buildReleasePlan = (options: {
|
|
965
1119
|
mergeRequested: boolean;
|
|
@@ -1009,6 +1163,8 @@ const buildReleasePlan = (options: {
|
|
|
1009
1163
|
if (options.targets.includes("cargo")) plan.push("core.packageCrates");
|
|
1010
1164
|
if (options.targets.includes("giteaAssets"))
|
|
1011
1165
|
plan.push("core.freezeGiteaAssets");
|
|
1166
|
+
if (options.targets.includes("fossglobalAssets"))
|
|
1167
|
+
plan.push("core.freezeFossglobalAssets");
|
|
1012
1168
|
plan.push("core.writeReleaseJournal");
|
|
1013
1169
|
if (options.targets.includes("docker")) {
|
|
1014
1170
|
plan.push("target.docker.qualify");
|
|
@@ -1218,7 +1374,8 @@ const assertNoRemovedNpmTargetSettings = (
|
|
|
1218
1374
|
|
|
1219
1375
|
/**
|
|
1220
1376
|
* Gitea marks its newest release as the latest one, which must never follow
|
|
1221
|
-
* an older major,
|
|
1377
|
+
* an older major, and foss.global's latest release follows the same order,
|
|
1378
|
+
* so a maintenance line publishes no release assets. Its
|
|
1222
1379
|
* Docker images are admitted under tSDocker's `release-version` alias policy
|
|
1223
1380
|
* (see `getReleaseDockerAliasPolicy`), which refuses every tag not bound to
|
|
1224
1381
|
* the release version. A line releases its branch in place, so it never
|
|
@@ -1230,9 +1387,11 @@ const assertReleaseLineTargets = (
|
|
|
1230
1387
|
mergeRequestedArg: boolean,
|
|
1231
1388
|
): void => {
|
|
1232
1389
|
if (!lineArg) return;
|
|
1233
|
-
|
|
1390
|
+
for (const target of releaseAssetTargetNames) {
|
|
1391
|
+
if (!targetsArg.includes(target)) continue;
|
|
1392
|
+
const { label } = releaseAssetTargets[target];
|
|
1234
1393
|
throw new Error(
|
|
1235
|
-
`Release line ${lineArg.distTag} does not publish
|
|
1394
|
+
`Release line ${lineArg.distTag} does not publish ${label} assets, because ${label} would mark the older major as its latest release; disable ${target} on ${lineArg.branch}.`,
|
|
1236
1395
|
);
|
|
1237
1396
|
}
|
|
1238
1397
|
if (mergeRequestedArg) {
|
|
@@ -1243,17 +1402,19 @@ const assertReleaseLineTargets = (
|
|
|
1243
1402
|
};
|
|
1244
1403
|
|
|
1245
1404
|
/**
|
|
1246
|
-
* The cargo target publishes a Cargo workspace that gitzone versions
|
|
1247
|
-
*
|
|
1248
|
-
*
|
|
1405
|
+
* The cargo target publishes a Cargo workspace that gitzone versions: the
|
|
1406
|
+
* root workspace of projectType "rust", which carries no package.json version
|
|
1407
|
+
* for npm, or the internal workspace of a TypeScript project, which publishes
|
|
1408
|
+
* npm and crates with one version. Docker and release assets cannot join a
|
|
1409
|
+
* cargo release yet.
|
|
1249
1410
|
*/
|
|
1250
1411
|
const assertCargoReleaseTargets = (
|
|
1251
1412
|
targetsArg: TReleaseTarget[],
|
|
1252
|
-
|
|
1413
|
+
cargoWorkspaceArg: TReleaseCargoWorkspace | undefined,
|
|
1253
1414
|
): void => {
|
|
1254
|
-
if (targetsArg.includes("cargo") && !
|
|
1415
|
+
if (targetsArg.includes("cargo") && !cargoWorkspaceArg)
|
|
1255
1416
|
throw new Error(
|
|
1256
|
-
'The cargo release target publishes a Cargo workspace versioned by gitzone
|
|
1417
|
+
'The cargo release target publishes a Cargo workspace versioned by gitzone: the root workspace of projectType "rust", or the rust/ or ts_rust/ workspace of a TypeScript project that configures release.targets.cargo.',
|
|
1257
1418
|
);
|
|
1258
1419
|
if (
|
|
1259
1420
|
targetsArg.includes("cargo") &&
|
|
@@ -1262,7 +1423,11 @@ const assertCargoReleaseTargets = (
|
|
|
1262
1423
|
throw new Error(
|
|
1263
1424
|
"The cargo release target cannot combine Docker or Gitea assets yet.",
|
|
1264
1425
|
);
|
|
1265
|
-
if (
|
|
1426
|
+
if (targetsArg.includes("cargo") && targetsArg.includes("fossglobalAssets"))
|
|
1427
|
+
throw new Error(
|
|
1428
|
+
"The cargo release target cannot combine foss.global assets yet.",
|
|
1429
|
+
);
|
|
1430
|
+
if (cargoWorkspaceArg === "root" && targetsArg.includes("npm"))
|
|
1266
1431
|
throw new Error(
|
|
1267
1432
|
'projectType "rust" versions its Cargo workspace, so the npm release target has no package.json version to publish.',
|
|
1268
1433
|
);
|
|
@@ -1301,14 +1466,10 @@ export const resolveReleaseWorkflow = async (
|
|
|
1301
1466
|
const npmEnabled = npmConfig.enabled ?? npmRegistryConfigurationPresent;
|
|
1302
1467
|
const gitEnabled = gitConfig.enabled ?? true;
|
|
1303
1468
|
const dockerEnabled = dockerConfig.enabled ?? false;
|
|
1304
|
-
|
|
1305
|
-
targetConfig
|
|
1306
|
-
|
|
1307
|
-
)
|
|
1308
|
-
throw new Error(
|
|
1309
|
-
"release.targets.giteaAssets.enabled must be true or false.",
|
|
1310
|
-
);
|
|
1311
|
-
}
|
|
1469
|
+
const enabledAssetTargets = releaseAssetTargetNames.filter((targetArg) =>
|
|
1470
|
+
isReleaseAssetTargetEnabled(targetConfig, targetArg),
|
|
1471
|
+
);
|
|
1472
|
+
assertSingleReleaseAssetTarget(enabledAssetTargets);
|
|
1312
1473
|
const pushBranch = resolveGitPushSetting(
|
|
1313
1474
|
gitConfig.pushBranch,
|
|
1314
1475
|
"pushBranch",
|
|
@@ -1340,8 +1501,7 @@ export const resolveReleaseWorkflow = async (
|
|
|
1340
1501
|
|
|
1341
1502
|
const configuredTargets: TReleaseTarget[] = [];
|
|
1342
1503
|
if (gitEnabled) configuredTargets.push("git");
|
|
1343
|
-
|
|
1344
|
-
configuredTargets.push("giteaAssets");
|
|
1504
|
+
configuredTargets.push(...enabledAssetTargets);
|
|
1345
1505
|
if (npmEnabled) configuredTargets.push("npm");
|
|
1346
1506
|
if (isCargoTargetEnabled(targetConfig.cargo)) configuredTargets.push("cargo");
|
|
1347
1507
|
if (dockerEnabled) configuredTargets.push("docker");
|
|
@@ -1357,31 +1517,44 @@ export const resolveReleaseWorkflow = async (
|
|
|
1357
1517
|
targets = releaseTargetOrder.filter((target) =>
|
|
1358
1518
|
selectedTargets.includes(target),
|
|
1359
1519
|
);
|
|
1360
|
-
|
|
1361
|
-
|
|
1362
|
-
|
|
1363
|
-
|
|
1364
|
-
|
|
1365
|
-
|
|
1366
|
-
|
|
1367
|
-
)
|
|
1520
|
+
assertSingleReleaseAssetTarget(targets);
|
|
1521
|
+
// npm and Docker promotion follow the asset set, so neither runs without it.
|
|
1522
|
+
for (const target of enabledAssetTargets) {
|
|
1523
|
+
if (targets.includes("npm") && !targets.includes(target))
|
|
1524
|
+
throw new Error(
|
|
1525
|
+
`npm publication cannot bypass the configured ${releaseAssetTargets[target].label} asset target.`,
|
|
1526
|
+
);
|
|
1527
|
+
if (targets.includes("docker") && !targets.includes(target))
|
|
1528
|
+
throw new Error(
|
|
1529
|
+
`Docker publication cannot bypass the configured ${releaseAssetTargets[target].label} asset target.`,
|
|
1530
|
+
);
|
|
1368
1531
|
}
|
|
1369
1532
|
const giteaAssets = targets.includes("giteaAssets")
|
|
1370
1533
|
? resolveGiteaAssetsConfiguration(targetConfig.giteaAssets || {})
|
|
1371
1534
|
: undefined;
|
|
1372
|
-
|
|
1373
|
-
|
|
1374
|
-
|
|
1375
|
-
|
|
1376
|
-
|
|
1377
|
-
|
|
1378
|
-
|
|
1379
|
-
|
|
1380
|
-
)
|
|
1535
|
+
const fossglobalAssets = targets.includes("fossglobalAssets")
|
|
1536
|
+
? resolveFossglobalAssetsConfiguration(targetConfig.fossglobalAssets ?? {})
|
|
1537
|
+
: undefined;
|
|
1538
|
+
const assetTarget = releaseAssetTargetNames.find((targetArg) =>
|
|
1539
|
+
targets.includes(targetArg),
|
|
1540
|
+
);
|
|
1541
|
+
if (assetTarget) {
|
|
1542
|
+
const { label } = releaseAssetTargets[assetTarget];
|
|
1543
|
+
if (!targets.includes("git") || !pushBranch || !pushTags)
|
|
1544
|
+
throw new Error(
|
|
1545
|
+
`${label} assets require the active Git branch and tag target.`,
|
|
1546
|
+
);
|
|
1547
|
+
if (argvArg.merge === true)
|
|
1548
|
+
throw new Error(
|
|
1549
|
+
`${label} asset releases cannot combine --merge; integrate main before release.`,
|
|
1550
|
+
);
|
|
1381
1551
|
}
|
|
1382
1552
|
assertReleaseLineTargets(line, targets, argvArg.merge === true);
|
|
1383
|
-
const
|
|
1384
|
-
|
|
1553
|
+
const cargoWorkspace = resolveReleaseCargoWorkspace(
|
|
1554
|
+
cliConfig.projectType,
|
|
1555
|
+
targetConfig.cargo,
|
|
1556
|
+
);
|
|
1557
|
+
assertCargoReleaseTargets(targets, cargoWorkspace);
|
|
1385
1558
|
if (
|
|
1386
1559
|
prerelease &&
|
|
1387
1560
|
(targets.includes("docker") || targets.includes("giteaAssets"))
|
|
@@ -1389,6 +1562,10 @@ export const resolveReleaseWorkflow = async (
|
|
|
1389
1562
|
throw new Error(
|
|
1390
1563
|
"Prerelease channels support Git and npm targets; Docker and Gitea assets are not supported and must be disabled before releasing.",
|
|
1391
1564
|
);
|
|
1565
|
+
if (prerelease && targets.includes("fossglobalAssets"))
|
|
1566
|
+
throw new Error(
|
|
1567
|
+
"Prerelease channels support Git and npm targets; foss.global assets are not supported and must be disabled before releasing.",
|
|
1568
|
+
);
|
|
1392
1569
|
if (prerelease && argvArg.merge === true)
|
|
1393
1570
|
throw new Error(
|
|
1394
1571
|
"Prerelease channels release integrated main in place; --merge is not supported.",
|
|
@@ -1469,7 +1646,7 @@ export const resolveReleaseWorkflow = async (
|
|
|
1469
1646
|
buildCommand:
|
|
1470
1647
|
releaseConfig.preflight?.buildCommand ||
|
|
1471
1648
|
getDefaultProjectCommands(cliConfig.projectType).build,
|
|
1472
|
-
|
|
1649
|
+
...(cargoWorkspace ? { cargoWorkspace } : {}),
|
|
1473
1650
|
changelogFile: "changelog.md",
|
|
1474
1651
|
changelogPendingSection: "Pending",
|
|
1475
1652
|
changelogVersionHeading: "## {{date}} - {{version}}",
|
|
@@ -1506,6 +1683,14 @@ export const resolveReleaseWorkflow = async (
|
|
|
1506
1683
|
),
|
|
1507
1684
|
}
|
|
1508
1685
|
: {}),
|
|
1686
|
+
...(fossglobalAssets
|
|
1687
|
+
? {
|
|
1688
|
+
fossglobalAssets,
|
|
1689
|
+
fossglobalAssetTransfer: resolveFossglobalAssetTransferLimits(
|
|
1690
|
+
targetConfig.fossglobalAssets ?? {},
|
|
1691
|
+
),
|
|
1692
|
+
}
|
|
1693
|
+
: {}),
|
|
1509
1694
|
...(cargo ? { cargo } : {}),
|
|
1510
1695
|
dockerEnabled,
|
|
1511
1696
|
dockerEngine: "tsdocker",
|
|
@@ -1516,7 +1701,8 @@ export const resolveReleaseWorkflow = async (
|
|
|
1516
1701
|
export const resolveReleaseResumeConfiguration = async (optionsArg: {
|
|
1517
1702
|
git: boolean;
|
|
1518
1703
|
npm: boolean;
|
|
1519
|
-
|
|
1704
|
+
/** The release asset target the journal publishes to, if any. */
|
|
1705
|
+
assetTarget?: TReleaseAssetTargetName;
|
|
1520
1706
|
cargo?: boolean;
|
|
1521
1707
|
}): Promise<IResolvedReleaseResumeConfiguration> => {
|
|
1522
1708
|
const cliConfig = await readCliWorkflowConfig();
|
|
@@ -1534,9 +1720,17 @@ export const resolveReleaseResumeConfiguration = async (optionsArg: {
|
|
|
1534
1720
|
const gitConfig = targetConfig.git || {};
|
|
1535
1721
|
const npmConfig = targetConfig.npm || {};
|
|
1536
1722
|
assertNoRemovedNpmTargetSettings(npmConfig);
|
|
1537
|
-
|
|
1723
|
+
assertSingleReleaseAssetTarget(
|
|
1724
|
+
releaseAssetTargetNames.filter(
|
|
1725
|
+
(targetArg) => targetConfig[targetArg]?.enabled === true,
|
|
1726
|
+
),
|
|
1727
|
+
);
|
|
1728
|
+
if (
|
|
1729
|
+
optionsArg.assetTarget &&
|
|
1730
|
+
targetConfig[optionsArg.assetTarget]?.enabled !== true
|
|
1731
|
+
) {
|
|
1538
1732
|
throw new Error(
|
|
1539
|
-
|
|
1733
|
+
`The journaled ${releaseAssetTargets[optionsArg.assetTarget].label} asset target must remain enabled for resume.`,
|
|
1540
1734
|
);
|
|
1541
1735
|
}
|
|
1542
1736
|
if (optionsArg.cargo && !isCargoTargetEnabled(targetConfig.cargo)) {
|
|
@@ -1610,7 +1804,7 @@ export const resolveReleaseResumeConfiguration = async (optionsArg: {
|
|
|
1610
1804
|
npmAlreadyPublished,
|
|
1611
1805
|
npmVerificationWindowMinutes,
|
|
1612
1806
|
cleanTestArtifacts: await shouldCleanTestArtifactsOnRelease(process.cwd()),
|
|
1613
|
-
...(optionsArg.giteaAssets
|
|
1807
|
+
...(optionsArg.assetTarget === "giteaAssets"
|
|
1614
1808
|
? {
|
|
1615
1809
|
giteaAssets: resolveGiteaAssetsConfiguration(
|
|
1616
1810
|
targetConfig.giteaAssets || {},
|
|
@@ -1623,8 +1817,24 @@ export const resolveReleaseResumeConfiguration = async (optionsArg: {
|
|
|
1623
1817
|
),
|
|
1624
1818
|
}
|
|
1625
1819
|
: {}),
|
|
1820
|
+
...(optionsArg.assetTarget === "fossglobalAssets"
|
|
1821
|
+
? {
|
|
1822
|
+
fossglobalAssets: resolveFossglobalAssetsConfiguration(
|
|
1823
|
+
targetConfig.fossglobalAssets ?? {},
|
|
1824
|
+
),
|
|
1825
|
+
fossglobalAssetTransfer: resolveFossglobalAssetTransferLimits(
|
|
1826
|
+
targetConfig.fossglobalAssets ?? {},
|
|
1827
|
+
),
|
|
1828
|
+
}
|
|
1829
|
+
: {}),
|
|
1626
1830
|
...(optionsArg.cargo
|
|
1627
|
-
? {
|
|
1831
|
+
? {
|
|
1832
|
+
cargo: resolveCargoTargetConfiguration(targetConfig.cargo),
|
|
1833
|
+
cargoWorkspace: resolveReleaseCargoWorkspace(
|
|
1834
|
+
cliConfig.projectType,
|
|
1835
|
+
targetConfig.cargo,
|
|
1836
|
+
)!,
|
|
1837
|
+
}
|
|
1628
1838
|
: {}),
|
|
1629
1839
|
};
|
|
1630
1840
|
};
|