@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.
Files changed (62) hide show
  1. package/assets/templates/npm/.package.json +1 -1
  2. package/assets/templates/service/.package.json +1 -1
  3. package/assets/templates/wcc/.package.json +1 -1
  4. package/assets/templates/website/.package.json +1 -1
  5. package/dist_ts/00_commitinfo_data.js +1 -1
  6. package/dist_ts/helpers.tssea.d.ts +2 -7
  7. package/dist_ts/helpers.tssea.js +20 -10
  8. package/dist_ts/helpers.versionsource.d.ts +23 -5
  9. package/dist_ts/helpers.versionsource.js +115 -37
  10. package/dist_ts/helpers.workflow.d.ts +60 -17
  11. package/dist_ts/helpers.workflow.js +156 -51
  12. package/dist_ts/mod_config/index.js +98 -31
  13. package/dist_ts/mod_release/classes.releasejournal.d.ts +63 -8
  14. package/dist_ts/mod_release/classes.releasejournal.js +283 -124
  15. package/dist_ts/mod_release/helpers.cargorelease.d.ts +4 -3
  16. package/dist_ts/mod_release/helpers.cargorelease.js +5 -4
  17. package/dist_ts/mod_release/helpers.fossglobalassets.d.ts +61 -0
  18. package/dist_ts/mod_release/helpers.fossglobalassets.js +580 -0
  19. package/dist_ts/mod_release/helpers.giteaassets.d.ts +15 -51
  20. package/dist_ts/mod_release/helpers.giteaassets.js +40 -507
  21. package/dist_ts/mod_release/helpers.releaseassets.d.ts +40 -0
  22. package/dist_ts/mod_release/helpers.releaseassets.js +349 -0
  23. package/dist_ts/mod_release/helpers.releaseassettransfer.d.ts +67 -0
  24. package/dist_ts/mod_release/helpers.releaseassettransfer.js +239 -0
  25. package/dist_ts/mod_release/helpers.releasecheck.js +3 -2
  26. package/dist_ts/mod_release/helpers.releasepreparation.d.ts +7 -6
  27. package/dist_ts/mod_release/helpers.releasepreparation.js +34 -7
  28. package/dist_ts/mod_release/helpers.releasepublication.d.ts +8 -2
  29. package/dist_ts/mod_release/helpers.releasepublication.js +218 -54
  30. package/dist_ts/mod_release/helpers.releaseversionsource.d.ts +7 -5
  31. package/dist_ts/mod_release/helpers.releaseversionsource.js +9 -7
  32. package/dist_ts/mod_release/index.d.ts +1 -1
  33. package/dist_ts/mod_release/index.js +109 -68
  34. package/dist_ts/mod_release/interfaces.fossglobalassets.d.ts +108 -0
  35. package/dist_ts/mod_release/interfaces.fossglobalassets.js +2 -0
  36. package/dist_ts/mod_release/interfaces.giteaassets.d.ts +9 -43
  37. package/dist_ts/mod_release/interfaces.releaseassets.d.ts +68 -0
  38. package/dist_ts/mod_release/interfaces.releaseassets.js +2 -0
  39. package/dist_ts/plugins.d.ts +1 -0
  40. package/dist_ts/plugins.js +1 -1
  41. package/package.json +3 -2
  42. package/readme.md +339 -41
  43. package/ts/00_commitinfo_data.ts +1 -1
  44. package/ts/helpers.tssea.ts +31 -10
  45. package/ts/helpers.versionsource.ts +176 -45
  46. package/ts/helpers.workflow.ts +288 -78
  47. package/ts/mod_config/index.ts +130 -38
  48. package/ts/mod_release/classes.releasejournal.ts +499 -180
  49. package/ts/mod_release/helpers.cargorelease.ts +8 -3
  50. package/ts/mod_release/helpers.fossglobalassets.ts +886 -0
  51. package/ts/mod_release/helpers.giteaassets.ts +127 -694
  52. package/ts/mod_release/helpers.releaseassets.ts +516 -0
  53. package/ts/mod_release/helpers.releaseassettransfer.ts +339 -0
  54. package/ts/mod_release/helpers.releasecheck.ts +3 -1
  55. package/ts/mod_release/helpers.releasepreparation.ts +55 -12
  56. package/ts/mod_release/helpers.releasepublication.ts +351 -69
  57. package/ts/mod_release/helpers.releaseversionsource.ts +11 -7
  58. package/ts/mod_release/index.ts +151 -90
  59. package/ts/mod_release/interfaces.fossglobalassets.ts +127 -0
  60. package/ts/mod_release/interfaces.giteaassets.ts +14 -47
  61. package/ts/mod_release/interfaces.releaseassets.ts +96 -0
  62. package/ts/plugins.ts +3 -0
