@cmflow/cli 1.1.0 → 2.0.0-alpha.1

package/.prettierignore

@@ -0,0 +1,5 @@
+dist
+docs
+node_modules
+*-lock.json
+*.lock

package/.prettierrc

@@ -0,0 +1,10 @@
+{
+  "singleQuote": false,
+  "jsxSingleQuote": false,
+  "semi": true,
+  "tabWidth": 2,
+  "bracketSpacing": true,
+  "arrowParens": "always",
+  "printWidth": 140,
+  "trailingComma": "none"
+}

package/README.md

@@ -16,7 +16,7 @@
 npm i -g @cmflow/cli
  ```
 
-## CmFlow release
+## CmFlow release using Semantic Release
 ### Installation
 
 CmFlow is compatible with [semantic-release](https://github.com/semantic-release/semantic-release) 📦🚀. You can use
@@ -24,20 +24,80 @@ CmFlow release to deploy your projects based on CmFlow convention.
 
 Add the cmflow to your project:
 
-```
+```sh
 npm i --save-dev @cmflow/cli
 ```
 
+Edit your `package.json` and add the following configuration:
+
+```json
+{
+  "flow": {
+    "branch": {
+      "develop": "master",
+      "production": "master"
+    }
+  }
+}
+```
+
 Then create `release.config.js` with this configuration:
 
 ```javascript
-const { getSemanticConfig } = require('@cmflow/cli')
-
-module.exports = {
-  ...getSemanticConfig(),
-  // Additional semantic configuration props
+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'],
+  generateNotes: ['@cmflow/cli/semantic/generate-notes'],
+  prepare: [
+    '@cmflow/cli/semantic/prepare/bump-version',
+    [
+      '@cmflow/cli/semantic/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
+      {
+        command: 'test_e2e'
+      }
+    ],
+    '@cmflow/cli/semantif/prepare/post'
+  ],
+  publish: [
+    [
+      '@cmflow/cli/semantic/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
+      }
+    ]
+  ],
+  success: [
+    '@cmflow/cli/semantic/success',
+    [
+      '@cmflow/cli/semantic/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
+      }
+    ]
+  ],
+  fail: [
+    '@cmflow/cli/semantic/fail',
+    [
+      '@cmflow/cli/semantic/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
+      }
+    ]
+  ],
   npmPublish: false
-}
+})
 ```
 
 Then edit your `package.json` add the following tasks on script property:
@@ -53,9 +113,28 @@ 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 deploy process. It's useful when you want to
+CmFlow release are able to run `build` and `test_e2e` task during the prepare step. It's useful when you want to
 deploy a docker image on docker hub with the right revision number in the `package.json`. The only requirement, is to
 have a `build` and `test_e2e` tasks in you npm scripts.
 
@@ -70,19 +149,42 @@ Example:
 }
 ```
 
-### Generate changelog
+### Deploy on Docker Hub
 
-CmFlow release call also a npm task `build_changelog` to let you generate the changelog file with your preferred tool.
+Add the following configuration to your `release.config.js`:
 
-Example:
+```js
+import { defineConfig } from '@cmflow/cli'
 
-```json
-{
-  "scripts": {
-    "build_changelog": "conventional-changelog --preset angular --release-count 0 --outfile ./CHANGELOG.md",
-    "build_changelog": "cmchangelog"
-  }
-}
+export default defineConfig({
+  publish: [
+    [
+      '@cmflow/cli/semantic/conditional',
+      {
+        run: '@semantic-release/github'
+      }
+    ],
+    '@cmflow/cli/semantic/docker/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'
+  ]
+});
 ```
 
 ### Configure CI
@@ -90,17 +192,13 @@ Example:
 CmFlow release can be used with Travis CI, Circle CI and GitLab. You have to create these environments variables to
 allow git release note deployment, commit push and docker image deployment.
 
