@cmflow/cli 2.0.0-alpha.2 → 2.0.0-alpha.4

package/README.md

@@ -95,7 +95,6 @@ export default defineConfig({
     ]
   ],
   success: [
-    '@cmflow/cli/semantic/success',
     [
       '@cmflow/cli/semantic/conditional',
       {
@@ -106,6 +105,7 @@ export default defineConfig({
   ],
   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
@@ -165,6 +165,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`:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cmflow/cli",
-  "version": "2.0.0-alpha.2",
+  "version": "2.0.0-alpha.4",
   "description": "An awesome Git Flow",
   "author": "camfou",
   "license": "MIT",
@@ -26,10 +26,10 @@
     "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/prepare/*": "./src/semantic/core/prepare/*.js",
+    "./semantic/*": "./src/semantic/core/*.js",
+    "./semantic/docker/*": "./src/semantic/docker/*.js"
   },
   "dependencies": {
     "@semantic-release/release-notes-generator": ">=14.0.3",

package/src/semantic/core/conditional.js

@@ -1,4 +1,9 @@
 import { getConfig } from "../../common/index.js";
+
+export function prepare(pluginConfig, context) {
+  return runAll(pluginConfig, context, context.branch?.type === "release");
+}
+
 export function success(pluginConfig, context) {
   return runAll(pluginConfig, context, context.branch?.type === "release");
 }

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

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