@git.zone/cli 6.8.0 → 6.10.0

package/ts/mod_release/index.ts

@@ -12,6 +12,7 @@ import {
   resolveReleaseDockerConfiguration,
   resolveReleaseWorkflow,
   resolveReleaseResumeConfiguration,
+  assertGiteaAssetsGitDestination,
   type IResolvedReleaseResumeConfiguration,
   type IResolvedReleaseWorkflow,
 } from "../helpers.workflow.js";
@@ -35,6 +36,7 @@ import {
   normalizeReleaseVersion,
   resolveGitCommonDirectory,
   getReleaseArtifacts,
+  hasReleasePackages,
   releasePackageArtifactFile,
   type IReleasePackage,
   type IReleaseArtifact,
@@ -42,6 +44,10 @@ import {
   type IReleaseJournalV1,
   type IReleaseJournalV2,
 } from "./classes.releasejournal.js";
+import {
+  GiteaAssetsClient,
+  prepareGiteaAssets,
+} from "./helpers.giteaassets.js";
 import {
   assertNoLegacyNpmPublisher,
   assertPnpmReleaseCapability,
@@ -49,6 +55,7 @@ import {
   normalizeNpmRegistryUrl,
   packNpmArtifact,
   verifyStoredNpmArtifact,
+  type IPnpmReleaseCapability,
 } from "./helpers.npmartifact.js";
 import { executeReleasePublication } from "./helpers.releasepublication.js";
 import {
@@ -126,6 +133,11 @@ const runInternal = async (argvArg: any): Promise<void> => {
     mergeRequested,
     planMode: workflow.confirmation === "plan",
   });
+  if (workflow.giteaAssets)
+    assertGiteaAssetsGitDestination(
+      workflow.giteaAssets,
+      branchContext.pushUrl || "",
+    );
   printReleasePlan(workflow, branchContext);
   if (
     workflow.targets.includes("npm") &&
@@ -143,7 +155,7 @@ const runInternal = async (argvArg: any): Promise<void> => {
   const preflightTsdocker = workflow.targets.includes("docker")
     ? new TsdockerReleaseClient(smartshellInstance, branchContext.sourceCwd)
     : undefined;
-  await assertFreshReleaseCapabilities(
+  const pnpmCapability = await assertFreshReleaseCapabilities(
     smartshellInstance,
     workflow,
     branchContext.sourceCwd,
@@ -171,6 +183,20 @@ const runInternal = async (argvArg: any): Promise<void> => {
     currentVersion,
     versionType,
   );
+  if (workflow.giteaAssets) {
+    const { tokenEnv, manifestPath, ...destination } = workflow.giteaAssets;
+    const token = process.env[tokenEnv];
+    if (!token)
+      throw new Error(
+        `Gitea assets require the configured credential in ${tokenEnv}.`,
+      );
+    await new GiteaAssetsClient({
+      destination,
+      tag: `v${plannedVersion}`,
+      commit: branchContext.sourceOid,
+      token,
+    }).preflight();
+  }
   if (preflightTsdocker) {
     await preflightTsdocker.validate(
       createDockerQualificationRequest(
@@ -293,6 +319,7 @@ const runInternal = async (argvArg: any): Promise<void> => {
       )
     : undefined;
   const journalContext = await createReleaseJournal({
+    pnpmCapability,
     smartshell: smartshellInstance,
     workflow,
     releaseCwd,
@@ -305,6 +332,7 @@ const runInternal = async (argvArg: any): Promise<void> => {
     ensurePublicationState,
   });
   const finalJournal = await executeReleasePublication({
+    pnpmCapability,
     smartshell: smartshellInstance,
     cwd: releaseCwd,
     store: journalContext.store,
@@ -322,7 +350,7 @@ const assertFreshReleaseCapabilities = async (
   cwdArg: string,
   pushUrlArg?: string,
   tsdockerArg?: ITsdockerReleaseClient,
-): Promise<void> => {
+): Promise<IPnpmReleaseCapability | undefined> => {
   if (workflowArg.targets.includes("docker")) {
     if (!tsdockerArg) {
       throw new Error("Docker release target requires project-local tSDocker.");
@@ -341,7 +369,7 @@ const assertFreshReleaseCapabilities = async (
     await assertNoLegacyNpmPublisher(cwdArg);
   }
   if (workflowArg.targets.includes("npm")) {
-    await assertPnpmReleaseCapability(smartshellArg, cwdArg);
+    return assertPnpmReleaseCapability(smartshellArg, cwdArg);
   }
 };
 
@@ -349,6 +377,18 @@ const assertReleaseConfiguration = (
   workflowArg: IResolvedReleaseWorkflow,
   mergeRequestedArg: boolean,
 ): void => {
+  if (
+    workflowArg.targets.includes("giteaAssets") &&
+    (!workflowArg.giteaAssets ||
+      !workflowArg.targets.includes("git") ||
+      !workflowArg.pushBranch ||
+      !workflowArg.pushTags ||
+      workflowArg.targets.includes("docker") ||
+      mergeRequestedArg)
+  )
+    throw new Error(
+      "Gitea asset releases require integrated main and Git branch/tag publication without Docker.",
+    );
   if (workflowArg.targets.includes("docker")) {
     if (mergeRequestedArg) {
       throw new Error(
@@ -408,6 +448,7 @@ const assertReleaseConfiguration = (
 };
 
 interface ICreateReleaseJournalOptions {
+  pnpmCapability?: IPnpmReleaseCapability;
   smartshell: plugins.smartshell.Smartshell;
   workflow: IResolvedReleaseWorkflow;
   releaseCwd: string;
@@ -509,6 +550,7 @@ export const createReleaseJournal = async (
             module.directory,
             temporaryDirectory,
             optionsArg.version,
+            optionsArg.pnpmCapability,
             releasePackageArtifactFile(module.name),
           );
           if (packed.packageName !== module.name)
@@ -524,6 +566,7 @@ export const createReleaseJournal = async (
           npmSourceCwd,
           temporaryDirectory,
           optionsArg.version,
+          optionsArg.pnpmCapability,
         );
       }
       await verifyCleanTree(
@@ -543,10 +586,47 @@ export const createReleaseJournal = async (
     }
     const now = new Date().toISOString();
     const gitStatus = createInitialTargetStatus(gitEnabled);
+    const assetConfiguration = optionsArg.workflow.giteaAssets;
+    let giteaAssets:
+      | import("./classes.releasejournal.js").IReleaseGiteaAssetsJournal
+      | undefined;
+    if (optionsArg.workflow.targets.includes("giteaAssets")) {
+      if (!assetConfiguration || !gitEnabled || optionsArg.dockerRequest)
+        throw new Error("Invalid Gitea asset target combination.");
+      assertGiteaAssetsGitDestination(
+        assetConfiguration,
+        optionsArg.releasePushUrl!,
+      );
+      const { tokenEnv, manifestPath, ...destination } = assetConfiguration;
+      const assets = await prepareGiteaAssets({
+        repositoryRoot: npmSourceCwd,
+        manifestPath,
+        version: optionsArg.version,
+        tag: `v${optionsArg.version}`,
+        artifactDirectory: temporaryDirectory,
+        destination,
+      });
+      giteaAssets = {
+        destination,
+        tokenEnv,
+        manifestPath,
+        release: { ...createInitialTargetStatus(true), id: null },
+        assets: assets.map((asset) => ({
+          ...createInitialTargetStatus(true),
+          asset,
+        })),
+      };
+    }
     const journal = finalizeJournalCompletion(
       {
         kind: "gitzone-release-journal",
-        schemaVersion: packages.length ? 3 : optionsArg.dockerRequest ? 2 : 1,
+        schemaVersion: giteaAssets
+          ? 4
+          : packages.length
+            ? 3
+            : optionsArg.dockerRequest
+              ? 2
+              : 1,
         revision: 1,
         release: {
           version: optionsArg.version,
@@ -555,7 +635,7 @@ export const createReleaseJournal = async (
           tagOid: optionsArg.refs.tagOid,
         },
         artifact,
-        ...(packages.length ? { packages } : {}),
+        ...(packages.length || giteaAssets ? { packages } : {}),
         git: {
           state: gitStatus.state,
           attempts: gitStatus.attempts,
@@ -596,6 +676,7 @@ export const createReleaseJournal = async (
                 })
               : [],
         },
+        ...(giteaAssets ? { giteaAssets } : {}),
         ...(optionsArg.dockerRequest
           ? {
               docker: createInitialReleaseDockerJournal(
@@ -745,7 +826,7 @@ const runReleaseRecover = async (
     `Recover existing ${packageName}@${version}\ncommit: ${refs.mainOid}\ntag object: ${refs.tagOid}\nGit destination: ${branch.gitRemote}\nnpm registries: ${workflow.npmRegistries.join(", ")}\nBuild and pack an isolated checkout, install its journal, then publish configured targets.`,
   );
   if (argvArg.plan) return;
-  await assertFreshReleaseCapabilities(
+  const pnpmCapability = await assertFreshReleaseCapabilities(
     shell,
     workflow,
     paths.cwd,
@@ -784,6 +865,7 @@ const runReleaseRecover = async (
     ensureUnpublished,
     async (checkout, ensureCheckout) =>
       createReleaseJournal({
+        pnpmCapability,
         smartshell: shell,
         workflow,
         releaseCwd: paths.cwd,
@@ -799,6 +881,7 @@ const runReleaseRecover = async (
       }),
   );
   const result = await executeReleasePublication({
+    pnpmCapability,
     smartshell: shell,
     cwd: paths.cwd,
     store: context.store,
@@ -879,6 +962,7 @@ const runReleaseResume = async (
   const resumeConfiguration = await resolveReleaseResumeConfiguration({
     git: gitEnabled,
     npm: journal.npm.registries.length > 0,
+    giteaAssets: journal.schemaVersion === 4,
   });
   await assertResumeConfiguration(resumeConfiguration, journal, paths.cwd);
   let tsdocker: ITsdockerReleaseClient | undefined;
@@ -913,8 +997,12 @@ const runReleaseResume = async (
     await tsdocker.assertCapabilities();
     await tsdocker.validate(journal.docker.request);
   }
+  let pnpmCapability: IPnpmReleaseCapability | undefined;
   if (getReleaseArtifacts(journal).length) {
-    await assertPnpmReleaseCapability(smartshellInstance, paths.cwd);
+    pnpmCapability = await assertPnpmReleaseCapability(
+      smartshellInstance,
+      paths.cwd,
+    );
     await assertNoLegacyNpmPublisher(paths.cwd);
     for (const artifact of getReleaseArtifacts(journal)) {
       await verifyStoredNpmArtifact(
@@ -984,6 +1072,7 @@ const runReleaseResume = async (
     );
   };
   const finalJournal = await executeReleasePublication({
+    pnpmCapability,
     smartshell: smartshellInstance,
     cwd: paths.cwd,
     store,
@@ -1020,13 +1109,24 @@ const assertResumeConfiguration = async (
       ]) ||
       workflowArg.npmAccessLevel !== journalArg.npm.access ||
       workflowArg.npmPackageSource !==
-        (journalArg.schemaVersion === 3 ? "tspublish" : "root") ||
+        (hasReleasePackages(journalArg) ? "tspublish" : "root") ||
       workflowArg.npmAlreadyPublished !== journalArg.npm.alreadyPublished)
   ) {
     throw new Error(
       "Current npm release configuration does not match the journal.",
     );
   }
+  if (journalArg.schemaVersion === 4) {
+    const { destination, tokenEnv, manifestPath } = journalArg.giteaAssets;
+    if (
+      JSON.stringify(workflowArg.giteaAssets) !==
+      JSON.stringify({ ...destination, tokenEnv, manifestPath })
+    ) {
+      throw new Error(
+        "Current Gitea asset configuration does not match the journal.",
+      );
+    }
+  }
   if (
     journalArg.git.state !== "skipped" ||
     getReleaseArtifacts(journalArg).length
@@ -1048,12 +1148,19 @@ const printReleaseJournalSummary = (journalArg: TReleaseJournal): void => {
       `npm ${registry.packageName ? `${registry.packageName} ` : ""}${registry.registry}: ${registry.state}`,
     );
   }
-  if (journalArg.schemaVersion === 3) {
+  if (hasReleasePackages(journalArg)) {
     for (const { artifact } of journalArg.packages)
       console.log(
         `artifact ${artifact.packageName}: ${artifact.integrity} (${artifact.sha256})`,
       );
   }
+  if (journalArg.schemaVersion === 4) {
+    console.log(`Gitea release: ${journalArg.giteaAssets.release.state}`);
+    for (const entry of journalArg.giteaAssets.assets)
+      console.log(
+        `asset ${entry.asset.name}: ${entry.state} (${entry.asset.sha256})`,
+      );
+  }
   if (journalArg.schemaVersion === 2) {
     console.log(
       `docker qualification ${journalArg.docker.request.candidateId}: ${journalArg.docker.qualification.state}`,
@@ -1403,6 +1510,14 @@ function printReleasePlan(
       `npm registries: ${workflow.npmRegistries.length > 0 ? workflow.npmRegistries.join(", ") : "none"}`,
     );
   }
+  if (workflow.giteaAssets) {
+    const assets = workflow.giteaAssets;
+    console.log(
+      `Gitea assets: ${assets.apiOrigin}/${assets.owner}/${assets.repository}`,
+    );
+    console.log(`asset manifest: ${assets.manifestPath}`);
+    console.log(`asset credential variable: ${assets.tokenEnv}`);
+  }
   if (workflow.targets.includes("docker")) {
     console.log(`docker engine: ${workflow.dockerEngine}`);
     console.log(
@@ -1466,7 +1581,7 @@ export function showHelp(mode?: ICliMode): void {
         {
           flag: "--target <names>",
           description:
-            "Replace configured targets with a non-empty subset of git,npm,docker",
+            "Replace configured targets with a non-empty subset of git,giteaAssets,npm,docker",
         },
         { flag: "--npm", description: "Explicitly select the npm target" },
         {
@@ -1476,7 +1591,8 @@ export function showHelp(mode?: ICliMode): void {
         },
         {
           flag: "--no-publish",
-          description: "Remove npm and Docker without implicitly enabling Git",
+          description:
+            "Remove Gitea assets, npm and Docker without implicitly enabling Git",
         },
         {
           flag: "--merge",
@@ -1529,14 +1645,14 @@ export function showHelp(mode?: ICliMode): void {
   console.log("  --no-build          Disable the post-metadata release build");
   console.log("  -p, --push          Explicitly select the git target");
   console.log(
-    "  --target <names>    Replace configured targets with a non-empty subset of git,npm,docker",
+    "  --target <names>    Replace configured targets with a non-empty subset of git,giteaAssets,npm,docker",
   );
   console.log("  --npm               Explicitly select the npm target");
   console.log(
     "  --docker            Select digest-qualified Docker publication through project-local tSDocker >= 3.5.1",
   );
   console.log(
-    "  --no-publish        Remove npm and Docker without implicitly enabling Git",
+    "  --no-publish        Remove Gitea assets, npm and Docker without implicitly enabling Git",
   );
   console.log(
     "  --merge             Fast-forward and lease-push a cleanly rebased feature branch before release metadata",

package/ts/mod_release/interfaces.giteaassets.ts

@@ -0,0 +1,67 @@
+export interface IGiteaAssetDestination {
+  apiOrigin: string;
+  owner: string;
+  repository: string;
+}
+
+export interface IGiteaFrozenAsset {
+  name: string;
+  size: number;
+  sha256: string;
+  fileName: string;
+  publicUrl: string;
+}
+
+export interface IPrepareGiteaAssetsOptions {
+  repositoryRoot: string;
+  manifestPath: string;
+  version: string;
+  tag: string;
+  artifactDirectory: string;
+  destination: IGiteaAssetDestination;
+}
+
+export interface IGiteaRelease {
+  id: number;
+  tag: string;
+  publicUrl: string;
+}
+
+export interface IGiteaAssetInspection {
+  present: IGiteaFrozenAsset[];
+  missing: IGiteaFrozenAsset[];
+}
+
+export interface IGiteaAssetsClientOptions {
+  destination: IGiteaAssetDestination;
+  tag: string;
+  commit: string;
+  token: string;
+  fetchImplementation?: typeof fetch;
+  timeoutMs?: number;
+}
+
+export interface IGiteaAssetPreflight {
+  repositoryId: number;
+  /** Issue-attachment setting; Gitea's release FILE_MAX_SIZE is separate. */
+  generalAttachmentMaximumBytes: number;
+}
+
+export interface IGiteaAssetsClient {
+  preflight(): Promise<IGiteaAssetPreflight>;
+  inspectRelease(): Promise<IGiteaRelease | null>;
+  createRelease(): Promise<IGiteaRelease>;
+  inspectAssets(
+    releaseId: number,
+    expected: IGiteaFrozenAsset[],
+  ): Promise<IGiteaAssetInspection>;
+  uploadAsset(
+    releaseId: number,
+    asset: IGiteaFrozenAsset,
+    artifactDirectory: string,
+  ): Promise<void>;
+  verifyComplete(
+    releaseId: number,
+    expected: IGiteaFrozenAsset[],
+  ): Promise<void>;
+}