-| Variable            | Description                                                                                                               |
-|---------------------|---------------------------------------------------------------------------------------------------------------------------|
-| PROJECT_NAME        | The project to publish artifact on docker                                                                                 |
-| GH_TOKEN            | A GitHub [personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line). |
-| GIT_USER_EMAIL      | User mail to sign the commit produced by CmFlow release                                                                   |
-| GIT_USER_NAME       | User name to sign the commit produced by CmFlow release                                                                   |
-| DEPLOY_ON_DOCKER    | Set 1 to deploy on docker                                                                                                 |
-| DOCKER_HUB_ID       | The docker hub id                                                                                                         |
-| DOCKER_HUB_PWD      | The docker password account                                                                                               |
-| HEROKU_APP          | Enable deployment on heroku. Note: You have to configure HEROKU_API_KEY token on your CI                                  |
-| SKIP_DEPLOY         | Skip all deployment task (docker, heroku).                                                                                |
-| SKIP_GITHUB_PUBLISH | Skip tag and release note publication on Github.                                                                          |
-| GITHUB_PAGES_PATH   | Path to the front-end artifact. Enable github pages deployment.                                                           |
+| Variable               | Description                                                                                                                     |
+|------------------------|---------------------------------------------------------------------------------------------------------------------------------|
+| PROJECT_NAME           | The project to publish artifact on docker                                                                                       |
+| SCM_TOKEN              | A SCM Token (GH_TOKEN or GITLAB_TOKEN)                                                                                          |
+| GH_TOKEN  (deprecated) | A GitHub token [personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line). |
+| GIT_USER_EMAIL         | User mail to sign the commit produced by CmFlow release                                                                         |
+| GIT_USER_NAME          | User name to sign the commit produced by CmFlow release                                                                         |
+| DOCKER_HUB_ID          | The docker hub id                                                                                                               |
+| DOCKER_HUB_PWD         | The docker password account                                                                                                     |
 

package/bin/cm-changelog.js

@@ -1,18 +1,26 @@
 #!/usr/bin/env node
 
-import commander from 'commander'
+import commander from "commander";
 
-import { commands, runCommand } from '../src/index.js'
+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)
+  .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)
+runCommand(commands.Changelog, commander);

package/bin/cm-clean.js

@@ -1,11 +1,8 @@
 #!/usr/bin/env node
-import commander from 'commander'
+import commander from "commander";
 
-import { commands, runCommand } from '../src/index.js'
+import { commands, runCommand } from "../src/index.js";
 
-commander
-  .usage('cmclean <action> options]')
-  .alias('cm clean')
-  .parse(process.argv)
+commander.usage("cmclean <action> options]").alias("cm clean").parse(process.argv);
 
-runCommand(commands.Clean, commander)
+runCommand(commands.Clean, commander);

package/bin/cm-config.js

@@ -1,15 +1,15 @@
 #!/usr/bin/env node
-import { commands, release, runCommand } from '../src/index.js'
+import commander from "commander";
 
-import commander from 'commander'
+import { commands, release, runCommand } from "../src/index.js";
 
 commander
-  .usage('cmconfig')
-  .alias('cm config')
-  .option('-v, --verbose', 'Enable verbose log', (v, t) => t + 1, 0)
-  .parse(process.argv)
+  .usage("cmconfig")
+  .alias("cm config")
+  .option("-v, --verbose", "Enable verbose log", (v, t) => t + 1, 0)
+  .parse(process.argv);
 
 runCommand(commands.Config, {
   verbose: commander.verbose
-})
-release()
+});
+release();

package/bin/cm-deploy.js

@@ -1,12 +1,8 @@
 #!/usr/bin/env node
-import commander from 'commander'
+import commander from "commander";
 
-import { commands, runCommand } from '../src/index.js'
+import { commands, runCommand } from "../src/index.js";
 
-commander
-  .usage('cmdeploy [options]')
-  .alias('cm deploy')
-  .option('-t, --target <target>', 'Deploy on docker hub/Heroku (docker, heroku)')
-  .parse(process.argv)
+commander.usage("cmdeploy [options]").alias("cm deploy").option("-t, --target <target>", "Deploy on docker hub").parse(process.argv);
 
-runCommand(commands.Deploy, commander)
+runCommand(commands.Deploy, commander);

package/bin/cm-fetch.js

@@ -1,12 +1,12 @@
 #!/usr/bin/env node
-import commander from 'commander'
+import commander from "commander";
 
-import { commands, runCommand } from '../src/index.js'
+import { commands, runCommand } from "../src/index.js";
 
 commander
-  .usage('cmfetch [options]')
-  .alias('cm fetch')
-  .option('-v, --verbose', 'Enable verbose log', (v, t) => t + 1, 0)
-  .parse(process.argv)
+  .usage("cmfetch [options]")
+  .alias("cm fetch")
+  .option("-v, --verbose", "Enable verbose log", (v, t) => t + 1, 0)
+  .parse(process.argv);
 
-runCommand(commands.Fetch, commander)
+runCommand(commands.Fetch, commander);

package/bin/cm-finish.js

@@ -1,14 +1,14 @@
 #!/usr/bin/env node
-import commander from 'commander'
+import commander from "commander";
 
-import { commands, runCommand } from '../src/index.js'
+import { commands, runCommand } from "../src/index.js";
 
 commander
