@cmflow/cli 3.4.0-alpha.1 → 3.4.0-alpha.3

package/src/semantic/core/prepare/commit.ts

@@ -1,30 +0,0 @@
-import { configureGitWorkspace, getConfig, git } from "../../../common/index.js";
-import type { SemanticContext } from "../../../common/types.js";
-
-export async function prepare(pluginConfig: Record<string, unknown>, context: SemanticContext) {
-  context.config = getConfig();
-
-  const {
-    logger,
-    config: { CI_NAME, BUILD_NUMBER }
-  } = context;
-
-  logger.info("Prepare release");
-
-  configureGitWorkspace(context);
-
-  logger.info("Adding files to commit");
-  git.add("-A").sync();
-
-  logger.info("Get commit stage status");
-  git.status();
-
-  const revisionMessage = `chore: ${CI_NAME} build ${context.branch.name} ${BUILD_NUMBER} ${context.nextRelease?.gitTag} [ci skip]`;
-
-  logger.info("Commit changes with revision message: ");
-  logger.info(revisionMessage);
-
-  git.commit("-m", revisionMessage, "--no-verify").sync();
-
-  logger.success("Change committed");
-}

package/src/semantic/core/prepare/release-info.ts

@@ -1,6 +0,0 @@
-import { writeFile } from "node:fs/promises";
-import type { SemanticContext } from "../../../common/types.js";
-
-export function prepare(pluginConfig: { path: string }, context: SemanticContext) {
-  return writeFile(pluginConfig.path, context.branch.name, { encoding: "utf-8" });
-}

package/src/semantic/core/run.ts

@@ -1,23 +0,0 @@
-import { getConfig, getPackageManager } from "../../common/index.js";
-import type { SemanticContext } from "../../common/types.js";
-
-/**
- * @param pluginConfig {{command: string}}
- * @param context
- * @return {Promise<void>}
- */
-export default async function runCommand(pluginConfig: { command: string }, context: SemanticContext) {
-  context.config = getConfig();
-  const {
-    config: { PACKAGE_MANAGER },
-    logger
-  } = context;
-
-  const pkgManager = getPackageManager(PACKAGE_MANAGER as string);
-
-  logger.info(`Start ${pluginConfig.command} task`);
-
-  await pkgManager.run(pluginConfig.command);
-
-  logger.info(`${pluginConfig.command} task finished with success...`);
-}

package/src/semantic/core/sync-repository.ts

@@ -1,55 +0,0 @@
-import { getConfig, git } from "../../common/index.js";
-import type { SemanticContext } from "../../common/types.js";
-
-export default async function syncRepository(pluginConfig: Record<string, unknown>, context: SemanticContext) {
-  context.config = getConfig();
-
-  const {
-    logger,
-    config: { PRODUCTION_BRANCH, ORIGIN, DEVELOP_BRANCH }
-  } = context;
-
-  logger.info("Prepare release");
-
-  async function asyncCatchError(fn: () => unknown) {
-    try {
-      return await fn();
-    } catch (er) {
-      context.logger.error(String(er), (er as Error).stack);
-    }
-  }
-
-  await asyncCatchError(() => git.fetch());
-
-  const branchesOption = context.options?.branches;
-  const branchesArray = Array.isArray(branchesOption) ? branchesOption : branchesOption ? [branchesOption] : [];
-  const candidateBranches =
-    (pluginConfig.includes as string[] | undefined) ||
-    branchesArray.map((branch: string | { name?: string }) => {
-      return (branch as { name?: string }).name || (branch as string);
-    });
-
-  logger.info(`Candidate branches to sync: ${(candidateBranches as string[]).join(", ")}`);
-
-  if ((candidateBranches as string[]).includes(context.branch.name)) {
-    logger.info(`Push ${context.branch.name}`);
-
-    await asyncCatchError(() => {
-      logger.info(`git push --quiet --set-upstream ${ORIGIN} ${context.branch.name}`);
-
-      return git.push("--quiet", "--set-upstream", ORIGIN as string, context.branch.name);
-    });
-  } else {
-    logger.info(`Skip push for ${context.branch.name}`);
-  }
-
-  if (PRODUCTION_BRANCH !== DEVELOP_BRANCH) {
-    logger.info(`Sync ${DEVELOP_BRANCH} with ${PRODUCTION_BRANCH}`);
-    logger.info(`git push -f ${ORIGIN} ${PRODUCTION_BRANCH}:refs/heads/${DEVELOP_BRANCH}`);
-
-    await asyncCatchError(async () => {
-      await git.push("-f", ORIGIN as string, `${PRODUCTION_BRANCH}:refs/heads/${DEVELOP_BRANCH}`);
-      logger.success(`${ORIGIN}/${DEVELOP_BRANCH} branch correctly updated`);
-    });
-  }
-}

