@cmflow/cli 2.0.0-alpha.8 → 2.0.0-rc.1

package/README.md

@@ -1,4 +1,4 @@
-<h1 style="text-align: center" align="center">CMFLOW</h1>
+<h1 style="text-align: center" align="center">@clubmed/cli aka ClubMed Flow </h1>
 
 <div align="center">
 
@@ -47,64 +47,63 @@ Then create `release.config.js` with this configuration:
 import { defineConfig } from '@cmflow/cli'
 
 export default defineConfig({
-  verifyConditions: ['@cmflow/cli/semantic/verify-conditions'],
-  analyzeCommits: ['@cmflow/cli/semantic/analyze-commits'],
-  verifyRelease: ['@cmflow/cli/semantic/verify-release'],
+  verifyConditions: ['@cmflow/cli/semantic/core/verify-conditions'],
+  analyzeCommits: ['@cmflow/cli/semantic/core/analyze-commits'],
+  verifyRelease: ['@cmflow/cli/semantic/core/verify-release'],
   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"]
+        run: ["@semantic-release/core/release-notes-generator"]
       }
     ]
   ],
   prepare: [
-    '@cmflow/cli/semantic/prepare/bump-version',
+    '@cmflow/cli/semantic/core/prepare/bump-version',
     [
-      '@cmflow/cli/semantic/prepare/run', // add this task to trigger build npm task
+      '@cmflow/cli/semantic/core/prepare/run', // add this task to trigger build npm task
       {
         command: 'build'
       }
     ],
     [
-      '@cmflow/cli/semantic/prepare/run', // add this task to trigger build npm task
+      '@cmflow/cli/semantic/core/prepare/run', // add this task to trigger build npm task
       {
         command: 'test_e2e'
       }
     ],
     [
-      '@cmflow/cli/semantic/conditional', // add this task to trigger build npm task
+      '@cmflow/cli/semantic/core/conditional', // add this task to trigger build npm task
       {
         // when: (context) => context.branch.type === "release" //  default condition to run the task
         run:  [
-          '@cmflow/semantic/core/prepare/commit'
+          '@cmflow/cli/semantic/core/prepare/commit'
         ]
       }
     ]
   ],
   publish: [
     [
-      '@cmflow/cli/semantic/conditional',
+      '@cmflow/cli/semantic/core/conditional',
       {
         // when: (context) => context.branch.type === "release" //  default condition to run the task
         run: [
-          '@cmflow/cli/semantic/publish/sync-repository',
+          '@cmflow/cli/semantic/core/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
+      '@cmflow/cli/semantic/core/exit', // 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'
+        when: (context) => context.nextRelease.channel === 'prerelease'
       }
     ]
   ],
   success: [
     [
-      '@cmflow/cli/semantic/conditional',
+      '@cmflow/cli/semantic/core/conditional',
       {
         // when: (context) => context.branch.type === "release" //  default condition to run the task
         run: '@semantic-release/github' // only run if the conditional rule is true
@@ -113,7 +112,7 @@ export default defineConfig({
   ],
   fail: [
     [
-      "@cmflow/cli/semantic/conditional",
+      "@cmflow/cli/semantic/core/conditional",
       {
         // when: (context) => context.branch.type === "release" //  default condition to run the task
         run: '@semantic-release/github' // only run if the conditional rule is true
@@ -139,7 +138,7 @@ 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
+CMFlow provide a `@cmflow/cli/semantic/core/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.
@@ -147,7 +146,7 @@ You can customize the condition to run the task by adding a `when` property to t
 ```javascript
 export default defineConfig({
   publish: [
-    '@cmflow/cli/semantic/conditional',
+    '@cmflow/cli/semantic/core/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
@@ -172,6 +171,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 +221,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.8",
+  "version": "2.0.0-rc.1",
   "description": "An awesome Git Flow",
   "author": "camfou",
   "license": "MIT",
@@ -26,9 +26,7 @@
   },
   "exports": {
     ".": "./src/index.js",
-    "./semantic/prepare/*": "./src/semantic/core/prepare/*.js",
-    "./semantic/*": "./src/semantic/core/*.js",
-    "./semantic/docker/*": "./src/semantic/docker/*.js"
+    "./semantic/*": "./src/semantic/*.js"
   },
   "dependencies": {
     "any-observable": "0.5.1",

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/common/configure-git-workspace.js

@@ -3,7 +3,7 @@ import { git } from "./cli/git.js";
 export function configureGitWorkspace(context) {
   const {
     logger,
-    config: { SCM_TOKEN, REPOSITORY_URL, ORIGIN, GIT_USER_NAME, GIT_USER_EMAIL }
+    config: { SCM_TOKEN, REPOSITORY_URL, ORIGIN, GIT_USER_NAME, GIT_USER_EMAIL, GIT_DISABLE_SSL }
   } = context;
 
   if (GIT_USER_NAME && GIT_USER_EMAIL) {
@@ -11,6 +11,11 @@ export function configureGitWorkspace(context) {
     git.config("--global", "user.email", `"${GIT_USER_EMAIL}"`);
   }
 
+  if (GIT_DISABLE_SSL) {
+    logger.info("Disable SSL verification");
+    git.config("--global", "http.sslVerify", "false");
+  }
+
   if (SCM_TOKEN) {
     const repository = REPOSITORY_URL.replace("https://", "");
 

package/src/common/get-config.js

@@ -74,8 +74,20 @@ export function getCI() {
 export function getConfig() {
   const pkg = getPackageJson();
   const [owner, projectName] = pkg.name.replace(/^@/, "").split("/");
-  const { PROJECT_NAME, DOCKER_HUB_ID, DOCKER_HUB_PWD, REF_COMMIT, GH_TOKEN, SCM_TOKEN, REPOSITORY_URL, GIT_USER_NAME, GIT_USER_EMAIL } =
-    process.env;
+  const {
+    PROJECT_NAME,
+    DOCKER_HUB_ID,
+    DOCKER_HUB_PWD,
+    REF_COMMIT,
+    GH_TOKEN,
+    SCM_TOKEN,
+    REPOSITORY_URL,
+    GIT_DISABLE_SSL,
+    GIT_USER_NAME,
+    GIT_USER_EMAIL,
+    GITLAB_USER_EMAIL,
+    GITLAB_USER_NAME
+  } = process.env;
 
   const HAS_YARN = hasYarn();
   const IS_YARN_BERRY = HAS_YARN ? fs.existsSync(join(process.cwd(), ".yamlrc.yml")) : false;
@@ -113,8 +125,9 @@ export function getConfig() {
     GH_TOKEN,
     SCM_TOKEN: GH_TOKEN || SCM_TOKEN,
     REPOSITORY_URL: get(pkg, "repository.url", get(pkg, "repository", REPOSITORY_URL)),
-    GIT_USER_NAME,
-    GIT_USER_EMAIL,
+    GIT_USER_NAME: GIT_USER_NAME || GITLAB_USER_NAME,
+    GIT_USER_EMAIL: GIT_USER_EMAIL || GITLAB_USER_EMAIL,
+    GIT_DISABLE_SSL,
     BUMP_METHOD,
     WORKSPACES: pkg.workspaces || [],
     ...getCI()

package/src/semantic/core/conditional.js

@@ -23,9 +23,14 @@ export function fail(pluginConfig, context) {
 async function runAll(step, pluginConfig, context, defaultCondition) {
   context.config = getConfig();
 
-  const condition = pluginConfig.when !== undefined ? pluginConfig.if(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,14 @@
+import { getConfig } from "../../common/index.js";
+
+export default async function exit(pluginConfig, context) {
+  context.config = getConfig();
+  const condition = pluginConfig.when !== undefined ? pluginConfig.when(context) : true;
+
+  if (condition) {
+    // 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);
+  } else {
+    context.logger.success("Continue next semantic-release steps");
+  }
+}

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