-  .usage('cmfinish [options]')
-  .alias('cm finish')
-  .option('-t, --unit-test', 'Run unit test', (v, t) => t + 1, 0)
-  .option('-c, --cucumber', 'Run cucumber', (v, t) => t + 1, 0)
-  .option('-v, --verbose', 'Enable verbose log', (v, t) => t + 1, 0)
-  .parse(process.argv)
+  .usage("cmfinish [options]")
+  .alias("cm finish")
+  .option("-t, --unit-test", "Run unit test", (v, t) => t + 1, 0)
+  .option("-c, --cucumber", "Run cucumber", (v, t) => t + 1, 0)
+  .option("-v, --verbose", "Enable verbose log", (v, t) => t + 1, 0)
+  .parse(process.argv);
 
-runCommand(commands.Finish, commander)
+runCommand(commands.Finish, commander);

package/bin/cm-merge.js

@@ -1,12 +1,12 @@
 #!/usr/bin/env node
-import commander from 'commander'
+import commander from "commander";
 
-import { commands, runCommand } from '../src/index.js'
+import { commands, runCommand } from "../src/index.js";
 
 commander
-  .usage('cmmerge')
-  .alias('cm merge')
-  .option('-v, --verbose', 'Enable verbose log', (v, t) => t + 1, 0)
-  .parse(process.argv)
+  .usage("cmmerge")
+  .alias("cm merge")
+  .option("-v, --verbose", "Enable verbose log", (v, t) => t + 1, 0)
+  .parse(process.argv);
 
-runCommand(commands.Merge, commander)
+runCommand(commands.Merge, commander);

package/bin/cm-publish.js

@@ -1,15 +1,15 @@
 #!/usr/bin/env node
-import { commands, runCommand } from '../src/index.js'
+import commander from "commander";
 
-import commander from 'commander'
+import { commands, runCommand } from "../src/index.js";
 
 commander
-  .usage('cmpublish [options]')
-  .alias('cm publish')
-  .option('-t, --unit-test', 'Run unit test', (v, t) => t + 1, 0)
-  .option('-c, --cucumber', 'Run cucumber', (v, t) => t + 1, 0)
-  .option('-f, --force', 'Force push', (v, t) => t + 1, 0)
-  .option('-v, --verbose', 'Enable verbose log', (v, t) => t + 1, 0)
-  .parse(process.argv)
+  .usage("cmpublish [options]")
+  .alias("cm publish")
+  .option("-t, --unit-test", "Run unit test", (v, t) => t + 1, 0)
+  .option("-c, --cucumber", "Run cucumber", (v, t) => t + 1, 0)
+  .option("-f, --force", "Force push", (v, t) => t + 1, 0)
+  .option("-v, --verbose", "Enable verbose log", (v, t) => t + 1, 0)
+  .parse(process.argv);
 
-runCommand(commands.Push, commander)
+runCommand(commands.Push, commander);

package/bin/cm-push.js

@@ -1,15 +1,15 @@
 #!/usr/bin/env node
-import commander from 'commander'
+import commander from "commander";
 
-import { commands, runCommand } from '../src/index.js'
+import { commands, runCommand } from "../src/index.js";
 
 commander
-  .usage('cmpush [options]')
-  .alias('cm push')
-  .option('-t, --unit-test', 'Run unit test', (v, t) => t + 1, 0)
-  .option('-c, --cucumber', 'Run cucumber', (v, t) => t + 1, 0)
-  .option('-f, --force', 'Force push', (v, t) => t + 1, 0)
-  .option('-v, --verbose', 'Enable verbose log', (v, t) => t + 1, 0)
-  .parse(process.argv)
+  .usage("cmpush [options]")
+  .alias("cm push")
+  .option("-t, --unit-test", "Run unit test", (v, t) => t + 1, 0)
+  .option("-c, --cucumber", "Run cucumber", (v, t) => t + 1, 0)
+  .option("-f, --force", "Force push", (v, t) => t + 1, 0)
+  .option("-v, --verbose", "Enable verbose log", (v, t) => t + 1, 0)
+  .parse(process.argv);
 
-runCommand(commands.Push, commander)
+runCommand(commands.Push, commander);

package/bin/cm-rebase.js

@@ -1,15 +1,15 @@
 #!/usr/bin/env node
-import commander from 'commander'
+import commander from "commander";
 
-import { commands, runCommand } from '../src/index.js'
+import { commands, runCommand } from "../src/index.js";
 
 commander
-  .usage('cmrebase [options]')
-  .alias('cm rebase')
-  .option('-t, --unit-test', 'Run unit test', (v, t) => t + 1, 0)
-  .option('-c, --cucumber', 'Run cucumber', (v, t) => t + 1, 0)
-  .option('-f, --force', 'Force push', (v, t) => t + 1, 0)
-  .option('-v, --verbose', 'Enable verbose log', (v, t) => t + 1, 0)
-  .parse(process.argv)
+  .usage("cmrebase [options]")
+  .alias("cm rebase")
+  .option("-t, --unit-test", "Run unit test", (v, t) => t + 1, 0)
+  .option("-c, --cucumber", "Run cucumber", (v, t) => t + 1, 0)
+  .option("-f, --force", "Force push", (v, t) => t + 1, 0)
+  .option("-v, --verbose", "Enable verbose log", (v, t) => t + 1, 0)
+  .parse(process.argv);
 
