@aidc-toolkit/dev 0.9.6-beta → 0.9.7-beta

package/config/release.json

@@ -2,24 +2,24 @@
   "organization": "aidc-toolkit",
   "repositories": {
     "dev": {
-      "version": "0.9.6-beta"
+      "version": "0.9.7-beta"
     },
     "core": {
-      "version": "0.9.6-beta"
+      "version": "0.9.7-beta"
     },
     "utility": {
-      "version": "0.9.6-beta"
+      "version": "0.9.7-beta"
     },
     "gs1": {
       "name": "gs1",
-      "version": "0.9.6-beta"
+      "version": "0.9.7-beta"
     },
     "demo": {
-      "version": "0.9.6-beta"
+      "version": "0.9.7-beta"
     },
     "aidc-toolkit.github.io": {
       "directory": "doc",
-      "version": "0.9.6-beta"
+      "version": "0.9.7-beta"
     }
   }
 }

package/copy-workflows.json

@@ -1,25 +1,5 @@
 {
   "copyFiles": [
-    {
-      "from": ".github/workflows/tag.yml",
-      "to": "../core/.github/workflows/"
-    },
-    {
-      "from": ".github/workflows/tag.yml",
-      "to": "../utility/.github/workflows/"
-    },
-    {
-      "from": ".github/workflows/tag.yml",
-      "to": "../gs1/.github/workflows/"
-    },
-    {
-      "from": ".github/workflows/tag.yml",
-      "to": "../demo/.github/workflows/"
-    },
-    {
-      "from": ".github/workflows/tag.yml",
-      "to": "../doc/.github/workflows/"
-    },
     {
       "from": ".github/workflows/release.yml",
       "to": "../core/.github/workflows/"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aidc-toolkit/dev",
-  "version": "0.9.6-beta",
+  "version": "0.9.7-beta",
   "description": "Shared development artefacts for AIDC Toolkit",
   "type": "module",
   "main": "dist/index.js",
@@ -33,18 +33,15 @@
     "tsx": "^4.19.2",
     "typescript": "^5.7.2"
   },
-  "peerDependencies": {
-    "eslint": ">=9"
-  },
   "dependencies": {
     "@eslint/js": "^9.16.0",
     "@octokit/types": "^13.6.2",
-    "@rollup/rollup-linux-x64-gnu": "^4.28.0",
-    "@stylistic/eslint-plugin": "^2.11.0",
-    "eslint-config-love": "^109.0.0",
+    "@rollup/rollup-linux-x64-gnu": "^4.28.1",
+    "@stylistic/eslint-plugin": "^2.12.0",
+    "eslint-config-love": "^110.0.0",
     "eslint-plugin-jsdoc": "^50.6.0",
     "octokit": "^4.0.2",
-    "typescript-eslint": "^8.16.0",
+    "typescript-eslint": "^8.17.0",
     "yaml": "^2.6.1"
   }
 }

package/src/release.ts

@@ -56,6 +56,11 @@ interface PackageConfiguration {
      */
     version: string;
 
+    /**
+     * If true, package is private and not linked by others.
+     */
+    private?: boolean;
+
     /**
      * Development dependencies.
      */
@@ -137,13 +142,18 @@ function run(captureOutput: boolean, command: string, ...args: string[]): string
     return captureOutput ? spawnResult.stdout.toString().split("\n").slice(0, -1) : [];
 }
 
+/**
+ * Supported states.
+ */
+type State = "skipped" | "install" | "build" | "link" | "commit" | "tag" | "push" | "workflow (push)" | "release" | "workflow (release)" | "complete";
+
 /**
  * Release.
  */
 async function release(): Promise<void> {
     const statePath = path.resolve("config/release.state.json");
 
-    let state: Record<string, string | undefined> = {};
+    let state: Record<string, State | undefined> = {};
 
     if (fs.existsSync(statePath)) {
         // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment -- Format is controlled by this process.
@@ -172,7 +182,7 @@ async function release(): Promise<void> {
      * @returns
      * Promise.
      */
-    async function step(name: string, stepState: string, callback: () => (void | Promise<void>)): Promise<void> {
+    async function step(name: string, stepState: State, callback: () => (void | Promise<void>)): Promise<void> {
         const repositoryState = state[name];
 
         if (repositoryState === undefined || repositoryState === stepState) {
@@ -187,7 +197,7 @@ async function release(): Promise<void> {
 
                 state[name] = undefined;
             } finally {
-                fs.writeFileSync(statePath, `${JSON.stringify(state, null, 2)}\n`);
+                saveState();
             }
         }
     }
@@ -197,6 +207,8 @@ async function release(): Promise<void> {
         userAgent: `${configuration.organization} release`
     });
 
+    let allSkipped = true;
+
     for (const name of Object.keys(configuration.repositories)) {
         const repository = configuration.repositories[name];
 
@@ -215,26 +227,6 @@ async function release(): Promise<void> {
             throw new Error("Repository has uncommitted changes");
         }
 
-        const workflowsPath = ".github/workflows/";
-
-        let hasPushWorkflow = false;
-        let hasReleaseWorkflow = false;
-
-        for (const workflowFile of fs.readdirSync(workflowsPath)) {
-            if (workflowFile.endsWith(".yml")) {
-                // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- Workflow configuration format is known.
-                const workflowOn = (yamlParse(fs.readFileSync(path.resolve(workflowsPath, workflowFile)).toString()) as WorkflowConfiguration).on;
-
-                if (workflowOn.push !== undefined && (workflowOn.push.branches === undefined || workflowOn.push.branches.includes("main"))) {
-                    hasPushWorkflow = true;
-                }
-
-                if (workflowOn.release !== undefined && (workflowOn.release.types === undefined || workflowOn.release.types.includes("published"))) {
-                    hasReleaseWorkflow = true;
-                }
-            }
-        }
-
         const tag = `v${repository.version}`;
 
         const octokitParameterBase = {
@@ -242,141 +234,219 @@ async function release(): Promise<void> {
             repo: name
         };
 
-        const commitSHA = run(true, "git", "rev-parse", "HEAD")[0];
+        const packageConfigurationPath = "package.json";
 
-        /**
-         * Validate the workflow by waiting for it to complete.
-         */
-        async function validateWorkflow(): Promise<void> {
-            while (!await new Promise<void>((resolve) => {
-                setTimeout(resolve, 2000);
-            }).then(async () => await octokit.rest.actions.listWorkflowRunsForRepo({
-                ...octokitParameterBase,
-                head_sha: commitSHA
-            })).then((response) => {
-                let workflowRunID = -1;
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment -- Package configuration format is known.
+        const packageConfiguration: PackageConfiguration = JSON.parse(fs.readFileSync(packageConfigurationPath).toString());
 
-                let queryCount = 0;
-                let completed = false;
+        let skipRepository: boolean;
 
-                for (const workflowRun of response.data.workflow_runs) {
-                    if (workflowRun.status !== "completed") {
-                        if (workflowRun.id === workflowRunID) {
-                            process.stdout.write(".");
-                        } else if (workflowRunID === -1) {
-                            workflowRunID = workflowRun.id;
+        switch (state[name]) {
+            case undefined:
+                // No steps have yet been taken; skip if repository is already at the required version.
+                skipRepository = packageConfiguration.version === repository.version;
 
-                            console.log(`Workflow run ID ${workflowRunID}`);
-                        } else {
-                            throw new Error(`Parallel workflow runs for SHA ${commitSHA}`);
-                        }
-                    } else if (workflowRun.id === workflowRunID) {
-                        process.stdout.write("\n");
+                if (!skipRepository) {
+                    allSkipped = false;
+
+                    packageConfiguration.version = repository.version;
+
+                    const atOrganization = `@${configuration.organization}`;
+
+                    /**
+                     * Update dependencies from the organization.
+                     *
+                     * @param dependencies
+                     * Dependencies.
+                     *
+                     * @returns
+                     * List of dependencies that require linking.
+                     */
+                    function updateDependencies(dependencies: Record<string, string> | undefined): string[] {
+                        const linkDependencies = new Array<string>();
 
-                        if (workflowRun.conclusion !== "success") {
-                            throw new Error(`Workflow ${workflowRun.conclusion}`);
+                        if (dependencies !== undefined) {
+                            // eslint-disable-next-line guard-for-in -- Dependency record type is shallow.
+                            for (const dependency in dependencies) {
+                                const [dependencyAtOrganization, dependencyRepositoryName] = dependency.split("/");
+
+                                if (dependencyAtOrganization === atOrganization) {
+                                    dependencies[dependency] = `^${configuration.repositories[dependencyRepositoryName].version}`;
+
+                                    linkDependencies.push(dependency);
+                                }
+                            }
                         }
 
-                        completed = true;
+                        return linkDependencies;
                     }
-                }
 
-                // Abort if workflow run not started after 10 queries.
-                if (++queryCount === 10 && workflowRunID === -1) {
-                    throw new Error(`Workflow run not started for SHA ${commitSHA}`);
+                    const linkDependencies = updateDependencies(packageConfiguration.devDependencies);
+                    linkDependencies.push(...updateDependencies(packageConfiguration.dependencies));
+
+                    fs.writeFileSync(packageConfigurationPath, `${JSON.stringify(packageConfiguration, null, 2)}\n`);
+
+                    for (const dependency of linkDependencies) {
+                        run(false, "npm", "link", dependency);
+                    }
+                } else if (!allSkipped) {
+                    throw new Error(`Repository ${name} is supposed to be skipped but at least one prior repository has been updated`);
                 }
+                break;
 
-                return completed;
-            })) {
-                // Execution within conditional.
-            }
+            case "skipped":
+                // Repository was skipped on the prior run.
+                skipRepository = true;
+                break;
+
+            case "complete":
+                // Repository was fully updated on the prior run.
+                skipRepository = true;
+
+                allSkipped = false;
+                break;
+
+            default:
+                // Repository failed at some step on the prior run.
+                skipRepository = false;
+
+                allSkipped = false;
+                break;
         }
 
-        const packageConfigurationPath = "package.json";
+        if (!skipRepository) {
+            const workflowsPath = ".github/workflows/";
 
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment -- Package configuration format is known.
-        const packageConfiguration: PackageConfiguration = JSON.parse(fs.readFileSync(packageConfigurationPath).toString());
+            let hasPushWorkflow = false;
+            let hasReleaseWorkflow = false;
 
-        const skipRepository = state[name] === undefined && packageConfiguration.version === repository.version;
+            if (fs.existsSync(workflowsPath)) {
+                for (const workflowFile of fs.readdirSync(workflowsPath)) {
+                    if (workflowFile.endsWith(".yml")) {
+                        // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- Workflow configuration format is known.
+                        const workflowOn = (yamlParse(fs.readFileSync(path.resolve(workflowsPath, workflowFile)).toString()) as WorkflowConfiguration).on;
 
-        if (packageConfiguration.version !== repository.version) {
-            packageConfiguration.version = repository.version;
+                        if (workflowOn.push !== undefined && (workflowOn.push.branches === undefined || workflowOn.push.branches.includes("main"))) {
+                            hasPushWorkflow = true;
+                        }
 
-            const atOrganization = `@${configuration.organization}/`;
+                        if (workflowOn.release !== undefined && (workflowOn.release.types === undefined || workflowOn.release.types.includes("published"))) {
+                            hasReleaseWorkflow = true;
+                        }
+                    }
+                }
+            }
 
             /**
-             * Update dependencies from the organization.
-             *
-             * @param dependencies
-             * Dependencies.
+             * Validate the workflow by waiting for it to complete.
              */
-            function updateDependencies(dependencies: Record<string, string> | undefined): void {
-                if (dependencies !== undefined) {
-                    for (const dependency in dependencies) {
-                        const [dependencyAtOrganization, dependencyRepositoryName] = dependency.split("/");
+            async function validateWorkflow(): Promise<void> {
+                const commitSHA = run(true, "git", "rev-parse", "HEAD")[0];
+
+                let completed = false;
+                let queryCount = 0;
+                let workflowRunID = -1;
+
+                do {
+                    await new Promise<void>((resolve) => {
+                        setTimeout(resolve, 2000);
+                    });
+
+                    const response = await octokit.rest.actions.listWorkflowRunsForRepo({
+                        ...octokitParameterBase,
+                        head_sha: commitSHA
+                    });
 
-                        if (dependencyAtOrganization === atOrganization) {
-                            dependencies[dependency] = `^${configuration.repositories[dependencyRepositoryName].version}`;
+                    for (const workflowRun of response.data.workflow_runs) {
+                        if (workflowRun.status !== "completed") {
+                            if (workflowRun.id === workflowRunID) {
+                                process.stdout.write(".");
+                            } else if (workflowRunID === -1) {
+                                workflowRunID = workflowRun.id;
+
+                                console.log(`Workflow run ID ${workflowRunID}`);
+                            } else {
+                                throw new Error(`Parallel workflow runs for SHA ${commitSHA}`);
+                            }
+                        } else if (workflowRun.id === workflowRunID) {
+                            process.stdout.write("\n");
+
+                            if (workflowRun.conclusion !== "success") {
+                                throw new Error(`Workflow ${workflowRun.conclusion}`);
+                            }
+
+                            completed = true;
                         }
                     }
-                }
+
+                    // Abort if workflow run not started after 10 queries.
+                    if (++queryCount === 10 && workflowRunID === -1) {
+                        throw new Error(`Workflow run not started for SHA ${commitSHA}`);
+                    }
+                } while (!completed);
             }
 
-            updateDependencies(packageConfiguration.devDependencies);
-            updateDependencies(packageConfiguration.dependencies);
+            await step(name, "install", () => {
+                run(false, "npm", "install");
+            });
 
-            fs.writeFileSync(packageConfigurationPath, `${JSON.stringify(packageConfiguration, null, 2)}\n`);
-        }
+            await step(name, "build", () => {
+                run(false, "npm", "run", "build", "--if-present");
+            });
 
-        if (!skipRepository) {
-            await step(name, "npm install", () => {
-                run(false, "npm", "install");
-            }).then(async () => {
-                await step(name, "git commit", () => {
-                    run(false, "git", "commit", "--all", `--message=Updated to version ${repository.version}`);
+            if (!(packageConfiguration.private ?? false)) {
+                await step(name, "link", () => {
+                    run(false, "npm", "link");
                 });
-            }).then(async () => {
-                await step(name, "git tag", () => {
-                    run(false, "git", "tag", tag);
-                });
-            }).then(async () => {
-                await step(name, "git push", () => {
-                    run(false, "git", "push", "--atomic", "origin", "main", tag);
-                });
-            }).then(async () => {
-                await step(name, "push workflow", async () => {
-                    if (hasPushWorkflow) {
-                        await validateWorkflow();
-                    }
-                });
-            }).then(async () => {
-                await step(name, "release", async () => {
-                    const versionSplit = repository.version.split("-");
-                    const prerelease = versionSplit.length !== 1;
+            }
 
-                    await octokit.rest.repos.createRelease({
-                        ...octokitParameterBase,
-                        tag_name: tag,
-                        name: `${prerelease ? `${versionSplit[1].substring(0, 1).toUpperCase()}${versionSplit[1].substring(1)} r` : "R"}elease ${versionSplit[0]}`,
-                        // TODO Remove "false" override.
-                        prerelease: false
-                    });
+            await step(name, "commit", () => {
+                run(false, "git", "commit", "--all", `--message=Updated to version ${repository.version}`);
+            });
+
+            await step(name, "tag", () => {
+                run(false, "git", "tag", tag);
+            });
+
+            await step(name, "push", () => {
+                run(false, "git", "push", "--atomic", "origin", "main", tag);
+            });
+
+            if (hasPushWorkflow) {
+                await step(name, "workflow (push)", async () => {
+                    await validateWorkflow();
                 });
-            }).then(async () => {
-                await step(name, "release workflow", async () => {
-                    if (hasReleaseWorkflow) {
-                        await validateWorkflow();
-                    }
+            }
+
+            await step(name, "release", async () => {
+                const versionSplit = repository.version.split("-");
+                const prerelease = versionSplit.length !== 1;
+
+                await octokit.rest.repos.createRelease({
+                    ...octokitParameterBase,
+                    tag_name: tag,
+                    name: `${prerelease ? `${versionSplit[1].substring(0, 1).toUpperCase()}${versionSplit[1].substring(1)} r` : "R"}elease ${versionSplit[0]}`,
+                    // TODO Remove "false" override.
+                    prerelease: false
                 });
             });
 
+            if (hasReleaseWorkflow) {
+                await step(name, "workflow (release)", async () => {
+                    await validateWorkflow();
+                });
+            }
+
             state[name] = "complete";
-            saveState();
+        } else {
+            state[name] = "skipped";
         }
+
+        saveState();
     }
 
-    state = {};
-    saveState();
+    // All repositories released.
+    fs.rmSync(statePath);
 }
 
 await release().catch((e: unknown) => {