@cmflow/cli 1.1.1-alpha.1 → 2.0.0-alpha.10

package/.yarnrc.yml

@@ -0,0 +1,3 @@
+nodeLinker: node-modules
+
+yarnPath: .yarn/releases/yarn-4.7.0.cjs

package/README.md

@@ -50,7 +50,15 @@ export default defineConfig({
   verifyConditions: ['@cmflow/cli/semantic/verify-conditions'],
   analyzeCommits: ['@cmflow/cli/semantic/analyze-commits'],
   verifyRelease: ['@cmflow/cli/semantic/verify-release'],
-  generateNotes: ['@cmflow/cli/semantic/generate-notes'],
+  generateNotes: [
+    [
+      "@cmflow/cli/semantic/conditional", // add this task to trigger build npm task
+      {
+        // when: (context) => context.branch.type === "release" //  default condition to run the task
+        run: ["@semantic-release/release-notes-generator"]
+      }
+    ]
+  ],
   prepare: [
     '@cmflow/cli/semantic/prepare/bump-version',
     [
@@ -65,29 +73,50 @@ export default defineConfig({
         command: 'test_e2e'
       }
     ],
-    '@cmflow/cli/semantif/prepare/post'
+    [
+      '@cmflow/cli/semantic/conditional', // add this task to trigger build npm task
+      {
+        // when: (context) => context.branch.type === "release" //  default condition to run the task
+        run:  [
+          '@cmflow/cli/semantic/core/prepare/commit'
+        ]
+      }
+    ]
   ],
   publish: [
     [
-      '@cmflow/cli/semantic/publish',
+      '@cmflow/cli/semantic/conditional',
       {
-        runAfter: "@semantic-release/github" // only run if the conditional rule is true
+        // when: (context) => context.branch.type === "release" //  default condition to run the task
+        run: [
+          '@cmflow/cli/semantic/publish/sync-repository',
+          '@semantic-release/github'
+        ] // only run if the conditional rule is true
+      }
+    ],
+    [
+      '@cmflow/cli/semantic/conditional', // run process.exit(0) if the branch is not a release branch - legacy: maybe not necessary now all task are conditional
+      {
+        when: (context) => context.branch.type !== 'release',
+        run: '@cmflow/cli/semantic/publish/exit.js'
       }
     ]
   ],
   success: [
     [
-      '@cmflow/cli/semantic/publish',
+      '@cmflow/cli/semantic/conditional',
       {
-        runAfter: "@semantic-release/github" // only run if the conditional rule is true
+        // when: (context) => context.branch.type === "release" //  default condition to run the task
+        run: '@semantic-release/github' // only run if the conditional rule is true
       }
     ]
   ],
   fail: [
     [
-      '@cmflow/cli/semantic/fail', 
+      "@cmflow/cli/semantic/conditional",
       {
-        runAfter: "@semantic-release/github" // only run if the conditional rule is true
+        // when: (context) => context.branch.type === "release" //  default condition to run the task
+        run: '@semantic-release/github' // only run if the conditional rule is true
       }
     ]
   ],
@@ -108,6 +137,25 @@ Then edit your `package.json` add the following tasks on script property:
 
 Now, CmFlow and semantic release are correctly installed on your project.
 
+### Condition step (publish, success, fail)
+
+CMFlow provide a `@cmflow/cli/semantic/conditional` task to run one task or many task only if a condition is true. The condition is a
+function that takes the semantic context as parameter and return a boolean. 
+
+You can customize the condition to run the task by adding a `when` property to the configuration object.
+
+```javascript
+export default defineConfig({
+  publish: [
+    '@cmflow/cli/semantic/conditional',
+    {
+      when: (context) => context.branch.type === 'release', //  default condition to run the task
+      run: ['@semantic-release/github', '@semantic-release/github'] // only run if the conditional rule is true
+    }
+  ]
+})
+```
+
 ### Build and E2E Test
 
 CmFlow release are able to run `build` and `test_e2e` task during the prepare step. It's useful when you want to
@@ -125,6 +173,26 @@ Example:
 }
 ```
 
+### Generate release.info file 
+
+CmFlow release generate a `release.info` file in the root of your project. This file contains the branch name.
+
+```js
+import { defineConfig } from '@cmflow/cli'
+
+export default defineConfig({
+  prepare: [
+    '@cmflow/cli/semantic/prepare/bump-version',
+    [
+      '@cmflow/cli/semantic/prepare/release-info',
+      {
+        path: './resources/release.info'
+      }
+    ]
+  ]
+})
+```
+
 ### Deploy on Docker Hub
 
 Add the following configuration to your `release.config.js`:
@@ -135,9 +203,9 @@ import { defineConfig } from '@cmflow/cli'
 export default defineConfig({
   publish: [
     [
-      '@cmflow/cli/semantic/publish',
+      '@cmflow/cli/semantic/conditional',
       {
-        runAfter: '@semantic-release/github' // only run if the conditional rule is true
+        run: '@semantic-release/github'
       }
     ],
     '@cmflow/cli/semantic/docker/publish'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cmflow/cli",
-  "version": "1.1.1-alpha.1",
+  "version": "2.0.0-alpha.10",
   "description": "An awesome Git Flow",
   "author": "camfou",
   "license": "MIT",
@@ -8,36 +8,31 @@
   "main": "./src/index.js",
   "module": "./src/index.js",
   "type": "module",
-  "private": false,
   "bin": {
+    "checkfeatures": "./bin/checkfeatures.sh",
     "cm": "./bin/cm.js",
+    "cmconfig": "bin/cm-config.js",
+    "cmexpedit": "./bin/cmexpedit.sh",
     "cmfetch": "bin/cm-fetch.js",
-    "cmrebase": "bin/cm-rebase.js",
     "cmfinish": "bin/cm-finish.js",
-    "cmexpedit": "./bin/cmexpedit.sh",
+    "cmmerge": "./bin/cm-merge.js",
     "cmpublish": "bin/cm-publish.js",
-    "cmrepublish": "bin/cm-republish.js",
-    "cmpush": "bin/cm-push.js",
     "cmpull": "./bin/cmpull.sh",
-    "cmstart": "bin/cm-start.js",
-    "checkfeatures": "./bin/checkfeatures.sh",
+    "cmpush": "bin/cm-push.js",
+    "cmrebase": "bin/cm-rebase.js",
     "cmrelease": "./bin/cmrelease.js",
-    "cmmerge": "./bin/cm-merge.js",
-    "cmchangelog": "bin/cm-changelog.js",
-    "cmconfig": "bin/cm-config.js"
+    "cmrepublish": "bin/cm-republish.js",
+    "cmstart": "bin/cm-start.js"
   },
   "exports": {
-    ".": "./index.js",
-    "./semantic/prepare/*": "./src/semantic-release/core/prepare/*.js",
-    "./semantic/*": "./src/semantic-release/core/*.js",
-    "./semantic/docker/*": "./src/semantic-release/docker/*.js"
+    ".": "./src/index.js",
+    "./semantic/*": "./src/semantic/*.js"
   },
   "dependencies": {
+    "any-observable": "0.5.1",
     "axios": "1.8.2",
     "chalk": "^4.1.0",
     "commander": "5.1.0",
-    "conventional-changelog": "3.1.25",
-    "conventional-changelog-cli": "2.2.2",
     "execa": "5.1.1",
     "figures": "3.2.0",
     "fs-extra": "^10.1.0",
@@ -47,14 +42,16 @@
     "listr": "0.14.3",
     "lodash": "4.17.21",
     "rxjs": "7.8.1",
-    "semantic-release": "23.1.1",
-    "semver": "7.3.7",
+    "semantic-release": ">=24.2.3",
+    "semver": "7.7.1",
     "split": "1.0.1"
   },
   "devDependencies": {
+    "@semantic-release/github": "11.0.1",
+    "@semantic-release/release-notes-generator": ">=14.0.3",
     "@stylistic/eslint-plugin": "^4.2.0",
-    "@typescript-eslint/parser": "8.26.1",
     "@typescript-eslint/eslint-plugin": "8.26.1",
+    "@typescript-eslint/parser": "8.26.1",
     "eslint": "9.21.0",
     "eslint-config-prettier": "10.0.2",
     "eslint-formatter-junit": "^8.40.0",
@@ -62,15 +59,14 @@
     "eslint-plugin-simple-import-sort": "12.1.1",
     "eslint-plugin-vitest": "0.5.4",
     "husky": "4.3.6",
-    "prettier": "3.5.1",
     "lint-staged": "10.5.3",
-    "vitest": "^3.0.8",
-    "typescript": "5.8.2"
+    "prettier": "3.5.1",
+    "typescript": "5.8.2",
+    "vitest": "^3.0.8"
   },
   "peerDependencies": {
-    "@semantic-release/commit-analyzer": "^11.1.0",
-    "@semantic-release/github": "^10.1.1",
-    "@semantic-release/release-notes-generator": "^12.1.0"
+    "@semantic-release/commit-analyzer": ">=13.0.1",
+    "@semantic-release/release-notes-generator": ">=14.0.3"
   },
   "peerDependenciesMeta": {
     "@semantic-release/commit-analyzer": {
@@ -87,8 +83,7 @@
     "lint_ci": "eslint --format junit --output-file ./reports/eslint.xml",
     "lint_fix": "eslint --fix",
     "release": "node bin/cmrelease.js",
-    "release_dry_run": "node bin/cmrelease.js --dry-run",
-    "build_changelog": "node bin/cm-changelog.js"
+    "release_dry_run": "node bin/cmrelease.js --dry-run"
   },
   "husky": {
     "hooks": {
@@ -107,5 +102,6 @@
       "develop": "master",
       "production": "master"
     }
-  }
+  },
+  "packageManager": "yarn@4.7.0"
 }

package/release.config.mjs

@@ -20,33 +20,19 @@ export default defineConfig({
     }
   ],
   verifyConditions: ["./src/semantic/core/verify-conditions.js"],
-  analyzeCommits: ["./src/semantic/core/analyze-commits.js"],
+  analyzeCommits: ["@semantic-release/commit-analyzer"],
   verifyRelease: ["./src/semantic/core/verify-release.js"],
-  generateNotes: ["./src/semantic/core/generate-notes.js"],
-  prepare: ["./src/semantic/core/prepare/bump-version.js", "./src/semantic/core/prepare/post.js"],
-  publish: [
+  generateNotes: [
     [
-      "./src/semantic/core/publish.js",
+      "./src/semantic/core/conditional",
       {
-        runAfter: "@semantic-release/github"
-      }
-    ]
-  ],
-  success: [
-    [
-      "./src/semantic/core/success.js",
-      {
-        runAfter: "@semantic-release/github"
-      }
-    ]
-  ],
-  fail: [
-    [
-      "./src/semantic/core/fail.js",
-      {
-        runAfter: "@semantic-release/github"
+        run: ["@semantic-release/release-notes-generator"]
       }
     ]
   ],
+  prepare: ["./src/semantic/core/prepare/bump-version.js", "./src/semantic/core/prepare/commit.js"],
+  publish: ["./src/semantic/core/publish/sync-repository.js", "@semantic-release/github"],
+  success: ["@semantic-release/github"],
+  fail: ["@semantic-release/github"],
   npmPublish: false
 });

package/src/commands/index.js

@@ -1,4 +1,3 @@
-export * from "./changelog.js";
 export * from "./clean.js";
 export * from "./deploy.js";
 export * from "./fetch.js";

package/src/semantic/core/conditional.js

@@ -0,0 +1,42 @@
+import { getConfig } from "../../common/index.js";
+
+export function prepare(pluginConfig, context) {
+  return runAll("prepare", pluginConfig, context, context.branch?.type === "release");
+}
+
+export function success(pluginConfig, context) {
+  return runAll("success", pluginConfig, context, context.branch?.type === "release");
+}
+
+export function publish(pluginConfig, context) {
+  return runAll("publish", pluginConfig, context, context.branch?.type === "release");
+}
+
+export function generateNotes(pluginConfig, context) {
+  return runAll("generateNotes", pluginConfig, context, context.branch?.type === "release");
+}
+
+export function fail(pluginConfig, context) {
+  return runAll("fail", pluginConfig, context, context.branch?.type === "release");
+}
+
+async function runAll(step, pluginConfig, context, defaultCondition) {
+  context.config = getConfig();
+
+  const condition = pluginConfig.when !== undefined ? pluginConfig.if(context) : defaultCondition;
+
+  if (condition && pluginConfig.run) {
+    const tasks = [].concat(pluginConfig.run);
+
+    for (const task of tasks) {
+      if (typeof task === "string") {
+        const mod = await import(task);
+        const taskFunction = mod[step];
+
+        if (taskFunction) {
+          await taskFunction(pluginConfig, context);
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,29 @@
+import { configureGitWorkspace, getConfig, git } from "../../../common/index.js";
+
+export async function prepare(pluginConfig, context) {
+  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 = `${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).sync();
+
+  logger.success("Change committed");
+}

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

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

package/src/semantic/core/publish/exit.js

@@ -0,0 +1,7 @@
+import { getConfig } from "../../../common/index.js";
+
+export async function prepare(pluginConfig, context) {
+  context.config = getConfig();
+  // avoid next semantic-release steps when is a prerelease or release branch with SKIP_GITHUB_PUBLISH
+  process.exit(0);
+}

package/src/semantic/core/publish/sync-repository.js

@@ -0,0 +1,42 @@
+import { getConfig, git } from "../../../common/index.js";
+
+export async function publish(pluginConfig, context) {
+  context.config = getConfig();
+
+  const {
+    logger,
+    config: { PRODUCTION_BRANCH, ORIGIN, DEVELOP_BRANCH }
+  } = context;
+
+  logger.info("Prepare release");
+
+  async function asyncCatchError(fn) {
+    try {
+      return await fn();
+    } catch (er) {
+      context.logger.error(String(er), er.stack);
+    }
+  }
+
+  await asyncCatchError(() => git.fetch());
+
+  if ([PRODUCTION_BRANCH, "alpha", "beta", "rc"].includes(context.branch.name)) {
+    logger.info(`Push ${PRODUCTION_BRANCH}`);
+
+    await asyncCatchError(() => {
+      logger.info(`git push --quiet --set-upstream ${ORIGIN} ${context.branch.name}`);
+
+      return git.push("--quiet", "--set-upstream", ORIGIN, 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, `${PRODUCTION_BRANCH}:refs/heads/${DEVELOP_BRANCH}`);
+      logger.success(`${ORIGIN}/${DEVELOP_BRANCH} branch correctly updated`);
+    });
+  }
+}

package/src/semantic/utils/release-rules.js

@@ -2,4 +2,14 @@ import omit from "lodash/omit.js";
 
 import { WORKFLOW_CONFIGURATION } from "../../workflow/index.js";
 
-export const releaseRules = WORKFLOW_CONFIGURATION.map((props) => omit(props, ["label"]));
+export const releaseRules = [
+  {
+    breaking: true,
+    release: "major"
+  },
+  {
+    revert: true,
+    release: "patch"
+  },
+  ...WORKFLOW_CONFIGURATION.map((props) => omit(props, ["label"]))
+];

package/src/semantic/utils/transform-writer.js

@@ -16,6 +16,8 @@ const transformCommitType = (commit) => {
 };
 
 export function transformWriter(commit, context) {
+  commit = { ...commit };
+
   const issues = [];
 
   commit.notes.forEach((note) => {

package/bin/cm-changelog.js

@@ -1,26 +0,0 @@
-#!/usr/bin/env node
-
-import commander from "commander";
-
-import { commands, runCommand } from "../src/index.js";
-
-commander
-  .usage("cmchangelog [options]")
-  .alias("cm changelog")
-  .option(
-    "-p, --preset <preset>",
-    "Name of the preset you want to use. Must be one of the following:\n" +
-      "angular, atom, codemirror, ember, eslint, express, jquery, jscs or jshint",
-    "angular"
-  )
-  .option(
-    "-r, --release-count <count>",
-    "How many releases to be generated from the latest\n" +
-      "If 0, the whole changelog will be regenerated and the outfile will be overwritten\n" +
-      "Default: 0",
-    0
-  )
-  .option("-t, --tag-prefix <prefix>", "Tag prefix to consider when reading the tags")
-  .parse(process.argv);
-
-runCommand(commands.Changelog, commander);

package/src/commands/changelog.js

@@ -1,47 +0,0 @@
-import conventionalChangelog from "conventional-changelog";
-import { createWriteStream } from "fs";
-import { Observable } from "rxjs";
-
-export class Changelog {
-  mapContext(commander, config) {
-    return {
-      preset: commander.preset || "angular",
-      releaseCount: commander.releaseCount || 0,
-      outfile: `${process.cwd()}/CHANGELOG.md`,
-
-      tagPrefix: (config.tagFormat || commander.tagPrefix || "").replace("${version}", "")
-    };
-  }
-
-  exec({ preset, releaseCount, outfile, tagPrefix }) {
-    const writableStream = createWriteStream(outfile, { encoding: "utf8" });
-
-    return new Observable((observer) => {
-      const stream = conventionalChangelog({
-        preset,
-        releaseCount,
-        path: `${process.cwd()}/package.json`,
-        tagPrefix
-      });
-
-      stream.pipe(writableStream);
-
-      stream.on("error", (err) => {
-        observer.error(err);
-      });
-
-      stream.on("end", () => {
-        observer.complete();
-      });
-    });
-  }
-
-  getTasks(ctx) {
-    return [
-      {
-        title: "Generate changelog",
-        task: () => this.exec(ctx)
-      }
-    ];
-  }
-}

package/src/semantic/core/fail.js

@@ -1,29 +0,0 @@
-import { git } from "../../common/index.js";
-
-/**
- * Remove the tag from the git repository if the release is not a prerelease.
- *
- * Add runAfter property with the semantic-release plugin name to run after the fail task.
- *
- * @param pluginConfig {{runAfter: string}}
- * @param context
- * @return {Promise<void>}
- */
-export async function fail(pluginConfig, context) {
-  if (context.branch && context.branch.type !== "prerelease") {
-    const {
-      tagFormat,
-      config: { ORIGIN }
-    } = context;
-
-    try {
-      await git.push("--delete", ORIGIN, tagFormat.replace("${version}", context.nextRelease.version));
-    } catch {}
-
-    if (pluginConfig.runAfter) {
-      const { fail } = await import(pluginConfig.runAfter);
-
-      await fail(pluginConfig, context);
-    }
-  }
-}

package/src/semantic/core/generate-notes.js

@@ -1,11 +0,0 @@
-import * as releaseNotesPlugins from "@semantic-release/release-notes-generator";
-
-import { getConfig } from "../../common/index.js";
-
-export async function generateNotes(pluginConfig, context) {
-  context.config = getConfig();
-
-  if (context.branch.type === "release") {
-    return releaseNotesPlugins.generateNotes(pluginConfig, context);
-  }
-}

package/src/semantic/core/prepare/post.js

@@ -1,38 +0,0 @@
-import { configureGitWorkspace, getConfig, git } from "../../../common/index.js";
-
-export async function prepare(pluginConfig, context) {
-  context.config = getConfig();
-  const { branch } = context;
-
-  if (branch.type === "release") {
-    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 = `${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).sync();
-
-    logger.success("Change committed");
-    return;
-  }
-
-  // avoid next semantic-release steps when is a prerelease or release branch with SKIP_GITHUB_PUBLISH
-  process.exit(0);
-}

package/src/semantic/core/publish.js

@@ -1,9 +0,0 @@
-export async function publish(pluginConfig, context) {
-  const { branch } = context;
-
-  if (branch.type === "release" && pluginConfig.runAfter) {
-    const { publish } = await import(pluginConfig.runAfter);
-
-    await publish(pluginConfig, context);
-  }
-}