@aidc-toolkit/dev 1.0.23-beta → 1.0.25-beta

package/src/publish/publish-alpha.ts

@@ -1,171 +0,0 @@
-import * as fs from "node:fs";
-import type { Repository } from "./configuration";
-import { PACKAGE_CONFIGURATION_PATH, PACKAGE_LOCK_CONFIGURATION_PATH, Publish } from "./publish.js";
-import { logger } from "./logger.js";
-
-const BACKUP_PACKAGE_CONFIGURATION_PATH = ".package.json";
-
-/**
- * Publish alpha versions.
- */
-class PublishAlpha extends Publish {
-    /**
-     * If true, update all dependencies automatically.
-     */
-    private readonly _updateAll: boolean;
-
-    /**
-     * Constructor.
-     *
-     * If true, outputs what would be run rather than running it.
-     *
-     * @param updateAll
-     * If true, update all dependencies automatically.
-     *
-     * @param dryRun
-     * If true, outputs what would be run rather than running it.
-     */
-    constructor(updateAll: boolean, dryRun: boolean) {
-        super("alpha", dryRun);
-
-        this._updateAll = updateAll;
-    }
-
-    /**
-     * @inheritDoc
-     */
-    protected dependencyVersionFor(): string {
-        // Dependency version is always "alpha".
-        return "alpha";
-    }
-
-    /**
-     * @inheritDoc
-     */
-    protected getPhaseDateTime(repository: Repository, phaseDateTime: Date): Date {
-        // If beta or production has been published since the last alpha, use that instead.
-        return this.latestDateTime(phaseDateTime, repository.phaseStates.beta?.dateTime, repository.phaseStates.production?.dateTime);
-    }
-
-    /**
-     * @inheritDoc
-     */
-    protected isValidBranch(): boolean {
-        // Any branch is valid for alpha publication.
-        return true;
-    }
-
-    /**
-     * @inheritDoc
-     */
-    protected publish(): void {
-        let anyExternalUpdates = false;
-
-        const repositoryState = this.repositoryState;
-        const packageConfiguration = repositoryState.packageConfiguration;
-
-        // Check for external updates, even if there are no changes.
-        for (const currentDependencies of [packageConfiguration.devDependencies, packageConfiguration.dependencies]) {
-            if (currentDependencies !== undefined) {
-                for (const [dependencyPackageName, version] of Object.entries(currentDependencies)) {
-                    // Ignore organization dependencies.
-                    if (this.dependencyRepositoryName(dependencyPackageName) === null && version.startsWith("^")) {
-                        const [latestVersion] = this.run(true, true, "npm", "view", dependencyPackageName, "version");
-
-                        if (latestVersion !== version.substring(1)) {
-                            logger.info(`Dependency ${dependencyPackageName}@${version} ${!this._updateAll ? "pending update" : "updating"} to version ${latestVersion}.`);
-
-                            if (this._updateAll) {
-                                currentDependencies[dependencyPackageName] = `^${latestVersion}`;
-
-                                anyExternalUpdates = true;
-                            }
-                        }
-                    }
-                }
-            }
-        }
-
-        if (anyExternalUpdates) {
-            // Save the dependency updates; this will be detected by call to anyChanges().
-            this.savePackageConfiguration();
-        }
-
-        if (this._updateAll) {
-            logger.debug("Updating all dependencies");
-
-            // Running this even if there are no dependency updates will update dependencies of dependencies.
-            this.run(false, false, "npm", "update", ...repositoryState.npmPlatformArgs);
-        }
-
-        const anyChanges = this.anyChanges(repositoryState.phaseDateTime, true) || repositoryState.anyDependenciesUpdated;
-
-        if (anyChanges) {
-            const switchToAlpha = repositoryState.preReleaseIdentifier !== "alpha";
-
-            if (switchToAlpha) {
-                // Previous publication was beta or production.
-                this.updatePackageVersion(undefined, undefined, repositoryState.patchVersion + 1, "alpha");
-
-                // Use specified registry for organization until no longer in alpha mode.
-                this.run(false, false, "npm", "config", "set", this.atOrganizationRegistry, "--location", "project");
-            }
-
-            if (repositoryState.anyDependenciesUpdated && (switchToAlpha || !this._updateAll)) {
-                this.updateOrganizationDependencies();
-            }
-        }
-
-        // Run lint if present.
-        this.run(false, false, "npm", "run", "lint", "--if-present");
-
-        // Run development build if present.
-        this.run(false, false, "npm", "run", "build:dev", "--if-present");
-
-        if (anyChanges) {
-            const now = new Date();
-            const nowISOString = now.toISOString();
-
-            // Nothing further required if this repository is not a dependency of others.
-            if (repositoryState.repository.dependencyType !== "none") {
-                if (!this.dryRun) {
-                    // Backup the package configuration file.
-                    fs.renameSync(PACKAGE_CONFIGURATION_PATH, BACKUP_PACKAGE_CONFIGURATION_PATH);
-                }
-
-                try {
-                    // Package version is transient.
-                    this.updatePackageVersion(undefined, undefined, undefined, `alpha.${nowISOString.replaceAll(/\D/g, "").substring(0, 12)}`);
-
-                    // Publish to development NPM registry.
-                    this.run(false, false, "npm", "publish", "--tag", "alpha");
-
-                    // Unpublish all prior alpha versions.
-                    // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- Output is a JSON array.
-                    for (const version of JSON.parse(this.run(true, true, "npm", "view", packageConfiguration.name, "versions", "--json").join("\n")) as string[]) {
-                        if (/^\d+.\d+.\d+-alpha.\d+$/.test(version) && version !== packageConfiguration.version) {
-                            this.run(false, false, "npm", "unpublish", `${packageConfiguration.name}@${version}`);
-                        }
-                    }
-                } finally {
-                    if (!this.dryRun) {
-                        // Restore the package configuration file.
-                        fs.rmSync(PACKAGE_CONFIGURATION_PATH);
-                        fs.renameSync(BACKUP_PACKAGE_CONFIGURATION_PATH, PACKAGE_CONFIGURATION_PATH);
-                    }
-                }
-            }
-
-            this.commitUpdatedPackageVersion(PACKAGE_CONFIGURATION_PATH, PACKAGE_LOCK_CONFIGURATION_PATH);
-
-            this.updatePhaseState({
-                dateTime: now
-            });
-        }
-    }
-}
-
-// Detailed syntax checking not required as this is an internal tool.
-await new PublishAlpha(process.argv.includes("--update-all"), process.argv.includes("--dry-run")).publishAll().catch((e: unknown) => {
-    logger.error(e);
-});