@@ -29,13 +29,24 @@ import {
29
29
  resolveGiteaAssetsConfiguration,
30
30
  resolveGiteaAssetConcurrency,
31
31
  resolveGiteaAssetTransferLimits,
32
+ resolveFossglobalAssetsConfiguration,
33
+ resolveFossglobalAssetTransferLimits,
32
34
  resolveGitRemoteTimeoutSeconds,
33
35
  resolveNpmVerificationWindowMinutes,
34
36
  resolveNpmMaxPublishBytes,
35
37
  normalizeReleaseRegistryUrl,
38
+ releaseAssetTargetNames,
36
39
  resolveDockerTestSetting,
40
+ type IReleaseAssetsTargetConfig,
41
+ type IReleaseGiteaAssetsTargetConfig,
37
42
  } from "../helpers.workflow.js";
38
43
  import { resolvePackageFiles } from "../helpers.packagefiles.js";
44
+ import {
45
+ releaseAssetTargets,
46
+ type IReleaseAssetTransferLimits,
47
+ type TReleaseAssetTargetName,
48
+ } from "../mod_release/helpers.releaseassets.js";
49
+ import { findInternalRustWorkspaceDirectory } from "../helpers.versionsource.js";
39
50
  import { gitzoneProjectTypes } from "../classes.gitzoneconfig.js";
40
51
  import {
41
52
  collectToolConfigFindings,
@@ -363,6 +374,10 @@ async function handleShow(mode: ICliMode): Promise<void> {
363
374
  "giteaAssets",
364
375
  formatTarget(targets.giteaAssets?.enabled, targets.giteaAssets),
365
376
  ],
377
+ [
378
+ "fossglobalAssets",
379
+ formatTarget(targets.fossglobalAssets?.enabled, targets.fossglobalAssets),
380
+ ],
366
381
  ["npm", formatTarget(targets.npm?.enabled, targets.npm)],
367
382
  ["docker", formatTarget(targets.docker?.enabled, targets.docker)],
368
383
  ]);
@@ -2025,6 +2040,45 @@ function validateCommitConfig(
2025
2040
  }
2026
2041
  }
2027
2042
 