package/src/semantic/core/verify-conditions.ts

@@ -1,41 +0,0 @@
-import chalk from "chalk";
-
-import { getConfig, git } from "../../common/index.js";
-import type { SemanticContext } from "../../common/types.js";
-
-export function verifyConditions(pluginConfig: Record<string, unknown>, context: SemanticContext) {
-  if (pluginConfig.dryRun) {
-    return;
-  }
-
-  context.config = getConfig();
-  const {
-    branch,
-    config: { USER, EMAIL, ORIGIN, GIT_FETCH_MAX_DEPTH }
-  } = context;
-
-  if (USER && EMAIL) {
-    context.logger.info("Configure git with username");
-
-    git.config("--global", "user.name", USER as string);
-    git.config("--global", "user.email", EMAIL as string);
-
-    context.logger.info("Configure git branch");
-    context.logger.success("Workspace is correctly configured");
-  } else {
-    context.logger.error(chalk.red("Ignore git configuration (Empty GIT_USER_EMAIL or/and GIT_USER_NAME variables)"));
-    process.exit(1);
-  }
-
-  if (GIT_FETCH_MAX_DEPTH !== "false") {
-    if (GIT_FETCH_MAX_DEPTH) {
-      git.fetch(`--depth=${GIT_FETCH_MAX_DEPTH}`).sync();
-    } else {
-      git.fetch().sync();
-    }
-
-    git.checkout(branch.name).sync();
-  }
-
-  git.branch(`--set-upstream-to=${ORIGIN}/${branch.name}`, branch.name).sync();
-}

package/src/semantic/core/verify-release.ts

@@ -1,10 +0,0 @@
-import { getConfig } from "../../common/index.js";
-import { displayPackageInfo } from "../utils/display-package-info.js";
-import { displayReleaseInfo } from "../utils/display-release-info.js";
-import type { SemanticContext } from "../../common/types.js";
-
-export function verifyRelease(pluginConfig: Record<string, unknown>, context: SemanticContext) {
-  context.config = getConfig();
-  displayPackageInfo(context);
-  displayReleaseInfo(context);
-}

package/src/semantic/define-config.ts

@@ -1,42 +0,0 @@
-import { getConfig } from "../common/get-config.js";
-import { releaseRules } from "./utils/release-rules.js";
-import { transformWriter } from "./utils/transform-writer.js";
-
-/**
- * Define the semantic-release configuration based on the ClubMed API configuration.
- * @param {import('semantic-release').GlobalConfig} opts
- * @returns {import('semantic-release').GlobalConfig}
- */
-export function defineConfig(opts = {}) {
-  const { PRODUCTION_BRANCH: productBranch, BRANCH_NAME: branchName } = getConfig();
-
-  return {
-    noCi: productBranch !== branchName,
-    branches: [
-      {
-        name: productBranch,
-        channel: "release"
-      },
-      // Use this hack to always run semantic-release (as prerelease for feature/fix branch)
-      {
-        name: branchName,
-        channel: "prerelease",
-        prerelease: true
-      }
-    ],
-    verifyConditions: ["@cmflow/cli/semantic/verify-conditions"],
-    analyzeCommits: ["@cmflow/cli/semantic/analyze-commits"],
-    verifyRelease: ["@cmflow/cli/semantic/verify-release"],
-    generateNotes: ["@cmflow/cli/semantic/generate-notes"],
-    prepare: [
-      "@cmflow/cli/semantic/prepare/bump-version",
-      "@cmflow/cli/semantif/prepare/post" // need to avoid semantic next step
-    ],
-    releaseRules,
-    parserOpts: {
-      noteKeywords: ["BREAKING CHANGE", "BREAKING CHANGES"]
-    },
-    writerOpts: { transform: transformWriter },
-    ...opts
-  };
-}

