refactor: refactor release

Author: zdm

lib/package/release.js

@@ -22,6 +22,7 @@ export default class Publish {
     #previousRelease;
     #currentRelease;
     #isMajorRelease;
+    #originalBranch;
     #currentBranch;
     #previousBranch;
     #changelog;
@@ -63,29 +64,45 @@ export default class Publish {
         // package is not releasable
         if ( !this.#pkg.isReleaseEnabled ) return result( [ 500, "Package release is disabled" ] );
 
-        // get changelog
-        res = await this.getChangelog();
-        if ( !res.ok ) return res;
-
         // get git status
         res = await this.#pkg.git.getStatus();
         if ( !res.ok ) return res;
         const status = res.data;
 
+        // check for uncommited changes
+        if ( status.isDirty ) return result( [ 500, "working copy or sub-repositories has uncommited changes or untracked files" ] );
+
+        // get changelog
+        res = await this.getChangelog();
+        if ( !res.ok ) return res;
+
         this.#previousBranch = `v${ this.#previousRelease?.majorNumber || "0" }.x`;
 
-        // check branch
+        // detached head
         if ( !status.head.isBranchHead ) {
             return result( [ 500, "Release on tbe detached head is not possible" ] );
         }
-        else {
-            if ( status.head.branch !== this.#previousBranch ) {
-                return result( [ 500, `You should be on the release branch "${ this.#previousBranch }" to make this release` ] );
+
+        // not a release branch head
+        else if ( status.head.branch !== this.#previousBranch ) {
+            this.#originalBranch = status.head.branch;
+
+            // check allowed branch
+            if ( this.#pkg.cliConfig?.release.allowedBranches && !this.#pkg.cliConfig.release.allowedBranches.includes( this.#originalBranch ) ) {
+                return result( [ 500, "Unable to create release from the current branch" ] );
             }
-        }
 
-        // check for uncommited changes
-        if ( status.isDirty ) return result( [ 500, "working copy or sub-repositories has uncommited changes or untracked files" ] );
+            // previous release commit must be a branch head for the previous branch
+            if ( this.#previousRelease ) {
+                res = await this.#pkg.git.getCommit( { "commitRef": this.#previousRelease.versionString } );
+                if ( !res.ok ) return res;
+                const previousReleaseCommit = res.data;
+
+                if ( !previousReleaseCommit.branches.has( this.#previousBranch ) ) {
+                    return result( [ 500, `Release "${ this.#previousRelease.versionString }" must be a release branch "${ this.#previousBranch }" head` ] );
+                }
+            }
+        }
 
         // create new version
         res = this.#changelog.getNextVersion( this.#stable
@@ -206,7 +223,26 @@ export default class Publish {
             }
         }
 
-        // major release
+        // prepare release branch
+        if ( this.#originalBranch ) {
+
+            // merge the previous release branch with the original branch
+            if ( this.#previousRelease ) {
+                res = await this.#pkg.git.exec( [ "switch", this.#previousBranch ] );
+                if ( !res.ok ) return res;
+
+                res = await this.#pkg.git.exec( [ "merge", "--no-edit", "--quiet", "--ff-only", this.#originalBranch ] );
+                if ( !res.ok ) return res;
+            }
+
+            // create release branch
+            else {
+                res = await this.#pkg.git.exec( [ "switch", "--create", this.#previousBranch ] );
+                if ( !res.ok ) return res;
+            }
+        }
+
+        // prepare major release
         if ( this.#isMajorRelease ) {
 
             // create and switch major release branch
@@ -292,11 +328,11 @@ export default class Publish {
         // push, if has upstream
         if ( this.#pkg.git.upstream ) {
 
-            // track current branch
+            // track current release branch
             if ( this.#isMajorRelease ) {
                 res = await repeatAction(
                     async () => {
-                        process.stdout.write( `Setting upstream for branch "${ this.#currentBranch }" ... ` );
+                        process.stdout.write( `Setting upstream for the branch "${ this.#currentBranch }" ... ` );
 
                         const params = [
 
@@ -415,6 +451,26 @@ export default class Publish {
             }
         }
 
+        // restore original branch state
+        if ( this.#originalBranch ) {
+            res = await this.#pkg.git.exec( [ "switch", this.#originalBranch ] );
+            if ( !res.ok ) return res;
+
+            res = await this.#pkg.git.exec( [ "merge", "--no-edit", "--quiet", "--ff-only", this.#currentBranch ] );
+            if ( !res.ok ) return res;
+
+            if ( this.#pkg.git.upstream ) {
+                res = await this.#pkg.git.exec( [ "config", "--get", `branch.${ this.#originalBranch }.remote` ] );
+                if ( !res.ok ) return res;
+
+                // push, if original branch is tracked
+                if ( res.data ) {
+                    res = await this.#pkg.git.exec( [ "push" ] );
+                    if ( !res.ok ) return res;
+                }
+            }
+        }
+
         return result( 200 );
     }
 

resources/cli.config.yaml

@@ -53,6 +53,7 @@ meta:
 release:
   enabled: false
   allowMajorTag: false
+  allowedBranches: [main]
 
 docker:
   composeFile: compose.yaml

resources/schemas/cli.config.schema.yaml

@@ -110,8 +110,12 @@ properties:
     properties:
       enabled: { type: boolean }
       allowMajorTag: { type: boolean }
+      allowedBranches:
+        anyOf:
+          - type: "null"
+          - { type: array, items: { type: string }, minItems: 1, uniqueItems: true }
     additionalProperties: false
-    required: [enabled, allowMajorTag]
+    required: [enabled, allowMajorTag, allowedBranches]
 
   docker:
     type: object