-runCommand(commands.Rebase, commander)
+runCommand(commands.Rebase, commander);

package/bin/cm-republish.js

@@ -1,12 +1,12 @@
 #!/usr/bin/env node
-import { commands, runCommand } from '../src/index.js'
+import commander from "commander";
 
-import commander from 'commander'
+import { commands, runCommand } from "../src/index.js";
 
 commander
-  .usage('cmrepublish [options]')
-  .alias('cm republish')
-  .option('-v, --verbose', 'Enable verbose log', (v, t) => t + 1, 0)
-  .parse(process.argv)
+  .usage("cmrepublish [options]")
+  .alias("cm republish")
+  .option("-v, --verbose", "Enable verbose log", (v, t) => t + 1, 0)
+  .parse(process.argv);
 
-runCommand(commands.Republish, commander)
+runCommand(commands.Republish, commander);

package/bin/cm-start.js

@@ -1,21 +1,21 @@
 #!/usr/bin/env node
-import commander from 'commander'
+import commander from "commander";
 
-import { commands, runCommand } from '../src/index.js'
+import { commands, runCommand } from "../src/index.js";
 
-const options = {}
+const options = {};
 
 commander
-  .usage('cmstart [jiraId] [branchName]')
-  .arguments('[jiraId] [branchName]')
-  .alias('cm start')
-  .option('-v, --verbose', 'Enable verbose log', (v, t) => t + 1, 0)
+  .usage("cmstart [jiraId] [branchName]")
+  .arguments("[jiraId] [branchName]")
+  .alias("cm start")
+  .option("-v, --verbose", "Enable verbose log", (v, t) => t + 1, 0)
   .action((branchName) => {
-    options.branchName = branchName
+    options.branchName = branchName;
   })
-  .parse(process.argv)
+  .parse(process.argv);
 
 runCommand(commands.Start, {
   ...options,
   verbose: commander.verbose
-})
+});

package/bin/cm.js

@@ -1,26 +1,26 @@
 #!/usr/bin/env node
 
-import commander from 'commander'
-import fs from 'fs-extra'
-import url from 'url'
-import path from 'path'
+import commander from "commander";
+import fs from "fs-extra";
+import path from "path";
+import url from "url";
 
-const __dirname = url.fileURLToPath(new URL('.', import.meta.url))
-const cliPkg = fs.readJsonSync(path.join(__dirname, '../package.json'))
+const __dirname = url.fileURLToPath(new URL(".", import.meta.url));
+const cliPkg = fs.readJsonSync(path.join(__dirname, "../package.json"));
 
 commander
   .version(cliPkg.version)
-  .command('finish', 'Rebase the branch, add [MEP] tag on latest commit and push it')
-  .command('changelog', 'Update changelog file for the project')
-  .command('start', 'Create a new branch from the latest commit of production branch')
-  .command('push', 'Rebase the current branch from production and push all commit')
-  .command('publish', 'Rebase the current branch from production and push all commit (alias of cm push)')
-  .command('republish', 'Rebase all branches from production')
-  .command('publish-pages', 'Publish github pages')
-  .command('deploy', 'Deploy app on docker hub/Heroku')
-  .command('rebase', 'Rebase the current branch from production')
-  .command('merge', 'Merge current branch into PRODUCTION_BRANCH')
-  .command('fetch', 'Download objects and refs from repository (--all and --prune)')
-  .command('clean', 'Clean deployed docker image on Docker hub')
-  .command('config', 'Configure git workspace with expected information')
-  .parse(process.argv)
+  .command("finish", "Rebase the branch, add [MEP] tag on latest commit and push it")
+  .command("changelog", "Update changelog file for the project")
+  .command("start", "Create a new branch from the latest commit of production branch")
+  .command("push", "Rebase the current branch from production and push all commit")
+  .command("publish", "Rebase the current branch from production and push all commit (alias of cm push)")
+  .command("republish", "Rebase all branches from production")
+  .command("publish-pages", "Publish github pages")
+  .command("deploy", "Deploy app on docker hub/Heroku")
+  .command("rebase", "Rebase the current branch from production")
+  .command("merge", "Merge current branch into PRODUCTION_BRANCH")
+  .command("fetch", "Download objects and refs from repository (--all and --prune)")
+  .command("clean", "Clean deployed docker image on Docker hub")
+  .command("config", "Configure git workspace with expected information")
+  .parse(process.argv);

package/bin/cmrelease.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
 
-import { release } from '../src/index.js'
+import { release } from "../src/index.js";
 
-release()
+release();