package/src/semantic/docker/publish.ts

@@ -1,6 +0,0 @@
-import { dockerPublish } from "../utils/docker-publish.js";
-import type { SemanticContext } from "../../common/types.js";
-
-export async function publish(pluginConfig: Record<string, unknown>, context: SemanticContext) {
-  await dockerPublish(context);
-}

package/src/semantic/docker/success.ts

@@ -1,10 +0,0 @@
-import type { CmContext } from "../../common/types.js";
-import { dockerCleanTags } from "../utils/docker-clean-tags.js";
-
-export async function success(_: Record<string, unknown>, context: CmContext) {
-  try {
-    await dockerCleanTags(context);
-  } catch (er) {
-    context.logger.warn(er);
-  }
-}

package/src/semantic/utils/__mock__/test1/package.json

@@ -1,7 +0,0 @@
-{
-  "name": "@package/root",
-  "version": "1.1.0",
-  "dependencies": {},
-  "devDependencies": {},
-  "peerDependencies": {}
-}

package/src/semantic/utils/__mock__/test1/packages/a/package.json

@@ -1,9 +0,0 @@
-{
-  "name": "@package/a",
-  "version": "1.1.0",
-  "dependencies": {
-    "@package/b": "1.1.0"
-  },
-  "devDependencies": {},
-  "peerDependencies": {}
-}

package/src/semantic/utils/__mock__/test1/packages/b/package.json

@@ -1,7 +0,0 @@
-{
-  "name": "@package/b",
-  "version": "1.1.0",
-  "dependencies": {},
-  "devDependencies": {},
-  "peerDependencies": {}
-}

package/src/semantic/utils/__mock__/test2/package.json

@@ -1,4 +0,0 @@
-{
-  "name": "@package/root",
-  "version": "1.0.0"
-}

package/src/semantic/utils/__mock__/test2/packages/a/package.json

@@ -1,7 +0,0 @@
-{
-  "name": "@package/a",
-  "version": "1.0.0",
-  "dependencies": {
-    "@package/b": "workspace:*"
-  }
-}

package/src/semantic/utils/__mock__/test2/packages/b/package.json

@@ -1,5 +0,0 @@
-{
-  "name": "@package/b",
-  "version": "1.0.0",
-  "dependencies": {}
-}

package/src/semantic/utils/bump-packages-version.test.ts

