@git.zone/cli 8.10.0 → 8.11.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 (68) hide show
  1. package/assets/templates/asset_tspack_release_gitea/scripts/gitzone-gitea-tag.d.mts +9 -3
  2. package/assets/templates/asset_tspack_release_gitea/scripts/gitzone-gitea-tag.mjs +50 -6
  3. package/assets/templates/asset_tspack_release_gitea/scripts/gitzone-release-api.mjs +7 -6
  4. package/assets/templates/npm/.package.json +1 -1
  5. package/assets/templates/service/.package.json +1 -1
  6. package/assets/templates/wcc/.package.json +1 -1
  7. package/assets/templates/website/.package.json +1 -1
  8. package/dist_ts/00_commitinfo_data.js +1 -1
  9. package/dist_ts/classes.project.js +1 -1
  10. package/dist_ts/gitzone.cli.js +1 -1
  11. package/dist_ts/helpers.climode.d.ts +2 -1
  12. package/dist_ts/helpers.climode.js +1 -1
  13. package/dist_ts/helpers.ownerscopes.d.ts +1 -1
  14. package/dist_ts/helpers.ownerscopes.js +2 -1
  15. package/dist_ts/helpers.smartconfig.js +1 -1
  16. package/dist_ts/helpers.tsdocker.js +1 -1
  17. package/dist_ts/helpers.tstest.js +1 -1
  18. package/dist_ts/helpers.workflow.d.ts +7 -0
  19. package/dist_ts/helpers.workflow.js +15 -1
  20. package/dist_ts/mod_commit/index.js +1 -1
  21. package/dist_ts/mod_config/classes.commitconfig.js +1 -1
  22. package/dist_ts/mod_config/classes.releaseconfig.js +1 -1
  23. package/dist_ts/mod_deprecate/helpers.deprecation.js +1 -1
  24. package/dist_ts/mod_deprecate/index.js +1 -1
  25. package/dist_ts/mod_format/classes.formatcontext.js +1 -1
  26. package/dist_ts/mod_format/classes.formatplanner.js +1 -1
  27. package/dist_ts/mod_format/classes.formatstats.js +1 -1
  28. package/dist_ts/mod_format/formatters/assets.formatter.js +1 -1
  29. package/dist_ts/mod_format/formatters/deno.formatter.js +1 -1
  30. package/dist_ts/mod_format/index.js +1 -1
  31. package/dist_ts/mod_release/classes.releasejournal.d.ts +70 -0
  32. package/dist_ts/mod_release/classes.releasejournal.js +273 -5
  33. package/dist_ts/mod_release/helpers.giteaassets.js +18 -9
  34. package/dist_ts/mod_release/helpers.gitremote.js +1 -1
  35. package/dist_ts/mod_release/helpers.npmartifact.js +1 -1
  36. package/dist_ts/mod_release/helpers.npmartifactcheck.js +1 -1
  37. package/dist_ts/mod_release/helpers.releasephase.js +1 -1
  38. package/dist_ts/mod_release/helpers.releaseversion.js +1 -1
  39. package/dist_ts/mod_release/helpers.tsdockerprotocol.js +1 -1
  40. package/dist_ts/mod_release/index.js +131 -9
  41. package/dist_ts/mod_services/classes.dockercontainer.js +1 -1
  42. package/dist_ts/mod_services/classes.globalregistry.js +1 -1
  43. package/dist_ts/mod_services/classes.globalregistrystore.js +1 -1
  44. package/dist_ts/mod_services/classes.legacymongomigration.d.ts +1 -1
  45. package/dist_ts/mod_services/classes.legacymongomigration.js +1 -1
  46. package/dist_ts/mod_services/classes.serviceconfiguration.js +1 -1
  47. package/dist_ts/mod_services/classes.servicemanager.js +1 -1
  48. package/dist_ts/mod_services/classes.servicenames.js +1 -1
  49. package/dist_ts/mod_services/classes.serviceoptions.js +1 -1
  50. package/dist_ts/mod_services/classes.servicepruner.js +1 -1
  51. package/dist_ts/mod_services/helpers.js +1 -1
  52. package/dist_ts/mod_services/index.js +1 -1
  53. package/dist_ts/mod_standard/index.js +1 -1
  54. package/dist_ts/mod_testing/classes.commands.js +1 -1
  55. package/dist_ts/mod_testing/classes.runtime.js +1 -1
  56. package/dist_ts/mod_testing/index.js +1 -1
  57. package/dist_ts/mod_tools/index.js +1 -1
  58. package/dist_ts/paths.js +1 -1
  59. package/dist_ts_migration/001.service-selection.js +1 -1
  60. package/dist_ts_migration/004.global-registry.js +1 -1
  61. package/package.json +6 -6
  62. package/readme.md +106 -3
  63. package/ts/00_commitinfo_data.ts +1 -1
  64. package/ts/helpers.ownerscopes.ts +1 -0
  65. package/ts/helpers.workflow.ts +28 -0
  66. package/ts/mod_release/classes.releasejournal.ts +358 -5
  67. package/ts/mod_release/helpers.giteaassets.ts +19 -10
  68. package/ts/mod_release/index.ts +238 -31
