@cmflow/cli 2.0.0-alpha.12 → 2.0.0-alpha.14

package/README.md

@@ -89,7 +89,7 @@ export default defineConfig({
       {
         // when: (context) => context.branch.type === "release" //  default condition to run the task
         run: [
-          '@cmflow/cli/semantic/core/publish/sync-repository',
+          '@cmflow/cli/semantic/core/sync-repository',
           '@semantic-release/github'
         ] // only run if the conditional rule is true
       }
@@ -98,7 +98,7 @@ export default defineConfig({
       '@cmflow/cli/semantic/core/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/core/publish/exit'
+        run: '@cmflow/cli/semantic/core/exit'
       }
     ]
   ],
@@ -172,6 +172,26 @@ Example:
   }
 }
 ```
+Then:
+
+```javascript
+export default defineConfig({
+  prepare: [
+    [
+      '@cmflow/cli/semantic/core/run',
+      {
+        command: 'build'
+      }
+    ],
+    [
+      '@cmflow/cli/semantic/core/run',
+      {
+        command: 'test_e2e'
+      }
+    ]
+  ]
+})
+```
 
 ### Generate release.info file 
 
@@ -202,33 +222,21 @@ import { defineConfig } from '@cmflow/cli'
 
 export default defineConfig({
   publish: [
-    [
-      '@cmflow/cli/semantic/conditional',
-      {
-        run: '@semantic-release/github'
-      }
-    ],
     '@cmflow/cli/semantic/docker/publish'
   ]
 });
 ```
 
-### Clean docker tags
+### Publish & Clean docker tags
 
 ```js
 import { defineConfig } from '@cmflow/cli'
 
 export default defineConfig({
   success: [
-    [
-      '@cmflow/cli/semantic/success',
-      {
-        runAfter: '@semantic-release/github' // only run if the conditional rule is true
-      }
-    ],
-    '@cmflow/cli/semantic/docker/publish'
+    '@cmflow/cli/semantic/docker/success'
   ]
-});
+})
 ```
 
 ### Configure CI

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cmflow/cli",
-  "version": "2.0.0-alpha.12",
+  "version": "2.0.0-alpha.14",
   "description": "An awesome Git Flow",
   "author": "camfou",
   "license": "MIT",

package/release.config.mjs

@@ -31,7 +31,7 @@ export default defineConfig({
     ]
   ],
   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"],
+  publish: ["./src/semantic/core/sync-repository.js", "@semantic-release/github"],
   success: ["@semantic-release/github"],
   fail: ["@semantic-release/github"],
   npmPublish: false

package/src/semantic/core/conditional.js

@@ -25,7 +25,12 @@ async function runAll(step, pluginConfig, context, defaultCondition) {
 
   const condition = pluginConfig.when !== undefined ? pluginConfig.when(context) : defaultCondition;
 
-  if (condition && pluginConfig.run) {
+  if (!condition) {
+    context.logger.info(`Skip step "${step}" of plugin(s) "${pluginConfig.run}"`);
+    return;
+  }
+
+  if (pluginConfig.run) {
     const tasks = [].concat(pluginConfig.run);
 
     for (const task of tasks) {
@@ -34,7 +39,15 @@ async function runAll(step, pluginConfig, context, defaultCondition) {
         const taskFunction = mod[step];
 
         if (taskFunction) {
-          await taskFunction(pluginConfig, context);
+          context.logger.log(`   Start conditional step "${step}" of plugin "${task}"`);
+
+          try {
+            await taskFunction(pluginConfig, context);
+            context.logger.success(`   Completed conditional step "${step}" of plugin "${task}"`);
+          } catch (er) {
+            context.logger.fail(`   Fail conditional step "${step}" of plugin "${task}"`);
+            throw er;
+          }
         }
       }
     }

package/src/semantic/core/exit.js

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

package/src/semantic/core/{prepare/run.js → run.js}

@@ -1,11 +1,11 @@
-import { getConfig, npm, yarn } from "../../../common/index.js";
+import { getConfig, npm, yarn } from "../../common/index.js";
 
 /**
  * @param pluginConfig {{command: string}}
  * @param context
  * @return {Promise<void>}
  */
-export async function prepare(pluginConfig, context) {
+export default async function runCommand(pluginConfig, context) {
   context.config = getConfig();
   const {
     config: { HAS_YARN },

package/src/semantic/core/{publish/sync-repository.js → sync-repository.js}

@@ -1,6 +1,6 @@
-import { getConfig, git } from "../../../common/index.js";
+import { getConfig, git } from "../../common/index.js";
 
-export async function publish(pluginConfig, context) {
+export default async function syncRepository(pluginConfig, context) {
   context.config = getConfig();
 
   const {

package/src/semantic/define-config.js

@@ -30,34 +30,8 @@ export function defineConfig(opts = {}) {
     generateNotes: ["@cmflow/cli/semantic/generate-notes"],
     prepare: [
       "@cmflow/cli/semantic/prepare/bump-version",
-      // '@cmflow/cli/semantic/prepare/build',
-      // '@cmflow/cli/semantic/prepare/e2e',
       "@cmflow/cli/semantif/prepare/post" // need to avoid semantic next step
     ],
-    publish: [
-      [
-        "@cmflow/cli/semantic/publish",
-        {
-          runAfter: opts.runAfter
-        }
-      ]
-    ],
-    success: [
-      [
-        "@cmflow/cli/semantic/success",
-        {
-          runAfter: opts.runAfter
-        }
-      ]
-    ],
-    fail: [
-      [
-        "@cmflow/cli/semantic/fail",
-        {
-          runAfter: opts.runAfter
-        }
-      ]
-    ],
     releaseRules,
     parserOpts: {
       noteKeywords: ["BREAKING CHANGE", "BREAKING CHANGES"]

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

@@ -1,7 +0,0 @@
-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);
-}