2043
+ /** What config doctor reports about a release asset target beyond the checks they share. */
2044
+ interface IReleaseAssetDoctorCheck<TConfig> {
2045
+ /** Resolves the target's configuration and its transfer bounds, and how its uploads are scheduled. */
2046
+ schedule: (configArg: TConfig) => {
2047
+ transfer: IReleaseAssetTransferLimits;
2048
+ uploads: string;
2049
+ };
2050
+ /** What a release proves about the destination before it publishes anything. */
2051
+ preflight: string;
2052
+ }
2053
+
2054
+ const releaseAssetDoctorChecks: {
2055
+ giteaAssets: IReleaseAssetDoctorCheck<IReleaseGiteaAssetsTargetConfig>;
2056
+ fossglobalAssets: IReleaseAssetDoctorCheck<IReleaseAssetsTargetConfig>;
2057
+ } = {
2058
+ giteaAssets: {
2059
+ schedule: (configArg) => {
2060
+ resolveGiteaAssetsConfiguration(configArg);
2061
+ const transfer = resolveGiteaAssetTransferLimits(configArg);
2062
+ const concurrency = resolveGiteaAssetConcurrency(configArg);
2063
+ return {
2064
+ transfer,
2065
+ uploads: `${concurrency === 1 ? "one attachment at a time" : "an upload overlaps the previous attachment's verification download"}, never two uploads or two downloads, so each direction of the link must carry ${transfer.minimumBytesPerSecond / 1024} KiB/s`,
2066
+ };
2067
+ },
2068
+ preflight: "Git destination and publisher capability",
2069
+ },
2070
+ fossglobalAssets: {
2071
+ schedule: (configArg) => {
2072
+ resolveFossglobalAssetsConfiguration(configArg);
2073
+ return {
2074
+ transfer: resolveFossglobalAssetTransferLimits(configArg),
2075
+ uploads: "one asset uploads at a time",
2076
+ };
2077
+ },
2078
+ preflight: "the Git destination and the credential's repository access",
2079
+ },
2080
+ };
2081
+
2028
2082
  async function validateReleaseConfig(
2029
2083
  rawReleaseConfig: unknown,
2030
2084
  smartconfigData: Record<string, any>,
@@ -2077,6 +2131,10 @@ async function validateReleaseConfig(
2077
2131
  throw new Error(
2078
2132
  "Prerelease channels support Git and npm targets; Docker and Gitea assets must be disabled.",
2079
2133
  );
2134
+ if (prerelease && releaseConfig.targets?.fossglobalAssets?.enabled === true)
2135
+ throw new Error(
2136
+ "Prerelease channels support Git and npm targets; foss.global assets must be disabled.",
2137
+ );
2080
2138
  if (prerelease)
2081
2139
  findings.push({
2082
2140
  level: "ok",
@@ -2143,45 +2201,58 @@ async function validateReleaseConfig(
2143
2201
  });
2144
2202
  }
2145
2203
  await validateGitTarget(targets.git || {}, findings);
2146
- if (
2147
- targets.giteaAssets?.enabled !== undefined &&
2148
- typeof targets.giteaAssets.enabled !== "boolean"
2149
- ) {
2150
- findings.push({
2151
- level: "error",
2152
- message: "Gitea assets enabled must be true or false",
2153
- });
2154
- }
2155
- if (targets.giteaAssets?.enabled === true) {
2204
+ for (const target of releaseAssetTargetNames) {
2205
+ const { label } = releaseAssetTargets[target];
2206
+ const { schedule, preflight } = releaseAssetDoctorChecks[target];
2207
+ if (
2208
+ targets[target]?.enabled !== undefined &&
2209
+ typeof targets[target].enabled !== "boolean"
2210
+ ) {
2211
+ findings.push({
2212
+ level: "error",
2213
+ message: `${label} assets enabled must be true or false`,
2214
+ });
2215
+ }
2216
+ if (targets[target]?.enabled !== true) continue;
2156
2217
  try {
2157
- resolveGiteaAssetsConfiguration(targets.giteaAssets);
2158
- const transfer = resolveGiteaAssetTransferLimits(targets.giteaAssets);
2159
- const concurrency = resolveGiteaAssetConcurrency(targets.giteaAssets);
2218
+ const { transfer, uploads } = schedule(targets[target]);
2160
2219
  findings.push({
2161
2220
  level: "ok",
2162
- message: `Gitea asset transfers wait ${transfer.responseTimeoutMs / 1000} s for a response, fail after ${transfer.stallTimeoutMs / 1000} s without progress, and must average at least ${transfer.minimumBytesPerSecond / 1024} KiB/s each; ${concurrency === 1 ? "one attachment at a time" : "an upload overlaps the previous attachment's verification download"}, never two uploads or two downloads, so each direction of the link must carry ${transfer.minimumBytesPerSecond / 1024} KiB/s`,
2221
+ message: `${label} asset transfers wait ${transfer.responseTimeoutMs / 1000} s for a response, fail after ${transfer.stallTimeoutMs / 1000} s without progress, and must average at least ${transfer.minimumBytesPerSecond / 1024} KiB/s each; ${uploads}`,
2163
2222
  });
2164
- if (targets.git?.enabled === false || targets.docker?.enabled === true)
2165
- throw new Error(
2166
- "Gitea assets require Git publication and cannot combine Docker.",
2167
- );
2223
+ if (targets.git?.enabled === false)
2224
+ throw new Error(`${label} assets require Git publication.`);
2168
2225
  findings.push({
2169
2226
  level: "ok",
2170
- message:
2171
- "Gitea assets configured; release verifies Git destination and publisher capability before publication",
2227
+ message: `${label} assets configured; release verifies ${preflight} before publication`,
2172
2228
  });
2229
+ if (targets.docker?.enabled === true)
2230
+ findings.push({
2231
+ level: "ok",
2232
+ message: `${label} assets and Docker publish in one release: the images qualify before Git, and no image is promoted before the complete asset set is published`,
2233
+ });
2173
2234
  } catch (error) {
2174
2235
  findings.push({
2175
2236
  level: "error",
2176
2237
  message:
2177
2238
  error instanceof Error
2178
2239
  ? error.message
2179
- : "Invalid Gitea asset configuration",
2240
+ : `Invalid ${label} asset configuration`,
2180
2241
  });
2181
2242
  }
2182
2243
  }
2244
+ if (
2245
+ targets.giteaAssets?.enabled === true &&
2246
+ targets.fossglobalAssets?.enabled === true
2247
+ )
2248
+ findings.push({
2249
+ level: "error",
2250
+ message:
2251
+ "Release targets giteaAssets and fossglobalAssets are exclusive: a release publishes its assets to one code host",
2252
+ fix: "Disable one of them in release.targets.",
2253
+ });
2183
2254
  await validateNpmTarget(targets.npm || {}, findings);
2184
- validateCargoTarget(targets, projectType, findings);
2255
+ await validateCargoTarget(targets, projectType, findings);
2185
2256
  await validateDockerTarget(
2186
2257
  targets.docker || {},
2187
2258
  smartconfigData,
@@ -2240,13 +2311,14 @@ function validateReleaseLine(
2240
2311
  return undefined;
2241
2312
  }
2242
2313
  const targets = isPlainObject(targetsArg) ? targetsArg : {};
2243
- const isEnabled = (targetArg: "docker" | "giteaAssets"): boolean =>
2314
+ const isEnabled = (targetArg: "docker" | TReleaseAssetTargetName): boolean =>
2244
2315
  isPlainObject(targets[targetArg]) && targets[targetArg].enabled === true;
2245
- if (isEnabled("giteaAssets")) {
2316
+ const assetTarget = releaseAssetTargetNames.find(isEnabled);
2317
+ if (assetTarget) {
2246
2318
  findings.push({
2247
2319
  level: "error",
2248
- message: `Release line ${line.distTag} never publishes Gitea assets, but giteaAssets is enabled`,
2249
- fix: `Disable giteaAssets in release.targets on ${line.branch}.`,
2320
+ message: `Release line ${line.distTag} never publishes ${releaseAssetTargets[assetTarget].label} assets, but ${assetTarget} is enabled`,
2321
+ fix: `Disable ${assetTarget} in release.targets on ${line.branch}.`,
2250
2322
  });
2251
2323
  return line;
2252
2324
  }
@@ -2474,15 +2546,16 @@ async function validateGitTarget(
2474
2546
  }
2475
2547
 
2476
2548
  /**
2477
- * The cargo target publishes the crates of a projectType "rust" workspace in
2549
+ * The cargo target publishes the crates of a projectType "rust" workspace, or
2550
+ * of the internal `rust/` or `ts_rust/` workspace of a TypeScript project, in
2478
2551
  * dependency order. Docker and Gitea assets cannot join it yet, and npm
2479
- * versions package.json, which a Cargo-versioned project does not carry.
2552
+ * versions package.json, which a projectType "rust" project does not carry.
2480
2553
  */
2481
- function validateCargoTarget(
2554
+ async function validateCargoTarget(
2482
2555
  targets: Record<string, unknown>,
2483
2556
  projectType: unknown,
2484
2557
  findings: IDoctorFinding[],
2485
- ): void {
2558
+ ): Promise<void> {
2486
2559
  let enabled: boolean;
2487
2560
  try {
2488
2561
  enabled = isCargoTargetEnabled(targets.cargo);
@@ -2515,30 +2588,49 @@ function validateCargoTarget(
2515
2588
  fix: "Disable release.targets.npm, or publish npm packages from a TypeScript project.",
2516
2589
  });
2517
2590
  }
2591
+ if (targets.cargo === undefined) return;
2592
+ // A configured cargo target, enabled or not, makes a TypeScript project's
2593
+ // internal workspace share package.json's version.
2594
+ let shared = "";
2595
+ if (projectType !== "rust") {
2596
+ const directory = await findInternalRustWorkspaceDirectory(process.cwd());
2597
+ if (!directory) {
2598
+ findings.push({
2599
+ level: "error",
2600
+ message:
2601
+ "release.targets.cargo publishes a Cargo workspace, but this project has none in rust/ or ts_rust/",
2602
+ fix: 'Remove release.targets.cargo, move the crates into a rust/ workspace, or set projectType "rust" for a Rust repository.',
2603
+ });
2604
+ return;
2605
+ }
2606
+ shared = `; package.json and the ${directory}/ Cargo workspace share the release version`;
2607
+ }
2518
2608
  if (!enabled) {
2519
- if (targets.cargo !== undefined)
2520
- findings.push({ level: "ok", message: "cargo release target is disabled" });
2609
+ findings.push({
2610
+ level: "ok",
2611
+ message: `cargo release target is disabled${shared}`,
2612
+ });
2521
2613
  return;
2522
2614
  }
2523
2615
  try {
2524
2616
  const cargo = resolveCargoTargetConfiguration(targets.cargo);
2525
- if (projectType !== "rust")
2526
- throw new Error(
2527
- 'The cargo release target publishes a Cargo workspace versioned by gitzone, which needs projectType "rust".',
2528
- );
2529
2617
  if (targetEnabled("docker") === true || targetEnabled("giteaAssets") === true)
2530
2618
  throw new Error(
2531
2619
  "The cargo release target cannot combine Docker or Gitea assets yet.",
2532
2620
  );
2621
+ if (targetEnabled("fossglobalAssets") === true)
2622
+ throw new Error(
2623
+ "The cargo release target cannot combine foss.global assets yet.",
2624
+ );
2533
2625
  findings.push({
2534
2626
  level: "ok",
2535
- message: `cargo release target publishes ${cargo.members ? cargo.members.join(", ") : "every publishable member"} to ${cargo.registries.join(", ")}; an accepted crate may stay unindexed for ${cargo.verificationWindowMinutes} min`,
2627
+ message: `cargo release target publishes ${cargo.members ? cargo.members.join(", ") : "every publishable member"} to ${cargo.registries.join(", ")}; an accepted crate may stay unindexed for ${cargo.verificationWindowMinutes} min${shared}`,
2536
2628
  });
2537
2629
  } catch (error) {
2538
2630
  findings.push({
2539
2631
  level: "error",
2540
2632
  message: error instanceof Error ? error.message : String(error),
2541
- fix: 'Set release.targets.cargo to { "enabled": true, "registries": ["crates-io"] } on a projectType "rust" project, or remove it.',
2633
+ fix: 'Set release.targets.cargo to { "enabled": true, "registries": ["crates-io"] }, or remove it.',
2542
2634
  });
2543
2635
  }
2544
2636
  }