@@ -1,76 +0,0 @@
-// @ts-nocheck
-import fs from "fs-extra";
-import path from "path";
-import * as url from "url";
-
-import { bumpPackagesVersion } from "./bump-packages-version.js";
-
-const __dirname = url.fileURLToPath(new URL(".", import.meta.url));
-
-describe("bumpPackagesVersion()", () => {
-  beforeEach(() => {
-    vi.resetAllMocks();
-    vi.spyOn(fs, "writeFile").mockResolvedValue();
-    vi.spyOn(fs, "ensureDirSync").mockResolvedValue();
-  });
-
-  it("should upgrade dependencies (package manager: npm/yarn)", async () => {
-    await bumpPackagesVersion("1.1.0", ["packages/*"], path.join(__dirname, "__mock__/test1"));
-
-    const calls = fs.writeFile.mock.calls.sort(([a], [b]) => (a > b ? -1 : 1));
-
-    expect(JSON.parse(calls[0][1])).toEqual({
-      version: "1.1.0",
-      name: "@package/b",
-      dependencies: {},
-      devDependencies: {},
-      peerDependencies: {}
-    });
-
-    expect(JSON.parse(calls[1][1])).toEqual({
-      name: "@package/a",
-      version: "1.1.0",
-      dependencies: { "@package/b": "1.1.0" },
-      devDependencies: {},
-      peerDependencies: {}
-    });
-
-    expect(JSON.parse(calls[2][1])).toEqual({
-      name: "@package/root",
-      version: "1.1.0",
-      dependencies: {},
-      devDependencies: {},
-      peerDependencies: {}
-    });
-  });
-  it("should upgrade dependencies (package manager: yarn berry)", async () => {
-    await bumpPackagesVersion("1.1.0", ["packages/*"], path.join(__dirname, "__mock__/test2"));
-    const calls = fs.writeFile.mock.calls.sort(([a], [b]) => (a > b ? -1 : 1));
-
-    expect(JSON.parse(calls[0][1])).toEqual({
-      dependencies: {},
-      devDependencies: {},
-      name: "@package/b",
-      peerDependencies: {},
-      version: "1.1.0"
-    });
-
-    expect(JSON.parse(calls[1][1])).toEqual({
-      dependencies: {
-        "@package/b": "workspace:*"
-      },
-      devDependencies: {},
-      name: "@package/a",
-      peerDependencies: {},
-      version: "1.1.0"
-    });
-
-    expect(JSON.parse(calls[2][1])).toEqual({
-      dependencies: {},
-      devDependencies: {},
-      name: "@package/root",
-      peerDependencies: {},
-      version: "1.1.0"
-    });
-  });
-});

package/src/semantic/utils/bump-packages-version.ts

@@ -1,53 +0,0 @@
-import fs from "fs-extra";
-import { globby } from "globby";
-import { dirname } from "path";
-
-const PACKAGE_JSON_PROPS = ["dependencies", "devDependencies", "peerDependencies"];
-
-export async function bumpPackagesVersion(version: string, workspaces: string[], cwd = process.cwd()) {
-  const patterns = workspaces.map((path) => `${path}/package.json`).concat("package.json");
-
-  const files = await globby(patterns, {
-    cwd,
-    absolute: true
-  });
-
-  const names = new Set<string>();
-
-  const packages = await Promise.all(
-    files.map(async (file: string) => {
-      const pkg = (await fs.readJson(file)) as Record<string, unknown>;
-
-      names.add(pkg.name as string);
-
-      return {
-        file,
-        pkg
-      };
-    })
-  );
-
-  return Promise.all(
-    packages.map(({ pkg, file }: { pkg: Record<string, unknown>; file: string }) => {
-      pkg.version = version;
-
-      PACKAGE_JSON_PROPS.forEach((key) => bumpDependencies(pkg, key, version, names));
-
-      fs.ensureDirSync(dirname(file));
-      return fs.writeFile(file, JSON.stringify(pkg, null, 2), { encoding: "utf8" });
-    })
-  );
-}
-
-function bumpDependencies(pkg: Record<string, unknown>, key: string, version: string, names: Set<string>) {
-  pkg[key] = pkg[key] || {};
-
-  const deps = pkg[key] as Record<string, string>;
-  if (deps) {
-    names.forEach((name) => {
-      if (deps[name] && !deps[name].startsWith("workspace:")) {
-        deps[name] = version;
-      }
-    });
-  }
-}

package/src/semantic/utils/calculate-snapshot-version.test.ts

