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

package/README.md

@@ -69,25 +69,30 @@ export default defineConfig({
   ],
   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: '@semantic-release/github' // only run if the conditional rule is true
       }
     ]
   ],
   success: [
+    '@cmflow/cli/semantic/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/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 +113,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
@@ -135,9 +159,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.1",
   "description": "An awesome Git Flow",
   "author": "camfou",
   "license": "MIT",

package/release.config.mjs

@@ -20,33 +20,20 @@ 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: [
-    [
-      "./src/semantic/core/publish.js",
-      {
-        runAfter: "@semantic-release/github"
-      }
-    ]
-  ],
+  publish: ["@semantic-release/github"],
   success: [
     [
       "./src/semantic/core/success.js",
       {
-        runAfter: "@semantic-release/github"
-      }
-    ]
-  ],
-  fail: [
-    [
-      "./src/semantic/core/fail.js",
-      {
-        runAfter: "@semantic-release/github"
+        when: () => true
       }
-    ]
+    ],
+    "@semantic-release/github"
   ],
+  fail: ["@semantic-release/github"],
   npmPublish: false
 });

package/src/semantic/core/conditional.js

@@ -0,0 +1,25 @@
+import { getConfig } from "../../common/index.js";
+export function success(pluginConfig, context) {
+  return runAll(pluginConfig, context, context.branch?.type === "release");
+}
+
+export function publish(pluginConfig, context) {
+  return runAll(pluginConfig, context, context.branch?.type === "release");
+}
+
+export function fail(pluginConfig, context) {
+  return runAll(pluginConfig, context, context.branch?.type === "release");
+}
+
+async function runAll(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) {
+      await task(pluginConfig, context);
+    }
+  }
+}

package/src/semantic/core/fail.js

@@ -3,9 +3,7 @@ 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 pluginConfig
  * @param context
  * @return {Promise<void>}
  */
@@ -19,11 +17,5 @@ export async function fail(pluginConfig, 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/success.js

@@ -5,7 +5,7 @@ import { git } from "../../common/index.js";
  * Add runAfter property with the semantic-release plugin name to run after the success task
  * depending on the branch type.
  *
- * @param pluginConfig {{runAfter: string}}
+ * @param pluginConfig {{}}
  * @param context
  * @return {Promise<void>}
  */
@@ -17,7 +17,9 @@ export async function success(pluginConfig, context) {
     config: { PRODUCTION_BRANCH, ORIGIN, DEVELOP_BRANCH }
   } = context;
 
-  if (branch.type !== "prerelease") {
+  const condition = pluginConfig.when !== undefined ? pluginConfig.when(context) : branch.type !== "prerelease";
+
+  if (condition) {
     await git.push("--quiet", "--set-upstream", ORIGIN, PRODUCTION_BRANCH);
 
     if (PRODUCTION_BRANCH !== DEVELOP_BRANCH) {
@@ -27,11 +29,5 @@ export async function success(pluginConfig, context) {
 
       logger.success(`${ORIGIN}/${DEVELOP_BRANCH} branch correctly updated`);
     }
-
-    if (pluginConfig.runAfter) {
-      const { success } = await import(pluginConfig.runAfter);
-
-      await success(pluginConfig, context);
-    }
   }
 }

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/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);
-  }
-}