@aidc-toolkit/dev 0.9.16-beta → 0.9.17-beta

package/src/release.ts

@@ -1,428 +0,0 @@
-/* eslint-disable no-console -- Console application. */
-
-import * as fs from "fs";
-import * as path from "node:path";
-import * as util from "node:util";
-import { Octokit } from "octokit";
-import { parse as yamlParse } from "yaml";
-
-import configurationJSON from "../config/release.json";
-import secureConfigurationJSON from "../config/release.secure.json";
-import { run } from "./command-util.js";
-
-/**
- * Configuration layout of release.json.
- */
-interface Configuration {
-    /**
-     * Organization that owns the repositories.
-     */
-    organization: string;
-
-    /**
-     * If true, the fact that the repository is uncommitted is ignored. For development and testing purposes only.
-     */
-    ignoreUncommitted?: boolean;
-
-    /**
-     * Repositories.
-     */
-    repositories: Record<string, {
-        /**
-         * Directory in which repository resides, if different from repository name.
-         */
-        directory?: string;
-
-        /**
-         * Version for repository. Not all repositories will be in sync with the version.
-         */
-        version: string;
-    }>;
-}
-
-/**
- * Configuration layout of release.secure.json.
- */
-interface SecureConfiguration {
-    token: string;
-}
-
-const configuration: Configuration = configurationJSON;
-const secureConfiguration: SecureConfiguration = secureConfigurationJSON;
-
-/**
- * Configuration layout of package.json (relevant attributes only).
- */
-interface PackageConfiguration {
-    /**
-     * Version.
-     */
-    version: string;
-
-    /**
-     * If true, package is private and not referenced by others.
-     */
-    private?: boolean;
-
-    /**
-     * Development dependencies.
-     */
-    devDependencies?: Record<string, string>;
-
-    /**
-     * Dependencies.
-     */
-    dependencies?: Record<string, string>;
-}
-
-/**
- * Configuration layout of release.yml workflow (relevant attributes only).
- */
-interface WorkflowConfiguration {
-    /**
-     * Workflow name.
-     */
-    name: string;
-
-    /**
-     * Workflow trigger.
-     */
-    on: {
-        /**
-         * Push trigger.
-         */
-        push?: {
-            /**
-             * Push branches.
-             */
-            branches?: string[];
-        };
-
-        /**
-         * Release trigger.
-         */
-        release?: {
-            /**
-             * Release types.
-             */
-            types?: string[];
-        };
-    };
-}
-
-/**
- * Supported states.
- */
-type State = "skipped" | "install" | "build" | "commit" | "tag" | "push" | "workflow (push)" | "release" | "workflow (release)" | "restore alpha" | "complete";
-
-/**
- * Release.
- */
-async function release(): Promise<void> {
-    // State may be written from any directory so full path is required.
-    const statePath = path.resolve("config/release.state.json");
-
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment -- Format is controlled by this process.
-    const state: Record<string, State | undefined> = fs.existsSync(statePath) ? JSON.parse(fs.readFileSync(statePath).toString()) : {};
-
-    /**
-     * Save the current state.
-     */
-    function saveState(): void {
-        fs.writeFileSync(statePath, `${JSON.stringify(state, null, 2)}\n`);
-    }
-
-    /**
-     * Execute a step.
-     *
-     * @param name
-     * Repository name.
-     *
-     * @param stepState
-     * State at which step takes place.
-     *
-     * @param callback
-     * Callback to execute step.
-     *
-     * @returns
-     * Promise.
-     */
-    async function step(name: string, stepState: State, callback: () => (void | Promise<void>)): Promise<void> {
-        const repositoryState = state[name];
-
-        if (repositoryState === undefined || repositoryState === stepState) {
-            state[name] = stepState;
-
-            try {
-                const result = callback();
-
-                if (result instanceof Promise) {
-                    await result;
-                }
-
-                state[name] = undefined;
-            } finally {
-                saveState();
-            }
-        }
-    }
-
-    const atOrganization = `@${configuration.organization}`;
-
-    /**
-     * Update dependencies from the organization.
-     *
-     * @param dependencies
-     * Dependencies.
-     *
-     * @param restoreAlpha
-     * If true, "alpha" is restored as the version for development.
-     *
-     * @returns
-     * True if any dependencies were updated.
-     */
-    function updateDependencies(dependencies: Record<string, string> | undefined, restoreAlpha: boolean): boolean {
-        let anyUpdated = false;
-
-        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] = !restoreAlpha ? `^${configuration.repositories[dependencyRepositoryName].version}` : "alpha";
-                    anyUpdated = true;
-                }
-            }
-        }
-
-        return anyUpdated;
-    }
-
-    const octokit = new Octokit({
-        auth: secureConfiguration.token,
-        userAgent: `${configuration.organization} release`
-    });
-
-    let allSkipped = true;
-    let firstRepository = true;
-
-    for (const name of Object.keys(configuration.repositories)) {
-        const repository = configuration.repositories[name];
-
-        console.log(`Repository ${name}...`);
-
-        // All repositories are expected to be children of the parent of this repository.
-        process.chdir(`../${repository.directory ?? name}`);
-
-        // Repository must be on main branch.
-        if (run(true, "git", "branch", "--show-current")[0] !== "main") {
-            throw new Error("Repository is not on main branch");
-        }
-
-        // Repository must be fully committed except for untracked files.
-        if (!(configuration.ignoreUncommitted ?? false) && state[name] === undefined && run(true, "git", "status", "--short", "--untracked-files=no").length !== 0) {
-            throw new Error("Repository has uncommitted changes");
-        }
-
-        const tag = `v${repository.version}`;
-
-        const octokitParameterBase = {
-            owner: configuration.organization,
-            repo: name
-        };
-
-        const packageConfigurationPath = "package.json";
-
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment -- Package configuration format is known.
-        const packageConfiguration: PackageConfiguration = JSON.parse(fs.readFileSync(packageConfigurationPath).toString());
-
-        let skipRepository: boolean;
-
-        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;
-
-                if (!skipRepository) {
-                    allSkipped = false;
-
-                    packageConfiguration.version = repository.version;
-
-                    updateDependencies(packageConfiguration.devDependencies, false);
-                    updateDependencies(packageConfiguration.dependencies, false);
-
-                    fs.writeFileSync(packageConfigurationPath, `${JSON.stringify(packageConfiguration, null, 2)}\n`);
-                } else {
-                    if (!allSkipped) {
-                        throw new Error(`Repository ${name} is supposed to be skipped but at least one prior repository has been updated`);
-                    }
-
-                    // First repository is excluded as it hosts development artefacts only, including the configuration file for this process.
-                    if (!firstRepository && run(true, "git", "tag", "--points-at", "HEAD", tag).length === 0) {
-                        throw new Error(`Repository ${name} has at least one commit since version ${repository.version}`);
-                    }
-
-                    state[name] = "skipped";
-                }
-                break;
-
-            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;
-        }
-
-        if (!skipRepository) {
-            const workflowsPath = ".github/workflows/";
-
-            let hasPushWorkflow = false;
-            let hasReleaseWorkflow = false;
-
-            if (fs.existsSync(workflowsPath)) {
-                for (const workflowFile of fs.readdirSync(workflowsPath).filter(workflowFile => 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;
-                    }
-                }
-            }
-
-            /**
-             * Validate the workflow by waiting for it to complete.
-             */
-            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 util.promisify(setTimeout)(2000);
-
-                    const response = await octokit.rest.actions.listWorkflowRunsForRepo({
-                        ...octokitParameterBase,
-                        head_sha: commitSHA
-                    });
-
-                    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);
-            }
-
-            await step(name, "install", () => {
-                run(false, "npm", "install");
-            });
-
-            await step(name, "build", () => {
-                run(false, "npm", "run", "build", "--if-present");
-            });
-
-            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();
-                });
-            }
-
-            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();
-                });
-            }
-
-            await step(name, "restore alpha", () => {
-                // Restore dependencies to "alpha" version for development.
-                const devDependenciesUpdated = updateDependencies(packageConfiguration.devDependencies, true);
-                const dependenciesUpdated = updateDependencies(packageConfiguration.dependencies, true);
-
-                if (devDependenciesUpdated || dependenciesUpdated) {
-                    fs.writeFileSync(packageConfigurationPath, `${JSON.stringify(packageConfiguration, null, 2)}\n`);
-                    run(false, "git", "commit", "--all", "--message=Restored alpha version.");
-                }
-            });
-
-            state[name] = "complete";
-        }
-
-        saveState();
-
-        firstRepository = false;
-    }
-
-    // All repositories released.
-    fs.rmSync(statePath);
-}
-
-await release().catch((e: unknown) => {
-    console.error(e);
-});