@@ -1,69 +0,0 @@
-import { git, getConfig } from "../../common/index.js";
-import type { CmContext } from "../../common/types";
-import { calculateSnapshotVersion } from "./calculate-snapshot-version.js";
-
-vi.mock("../../common/index.js", () => {
-  return {
-    git: {
-      getCommitTag: vi.fn()
-    },
-    getConfig: vi.fn()
-  };
-});
-
-describe("calculateSnapshotVersion", () => {
-  beforeEach(() => {
-    vi.mocked(git.getCommitTag).mockReturnValue("13246u");
-    vi.mocked(getConfig).mockReturnValue({
-      DEPLOY_ON_DOCKER: true,
-      PRODUCTION_BRANCH: "production",
-      DOCKER_REPOSITORY: "owner",
-      DOCKER_HUB_ID: "login",
-      DOCKER_HUB_PWD: "password"
-    } as unknown as CmContext["config"]);
-  });
-  it("should return the snapshot version", () => {
-    const context = {
-      nextRelease: { type: "patch" },
-      lastRelease: {
-        version: "1.0.0"
-      }
-    } as CmContext;
-
-    const version = calculateSnapshotVersion(context);
-    expect(git.getCommitTag).toHaveBeenCalledWith(context.config.REF_COMMIT);
-    expect(version).toEqual("1.0.1-beta13246u");
-  });
-
-  it("should return the snapshot version", () => {
-    const context = {
-      nextRelease: { type: "minor" },
-      lastRelease: {
-        version: "1.0.0"
-      },
-      config: {
-        REF_COMMIT: "REF_COMMIT"
-      }
-    } as CmContext;
-
-    const version = calculateSnapshotVersion(context);
-    expect(git.getCommitTag).toHaveBeenCalledWith(context.config.REF_COMMIT);
-    expect(version).toEqual("1.1.0-beta13246u");
-  });
-
-  it("should return the snapshot version", () => {
-    const context = {
-      nextRelease: { type: "major" },
-      lastRelease: {
-        version: "1.0.0"
-      },
-      config: {
-        REF_COMMIT: "REF_COMMIT"
-      }
-    } as CmContext;
-
-    const version = calculateSnapshotVersion(context);
-    expect(git.getCommitTag).toHaveBeenCalledWith(context.config.REF_COMMIT);
-    expect(version).toEqual("2.0.0-beta13246u");
-  });
-});

package/src/semantic/utils/calculate-snapshot-version.ts

@@ -1,17 +0,0 @@
-import semver from "semver";
-
-import { getConfig, git } from "../../common/index.js";
-import type { SemanticContext } from "../../common/types.js";
-
-export function calculateSnapshotVersion(context: SemanticContext) {
-  context.config = getConfig();
-  const {
-    nextRelease,
-    lastRelease,
-    config: { REF_COMMIT }
-  } = context;
-  const parsed = semver.parse(lastRelease?.version ?? "0.0.0");
-  const { major, minor, patch } = parsed ?? { major: 0, minor: 0, patch: 0 };
-
-  return `${semver.inc(`${major}.${minor}.${patch}`, nextRelease?.type ?? "patch") ?? "0.0.0"}-beta${git.getCommitTag(REF_COMMIT as string)}`;
-}

package/src/semantic/utils/display-package-info.ts

@@ -1,12 +0,0 @@
-import { logSection } from "./log-section.js";
-import type { SemanticContext } from "../../common/types.js";
-
-export function displayPackageInfo(context: SemanticContext) {
-  logSection("Package Info", context);
-  context.logger.info("Name       : " + context.config.PROJECT_NAME);
-  context.logger.info("Version    : " + context.lastRelease?.version);
-  context.logger.info("Repository : " + context.config.REPOSITORY_URL);
-  context.logger.info("Branch     : " + context.branch.name);
-  context.logger.info("Tag        : " + context.lastRelease?.gitTag);
-  context.logger.info("GitHead    : " + context.lastRelease?.gitHead);
-}

package/src/semantic/utils/display-release-info.ts

@@ -1,13 +0,0 @@
-import { logSection } from "./log-section.js";
-import type { SemanticContext } from "../../common/types.js";
-
-export function displayReleaseInfo(context: SemanticContext) {
-  logSection("Release Info", context);
-  context.logger.info("Branch   : " + context.branch.name);
-  context.logger.info("Build N° : " + context.config.BUILD_NUMBER);
-  context.logger.info("Version  : " + context.nextRelease?.version);
-  context.logger.info("Tag      : " + context.nextRelease?.gitTag);
-  context.logger.info("GitHead  : " + context.nextRelease?.gitHead);
-  context.logger.info("Type     : " + context.nextRelease?.type);
-  context.logger.info("Channel  : " + context.nextRelease?.channel);
-}