package/src/publish/publish-beta.ts

@@ -1,361 +0,0 @@
-import * as fs from "node:fs";
-import * as path from "node:path";
-import { setTimeout } from "node:timers/promises";
-import { Octokit } from "octokit";
-import { parse as yamlParse } from "yaml";
-import secureConfigurationJSON from "../../config/publish.secure.json";
-import type { Repository } from "./configuration";
-import { Publish } from "./publish.js";
-import { logger } from "./logger.js";
-
-/**
- * Configuration layout of publish.secure.json.
- */
-interface SecureConfiguration {
-    token: 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[];
-        } | null;
-
-        /**
-         * Release trigger.
-         */
-        release?: {
-            /**
-             * Release types.
-             */
-            types?: string[];
-        } | null;
-    };
-}
-
-/**
- * Publish steps.
- */
-type Step = "update" | "build" | "commit" | "tag" | "push" | "workflow (push)" | "release" | "workflow (release)" | "complete";
-
-/**
- * Publish beta versions.
- */
-class PublishBeta extends Publish {
-    /**
-     * Secure configuration.
-     */
-    private readonly _secureConfiguration: SecureConfiguration = secureConfigurationJSON;
-
-    /**
-     * Octokit.
-     */
-    private readonly _octokit: Octokit;
-
-    /**
-     * Constructor.
-     *
-     * @param dryRun
-     * If true, outputs what would be run rather than running it.
-     */
-    constructor(dryRun: boolean) {
-        super("beta", dryRun);
-
-        this._octokit = new Octokit({
-            auth: this._secureConfiguration.token,
-            userAgent: `${this.configuration.organization} release`
-        });
-    }
-
-    /**
-     * @inheritDoc
-     */
-    protected dependencyVersionFor(dependencyRepositoryName: string, dependencyRepository: Repository): string {
-        let dependencyVersion: string;
-
-        switch (dependencyRepository.dependencyType) {
-            case "external":
-                dependencyVersion = "beta";
-                break;
-
-            case "internal": {
-                const betaTag = dependencyRepository.phaseStates.beta?.tag;
-
-                if (betaTag === undefined) {
-                    throw new Error(`*** Internal error *** Beta tag not set for ${dependencyRepositoryName}`);
-                }
-
-                dependencyVersion = `${this.configuration.organization}/${dependencyRepositoryName}#${betaTag}`;
-            }
-                break;
-
-            default:
-                throw new Error(`Invalid dependency type "${dependencyRepository.dependencyType}" for dependency ${dependencyRepositoryName}`);
-        }
-
-        return dependencyVersion;
-    }
-
-    /**
-     * @inheritDoc
-     */
-    protected getPhaseDateTime(repository: Repository, phaseDateTime: Date): Date {
-        return this.latestDateTime(phaseDateTime, repository.phaseStates.production?.dateTime);
-    }
-
-    /**
-     * @inheritDoc
-     */
-    protected isValidBranch(): boolean {
-        const repositoryState = this.repositoryState;
-
-        // Branch for beta phase must match version.
-        return repositoryState.branch === `v${repositoryState.majorVersion}.${repositoryState.minorVersion}`;
-    }
-
-    /**
-     * Run a step.
-     *
-     * Repository.
-     *
-     * @param step
-     * State at which step takes place.
-     *
-     * @param stepRunner
-     * Callback to execute step.
-     */
-    private async runStep(step: Step, stepRunner: () => (void | Promise<void>)): Promise<void> {
-        const phaseStateStep = this.repositoryState.phaseState.step;
-
-        if (phaseStateStep === undefined || phaseStateStep === step) {
-            logger.debug(`Running step ${step}`);
-
-            this.updatePhaseState({
-                step
-            });
-
-            await stepRunner();
-
-            this.updatePhaseState({
-                step: undefined
-            });
-        } else {
-            logger.debug(`Skipping step ${step}`);
-        }
-    }
-
-    /**
-     * Validate the workflow by waiting for it to complete.
-     *
-     * Branch on which workflow is running.
-     */
-    private async validateWorkflow(): Promise<void> {
-        if (this.dryRun) {
-            logger.info("Dry run: Validate workflow");
-        } else {
-            const commitSHA = this.run(true, true, "git", "rev-parse", this.repositoryState.branch)[0];
-
-            let completed = false;
-            let queryCount = 0;
-            let workflowRunID = -1;
-
-            do {
-                // eslint-disable-next-line no-await-in-loop -- Loop depends on awaited response.
-                const response = await setTimeout(2000).then(
-                    async () => this._octokit.rest.actions.listWorkflowRunsForRepo({
-                        owner: this.configuration.organization,
-                        repo: this.repositoryState.repositoryName,
-                        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;
-
-                            logger.info(`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);
-        }
-    }
-
-    /**
-     * @inheritDoc
-     */
-    protected async publish(): Promise<void> {
-        let publish: boolean;
-
-        const repositoryState = this.repositoryState;
-
-        // Scrap any incomplete publishing if pre-release identifier is not beta.
-        if (repositoryState.preReleaseIdentifier !== "beta") {
-            repositoryState.phaseState.step = undefined;
-        }
-
-        if (repositoryState.preReleaseIdentifier === "alpha") {
-            if (this.anyChanges(repositoryState.repository.phaseStates.alpha?.dateTime, false)) {
-                throw new Error("Repository has changed since last alpha published");
-            }
-
-            publish = true;
-
-            this.updatePackageVersion(undefined, undefined, undefined, "beta");
-
-            // Revert to default registry for organization.
-            this.run(false, false, "npm", "config", "delete", this.atOrganizationRegistry, "--location", "project");
-        } else {
-            const step = repositoryState.phaseState.step;
-            const startingPublication = step === undefined;
-
-            // Step is defined and not "complete" if previous attempt failed at that step.
-            publish = !startingPublication && step !== "complete";
-
-            // Ignore changes after publication process has started.
-            if (startingPublication && this.anyChanges(repositoryState.repository.phaseStates.alpha?.dateTime, false)) {
-                throw new Error("Repository has changed since last alpha published");
-            }
-        }
-
-        if (publish) {
-            const tag = `v${repositoryState.packageConfiguration.version}`;
-
-            if (repositoryState.phaseState.step !== undefined) {
-                logger.debug(`Repository failed at step "${repositoryState.phaseState.step}" on prior run`);
-            }
-
-            const workflowsPath = ".github/workflows/";
-
-            let hasPushWorkflow = false;
-            let hasReleaseWorkflow = false;
-
-            if (fs.existsSync(workflowsPath)) {
-                logger.debug("Checking workflows");
-
-                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("v*"))) {
-                        logger.debug("Repository has push workflow");
-
-                        hasPushWorkflow = true;
-                    }
-
-                    if (workflowOn.release !== undefined && (workflowOn.release?.types === undefined || workflowOn.release.types.includes("published"))) {
-                        logger.debug("Repository has release workflow");
-
-                        hasReleaseWorkflow = true;
-                    }
-                }
-            }
-
-            await this.runStep("update", () => {
-                this.updateOrganizationDependencies();
-            });
-
-            await this.runStep("build", () => {
-                this.run(false, false, "npm", "run", "build:release", "--if-present");
-
-                // Run test if present; must be part of build as correcting errors will require rebuild.
-                this.run(false, false, "npm", "run", "test", "--if-present");
-            });
-
-            await this.runStep("commit", () => {
-                this.commitUpdatedPackageVersion();
-            });
-
-            await this.runStep("tag", () => {
-                this.run(false, false, "git", "tag", tag);
-            });
-
-            await this.runStep("push", () => {
-                this.run(false, false, "git", "push", "--atomic", "origin", repositoryState.branch, tag);
-            });
-
-            if (hasPushWorkflow) {
-                await this.runStep("workflow (push)", async () => {
-                    await this.validateWorkflow();
-                });
-            }
-
-            await this.runStep("release", async () => {
-                if (this.dryRun) {
-                    logger.info("Dry run: Create release");
-                } else {
-                    await this._octokit.rest.repos.createRelease({
-                        owner: this.configuration.organization,
-                        repo: repositoryState.repositoryName,
-                        tag_name: tag,
-                        name: `Release ${tag}`,
-                        prerelease: true
-                    });
-                }
-            });
-
-            if (hasReleaseWorkflow) {
-                await this.runStep("workflow (release)", async () => {
-                    await this.validateWorkflow();
-                });
-            }
-
-            this.updatePhaseState({
-                dateTime: new Date(),
-                tag,
-                step: "complete"
-            });
-        }
-    }
-
-    /**
-     * @inheritDoc
-     */
-    protected override finalizeAll(): void {
-        // Publication complete; reset steps to undefined for next run.
-        for (const repository of Object.values(this.configuration.repositories)) {
-            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion -- All beta phase states are defined by this point.
-            repository.phaseStates.beta!.step = undefined;
-        }
-    }
-}
-
-// Detailed syntax checking not required as this is an internal tool.
-await new PublishBeta(process.argv.includes("--dry-run")).publishAll().catch((e: unknown) => {
-    logger.error(e);
-});