@@ -13,6 +13,7 @@ import {
13
13
  resolveReleaseDockerConfiguration,
14
14
  resolveReleaseWorkflow,
15
15
  resolveReleaseResumeConfiguration,
16
+ readReleaseRecordRetention,
16
17
  assertGiteaAssetsGitDestination,
17
18
  type IResolvedReleaseResumeConfiguration,
18
19
  type IResolvedReleaseWorkflow,
@@ -50,7 +51,9 @@ import {
50
51
  type IReleaseJournalV2,
51
52
  releaseIntentKind,
52
53
  type IReleaseIntent,
54
+ type IReleaseRecordPruneReport,
53
55
  } from "./classes.releasejournal.js";
56
+ import { formatBytes } from "../mod_services/helpers.js";
54
57
  import { createReleaseGitRemotePolicy } from "./helpers.gitremote.js";
55
58
  import {
56
59
  GiteaAssetsClient,
@@ -83,7 +86,10 @@ import {
83
86
  latestDistTag,
84
87
  type IReleaseLine,
85
88
  } from "./helpers.releaseline.js";
86
- import { executeReleasePublication } from "./helpers.releasepublication.js";
89
+ import {
90
+ executeReleasePublication,
91
+ type IReleasePublicationOptions,
92
+ } from "./helpers.releasepublication.js";
87
93
  import {
88
94
  findNpmArtifactCheckError,
89
95
  verifyPackedNpmArtifacts,
@@ -172,6 +178,10 @@ const runInternal = async (argvArg: any): Promise<void> => {
172
178
  await runReleaseRecover(argvArg, mode);
173
179
  return;
174
180
  }
181
+ if (subcommand === "prune") {
182
+ await runReleasePrune(argvArg, mode);
183
+ return;
184
+ }
175
185
  if (subcommand !== undefined) {
176
186
  throw new Error(`Unknown release subcommand: ${subcommand}`);
177
187
  }
@@ -459,20 +469,23 @@ const runInternal = async (argvArg: any): Promise<void> => {
459
469
  { cause: error },
460
470
  );
461
471
  }
462
- const finalJournal = await executeReleasePublication({
463
- pnpmCapability,
464
- smartshell: smartshellInstance,
465
- cwd: releaseCwd,
466
- store: journalContext.store,
467
- journal: journalContext.journal,
468
- pushUrl: releasePushUrl,
469
- npmVerificationWindowMs: workflow.npmVerificationWindowMinutes * 60_000,
470
- giteaAssetTransfer: workflow.giteaAssetTransfer,
471
- giteaAssetConcurrency: workflow.giteaAssetConcurrency,
472
- gitRemotePolicy: branchContext.gitRemotePolicy,
473
- tsdocker: journalContext.tsdocker,
474
- ensurePublicationState,
475
- });
472
+ const finalJournal = await publishReleaseWithRetention(
473
+ {
474
+ pnpmCapability,
475
+ smartshell: smartshellInstance,
476
+ cwd: releaseCwd,
477
+ store: journalContext.store,
478
+ journal: journalContext.journal,
479
+ pushUrl: releasePushUrl,
480
+ npmVerificationWindowMs: workflow.npmVerificationWindowMinutes * 60_000,
481
+ giteaAssetTransfer: workflow.giteaAssetTransfer,
482
+ giteaAssetConcurrency: workflow.giteaAssetConcurrency,
483
+ gitRemotePolicy: branchContext.gitRemotePolicy,
484
+ tsdocker: journalContext.tsdocker,
485
+ ensurePublicationState,
486
+ },
487
+ workflow.recordRetention,
488
+ );
476
489
  await cleanTestArtifactsForCompletedRelease(
477
490
  smartshellInstance,
478
491
  releaseCwd,
@@ -482,6 +495,35 @@ const runInternal = async (argvArg: any): Promise<void> => {
482
495
  printReleaseJournalSummary(finalJournal);
483
496
  };
484
497
 
498
+ const publishReleaseWithRetention = async (
499
+ optionsArg: IReleasePublicationOptions,
500
+ keepArg: number,
501
+ ): Promise<TReleaseJournal> =>
502
+ optionsArg.store.withReleaseRecord(
503
+ optionsArg.journal.release.version,
504
+ async () => {
505
+ const journal = await executeReleasePublication(optionsArg);
506
+ await pruneCompletedReleaseRecords(optionsArg.store, journal, keepArg);
507
+ return journal;
508
+ },
509
+ );
510
+
511
+ const pruneCompletedReleaseRecords = async (
512
+ storeArg: ReleaseJournalStore,
513
+ journalArg: TReleaseJournal,
514
+ keepArg: number,
515
+ ): Promise<void> => {
516
+ if (journalArg.completedAt === null) return;
517
+ const versions = await storeArg.pruneCompleted(
518
+ keepArg,
519
+ journalArg.release.version,
520
+ );
521
+ if (versions.length > 0)
522
+ console.log(
523
+ `Pruned completed release records: ${versions.map((version) => `v${version}`).join(", ")}`,
524
+ );
525
+ };
526
+
485
527
  /**
486
528
  * What an operator does after the release failed between its tag and its
487
529
  * journal. Most such failures are environmental, and resuming the recorded
@@ -1349,6 +1391,117 @@ const runReleaseInspect = async (
1349
1391
  }
1350
1392
  };
1351
1393
 
1394
+ /**
1395
+ * Applies record retention on demand, through the same store method a
1396
+ * completed release uses. Without `--apply` it only reports.
1397
+ */
1398
+ const runReleasePrune = async (
1399
+ argvArg: any,
1400
+ modeArg: ICliMode,
1401
+ ): Promise<void> => {
1402
+ try {
1403
+ const report = await pruneReleaseRecordsOnDemand(argvArg);
1404
+ if (modeArg.json) {
1405
+ printJson({ ok: true, ...report });
1406
+ return;
1407
+ }
1408
+ printReleasePruneReport(report);
1409
+ } catch (error) {
1410
+ if (!modeArg.json) throw error;
1411
+ printJson({
1412
+ ok: false,
1413
+ error: error instanceof Error ? error.message : String(error),
1414
+ });
1415
+ process.exitCode = 1;
1416
+ }
1417
+ };
1418
+
1419
+ const pruneReleaseRecordsOnDemand = async (
1420
+ argvArg: any,
1421
+ ): Promise<IReleaseRecordPruneReport> => {
1422
+ const allowed = new Set([
1423
+ "_",
1424
+ "$0",
1425
+ "apply",
1426
+ "keep",
1427
+ "json",
1428
+ "output",
1429
+ "plain",
1430
+ "quiet",
1431
+ "q",
1432
+ "agent",
1433
+ "interactive",
1434
+ "check-updates",
1435
+ "checkUpdates",
1436
+ ]);
1437
+ if (
1438
+ argvArg._?.length !== 2 ||
1439
+ Object.keys(argvArg).some((key) => !allowed.has(key)) ||
1440
+ (argvArg.apply !== undefined && argvArg.apply !== true)
1441
+ ) {
1442
+ throw new Error(
1443
+ "Usage: gitzone release prune [--apply] [--keep <n>] [--json]",
1444
+ );
1445
+ }
1446
+ let keep: number;
1447
+ if (argvArg.keep === undefined) {
1448
+ keep = await readReleaseRecordRetention();
1449
+ } else if (
1450
+ typeof argvArg.keep === "string" &&
1451
+ /^[1-9][0-9]*$/.test(argvArg.keep) &&
1452
+ Number.isSafeInteger(Number(argvArg.keep))
1453
+ ) {
1454
+ keep = Number(argvArg.keep);
1455
+ } else {
1456
+ throw new Error("--keep must be a positive integer.");
1457
+ }
1458
+ const store = new ReleaseJournalStore(
1459
+ await resolveGitCommonDirectory(
1460
+ new plugins.smartshell.Smartshell({
1461
+ executor: "bash",
1462
+ sourceFilePaths: [],
1463
+ }),
1464
+ paths.cwd,
1465
+ ),
1466
+ );
1467
+ const active = await store.findActiveReleaseState();
1468
+ if (active.length > 0) {
1469
+ throw new Error(
1470
+ `A release of this repository is in progress; prune refuses to run until it ends. ` +
1471
+ `If no release process is left, inspect and remove: ${active.join(", ")}`,
1472
+ );
1473
+ }
1474
+ return store.pruneRecords({ keep, apply: argvArg.apply === true });
1475
+ };
1476
+
1477
+ const printReleasePruneReport = (reportArg: IReleaseRecordPruneReport) => {
1478
+ console.log(
1479
+ `gitzone release prune - ${reportArg.dryRun ? "dry run" : "applied"}: newest ${reportArg.keep} completed records keep their payloads`,
1480
+ );
1481
+ if (reportArg.records.length === 0) {
1482
+ console.log("No release records found.");
1483
+ return;
1484
+ }
1485
+ for (const entry of reportArg.records) {
1486
+ console.log(
1487
+ ` v${entry.version} ${entry.state} ${formatBytes(entry.bytes)} ${entry.action}: ${entry.reason}${entry.payloadBytes > 0 ? ` (payload ${formatBytes(entry.payloadBytes)})` : ""}${entry.detail ? ` - ${entry.detail}` : ""}`,
1488
+ );
1489
+ }
1490
+ const { totals } = reportArg;
1491
+ console.log(
1492
+ `Records: ${totals.records} (kept ${totals.kept}, pruned ${totals.pruned}, blocked ${totals.blocked}); on disk ${formatBytes(totals.bytes)}`,
1493
+ );
1494
+ if (reportArg.records.some((entry) => entry.state === "invalid"))
1495
+ console.log(
1496
+ "An invalid journal stops --apply before anything is deleted; repair or remove that record first.",
1497
+ );
1498
+ console.log(
1499
+ reportArg.dryRun
1500
+ ? `Would free ${formatBytes(totals.wouldFreeBytes)}. Run \`gitzone release prune --apply\` to delete it.`
1501
+ : `Freed ${formatBytes(totals.freedBytes)}.`,
1502
+ );
1503
+ };
1504
+
1352
1505
  const describeDetachedReleaseRun = (runArg: IDetachedReleaseRun): string => {
1353
1506
  const release = `gitzone ${runArg.command.join(" ")} (v${runArg.version})`;
1354
1507
  const outcome =
@@ -1551,20 +1704,23 @@ const runReleaseRecover = async (
1551
1704
  },
1552
1705
  }),
1553
1706
  );
1554
- const result = await executeReleasePublication({
1555
- pnpmCapability,
1556
- smartshell: shell,
1557
- cwd: paths.cwd,
1558
- store: context.store,
1559
- journal: context.journal,
1560
- pushUrl: branch.pushUrl,
1561
- npmVerificationWindowMs: workflow.npmVerificationWindowMinutes * 60_000,
1562
- giteaAssetTransfer: workflow.giteaAssetTransfer,
1563
- giteaAssetConcurrency: workflow.giteaAssetConcurrency,
1564
- gitRemotePolicy: branch.gitRemotePolicy,
1565
- tsdocker,
1566
- ensurePublicationState: ensureState,
1567
- });
1707
+ const result = await publishReleaseWithRetention(
1708
+ {
1709
+ pnpmCapability,
1710
+ smartshell: shell,
1711
+ cwd: paths.cwd,
1712
+ store: context.store,
1713
+ journal: context.journal,
1714
+ pushUrl: branch.pushUrl,
1715
+ npmVerificationWindowMs: workflow.npmVerificationWindowMinutes * 60_000,
1716
+ giteaAssetTransfer: workflow.giteaAssetTransfer,
1717
+ giteaAssetConcurrency: workflow.giteaAssetConcurrency,
1718
+ gitRemotePolicy: branch.gitRemotePolicy,
1719
+ tsdocker,
1720
+ ensurePublicationState: ensureState,
1721
+ },
1722
+ workflow.recordRetention,
1723
+ );
1568
1724
  printReleaseJournalSummary(result);
1569
1725
  };