package/src/semantic/utils/docker-clean-tags.test.ts

@@ -1,62 +0,0 @@
-// @ts-nocheck
-vi.mock("../../common", () => {
-  return {
-    docker: {
-      getToken: vi.fn(),
-      getTags: vi.fn(),
-      deleteTag: vi.fn()
-    }
-  };
-});
-const { docker } = await import("../../common/index.js");
-const { dockerCleanTags } = await import("./docker-clean-tags.js");
-
-describe("dockerCleanTags", () => {
-  beforeEach(() => {
-    docker.getToken.mockReturnValue("token");
-    docker.getTags.mockReturnValue([
-      {
-        name: "branch-1",
-        last_updated: new Date("2020-06-01")
-      },
-      {
-        name: "1.1.0",
-        last_updated: new Date("2020-05-20")
-      },
-      {
-        name: "branch-2",
-        last_updated: new Date("2020-05-01")
-      },
-      {
-        name: "1.0.0",
-        last_updated: new Date("2020-04-01")
-      }
-    ]);
-  });
-  it("should clean obsolete tags", async () => {
-    const context = {
-      logger: {
-        info: vi.fn(),
-        warn: vi.fn()
-      },
-      config: {
-        DOCKER_HUB_ID: "DOCKER_HUB_ID",
-        DOCKER_HUB_PWD: "DOCKER_HUB_PWD",
-        DOCKER_REPOSITORY: "DOCKER_REPOSITORY"
-      }
-    };
-
-    await dockerCleanTags(context);
-
-    expect(docker.getToken).toHaveBeenCalledWith("DOCKER_HUB_ID", "DOCKER_HUB_PWD");
-    expect(docker.getTags).toHaveBeenCalledWith({
-      token: "token",
-      repository: "DOCKER_REPOSITORY"
-    });
-    expect(docker.deleteTag).toHaveBeenCalledWith("branch-2", {
-      token: "token",
-      repository: "DOCKER_REPOSITORY"
-    });
-    expect(docker.deleteTag).toHaveBeenCalledTimes(1);
-  });
-});

package/src/semantic/utils/docker-clean-tags.ts

@@ -1,58 +0,0 @@
-import { docker } from "../../common/index.js";
-import type { CmContext } from "../../common/types";
-
-interface DockerTag {
-  name: string;
-  last_updated: string | Date;
-  date?: number;
-}
-
-function mapTags(tags: DockerTag[]) {
-  const mapped = tags
-    .map((tag) => {
-      return {
-        name: tag.name,
-        date: new Date(tag.last_updated).getTime()
-      };
-    })
-    .sort((a, b) => b.date - a.date);
-
-  let tagFound = false;
-
-  return mapped.reduce((result: typeof mapped, tag) => {
-    if (tag.name.match(/\d+\.\d+\.\d+/)) {
-      tagFound = true;
-    } else if (tagFound) {
-      result.push(tag);
-    }
-    return result;
-  }, []);
-}
-
-export async function dockerCleanTags(context: CmContext) {
-  const {
-    logger,
-    config: { DOCKER_HUB_ID, DOCKER_HUB_PWD, DOCKER_REPOSITORY }
-  } = context;
-
-  if (DOCKER_HUB_ID && DOCKER_HUB_PWD) {
-    logger.info("Start clean Docker Hub...");
-
-    const token = await docker.getToken(DOCKER_HUB_ID, DOCKER_HUB_PWD);
-    const options = {
-      token,
-      repository: DOCKER_REPOSITORY
-    };
-
-    const tags = mapTags(await docker.getTags(options));
-
-    await Promise.all(
-      tags.map(async (tag) => {
-        await docker.deleteTag(tag.name, options);
-        logger.info(`TAG : ${tag.name} deleted`);
-      })
-    );
-
-    logger.info("Docker Hub Clean !");
-  }
-}