1570
1726
 
@@ -1639,6 +1795,37 @@ const runReleaseResume = async (
1639
1795
  const store = new ReleaseJournalStore(
1640
1796
  await resolveGitCommonDirectory(smartshellInstance, paths.cwd),
1641
1797
  );
1798
+ return store.withReleaseRecord(version, () =>
1799
+ runReleaseResumeFromStore({
1800
+ argv: argvArg,
1801
+ mode: modeArg,
1802
+ smartshell: smartshellInstance,
1803
+ store,
1804
+ version,
1805
+ detach,
1806
+ recoveryAttemptId,
1807
+ }),
1808
+ );
1809
+ };
1810
+
1811
+ const runReleaseResumeFromStore = async (optionsArg: {
1812
+ argv: any;
1813
+ mode: ICliMode;
1814
+ smartshell: plugins.smartshell.Smartshell;
1815
+ store: ReleaseJournalStore;
1816
+ version: string;
1817
+ detach: boolean;
1818
+ recoveryAttemptId?: string;
1819
+ }): Promise<void> => {
1820
+ const {
1821
+ argv: argvArg,
1822
+ mode: modeArg,
1823
+ smartshell: smartshellInstance,
1824
+ store,
1825
+ version,
1826
+ detach,
1827
+ recoveryAttemptId,
1828
+ } = optionsArg;
1642
1829
  const detachedRuns = await openDetachedReleaseRuns(paths.cwd);
1643
1830
  await detachedRuns.assertNoForeignRun();
1644
1831
  if (detach) {
@@ -1669,6 +1856,10 @@ const runReleaseResume = async (
1669
1856
  await prepareRecordedRelease(smartshellInstance, intent);
1670
1857
  }
1671
1858
  const journal = await store.read(version);
1859
+ if (journal.completedAt !== null && (await store.isPayloadMissing(journal)))
1860
+ throw new Error(
1861
+ `Release v${version} is complete and record retention removed its local artifacts; there is nothing left to resume. \`gitzone release inspect ${version}\` shows its journal.`,
1862
+ );
1672
1863
  const gitEnabled = journal.git.state !== "skipped";
1673
1864
  const resumeConfiguration = await resolveReleaseResumeConfiguration({
1674
1865
  git: gitEnabled,
@@ -1818,6 +2009,11 @@ const runReleaseResume = async (
1818
2009
  tsdocker,
1819
2010
  ensurePublicationState,
1820
2011
  });
2012
+ await pruneCompletedReleaseRecords(
2013
+ store,
2014
+ finalJournal,
2015
+ resumeConfiguration.recordRetention,
2016
+ );
1821
2017
  await cleanTestArtifactsForCompletedRelease(
1822
2018
  smartshellInstance,
1823
2019
  paths.cwd,
@@ -2531,6 +2727,9 @@ async function printReleasePlan(
2531
2727
  console.log("gitzone release - resolved workflow");
2532
2728
  console.log(`confirmation: ${workflow.confirmation}`);
2533
2729
  console.log(`plan: ${workflow.plan.join(" -> ")}`);
2730
+ console.log(
2731
+ `record retention: newest ${workflow.recordRetention} completed records (incomplete and active records are retained)`,
2732
+ );
2534
2733
  console.log(`source branch: ${branchContextArg.sourceBranch}`);
2535
2734
  if (workflow.prerelease)
2536
2735
  console.log(
@@ -2636,7 +2835,7 @@ export function showHelp(mode?: ICliMode): void {
2636
2835
  printJson({
2637
2836
  command: "release",
2638
2837
  usage:
2639
- "gitzone release [inspect [version]|resume <version>|recover <version>] [options]",
2838
+ "gitzone release [inspect [version]|resume <version>|recover <version>|prune] [options]",
2640
2839
  description:
2641
2840
  "Creates a versioned release from pending changelog entries and publishes configured artifacts.",
2642
2841
  flags: [
@@ -2696,6 +2895,11 @@ export function showHelp(mode?: ICliMode): void {
2696
2895
  description:
2697
2896
  "Recover a local npm and/or Docker release tag created without a recorded intent after build or pack failure before journal creation",
2698
2897
  },
2898
+ {
2899
+ flag: "prune [--apply] [--keep <n>]",
2900
+ description:
2901
+ "Report, and with --apply delete, the npm tarballs and Gitea assets of completed release records beyond the newest release.recordRetention (or --keep); journals, incomplete and in-use records stay",
2902
+ },
2699
2903
  {
2700
2904
  flag: "--recover-attempt <id>",
2701
2905
  description:
@@ -2713,7 +2917,7 @@ export function showHelp(mode?: ICliMode): void {
2713
2917
 
2714
2918
  console.log("");
2715
2919
  console.log(
2716
- "Usage: gitzone release [inspect [version]|resume <version>|recover <version>] [options]",
2920
+ "Usage: gitzone release [inspect [version]|resume <version>|recover <version>|prune] [options]",
2717
2921
  );
2718
2922
  console.log("");
2719
2923
  console.log("Creates a versioned release from changelog Pending entries.");
@@ -2754,6 +2958,9 @@ export function showHelp(mode?: ICliMode): void {
2754
2958
  console.log(
2755
2959
  " recover <version> Recover an unpublished npm and/or Docker release tag created without a recorded intent",
2756
2960
  );
2961
+ console.log(
2962
+ " prune Report payloads of completed records beyond release.recordRetention; --apply deletes them, --keep <n> overrides the count",
2963
+ );
2757
2964
  console.log(
2758
2965
  " --recover-attempt Recover one exact 32-character hexadecimal attempt ID after proving its publisher stopped",
2759
2966
  );