feat!: support stable release branch names

src/util/branch-name.ts

@@ -0,0 +1,115 @@
+// Copyright 2021 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+type BranchNameType = typeof BranchName;
+
+function getAllResourceNames(): BranchNameType[] {
+  return [AutoreleaseBranchName, ComponentBranchName, DefaultBranchName];
+}
+
+export class BranchName {
+  component?: string;
+  targetBranch?: string;
+  version?: string;
+
+  static parse(branchName: string): BranchName | undefined {
+    const branchNameClass = getAllResourceNames().find(clazz => {
+      return clazz.matches(branchName);
+    });
+    if (!branchNameClass) {
+      return undefined;
+    }
+    return new branchNameClass(branchName);
+  }
+  static ofComponentVersion(branchPrefix: string, version: string): BranchName {
+    return new AutoreleaseBranchName(`release-${branchPrefix}-v${version}`);
+  }
+  static ofVersion(version: string): BranchName {
+    return new AutoreleaseBranchName(`release-v${version}`);
+  }
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  constructor(branchName: string) {}
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  static matches(branchName: string): boolean {
+    return false;
+  }
+  getTargetBranch(): string | undefined {
+    return this.targetBranch;
+  }
+  getComponent(): string | undefined {
+    return this.component;
+  }
+  getVersion(): string | undefined {
+    return this.version;
+  }
+  toString(): string {
+    return '';
+  }
+}
+
+const AUTORELEASE_PATTERN = /^release-?([\w-.]*)?-v([0-9].*)$/;
+class AutoreleaseBranchName extends BranchName {
+  static matches(branchName: string): boolean {
+    return !!branchName.match(AUTORELEASE_PATTERN);
+  }
+  constructor(branchName: string) {
+    super(branchName);
+    const match = branchName.match(AUTORELEASE_PATTERN);
+    if (match) {
+      this.component = match[1];
+      this.version = match[2];
+    }
+  }
+  toString(): string {
+    if (this.component) {
+      return `release-${this.component}-v${this.version}`;
+    }
+    return `release-v${this.version}`;
+  }
+}
+
+const DEFAULT_PATTERN = /^release-please\/branches\/([^/]+)$/;
+class DefaultBranchName extends BranchName {
+  static matches(branchName: string): boolean {
+    return !!branchName.match(DEFAULT_PATTERN);
+  }
+  constructor(branchName: string) {
+    super(branchName);
+    const match = branchName.match(DEFAULT_PATTERN);
+    if (match) {
+      this.targetBranch = match[1];
+    }
+  }
+  toString(): string {
+    return `release-please/branches/${this.targetBranch}`;
+  }
+}
+
+const COMPONENT_PATTERN = /^release-please\/branches\/([^/]+)\/components\/([^/]+)$/;
+class ComponentBranchName extends BranchName {
+  static matches(branchName: string): boolean {
+    return !!branchName.match(COMPONENT_PATTERN);
+  }
+  constructor(branchName: string) {
+    super(branchName);
+    const match = branchName.match(COMPONENT_PATTERN);
+    if (match) {
+      this.targetBranch = match[1];
+      this.component = match[2];
+    }
+  }
+  toString(): string {
+    return `release-please/branches/${this.targetBranch}/components/${this.component}`;
+  }
+}

test/util/branch-name.ts

@@ -0,0 +1,78 @@
+// Copyright 2021 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+import {BranchName} from '../../src/util/branch-name';
+import {describe, it} from 'mocha';
+import {expect} from 'chai';
+
+describe('BranchName', () => {
+  describe('parse', () => {
+    describe('autorelease branch name', () => {
+      it('parses a versioned branch name', () => {
+        const name = 'release-v1.2.3';
+        const branchName = BranchName.parse(name);
+        expect(branchName).to.not.be.undefined;
+        expect(branchName?.getTargetBranch()).to.be.undefined;
+        expect(branchName?.getComponent()).to.be.undefined;
+        expect(branchName?.getVersion()).to.eql('1.2.3');
+        expect(branchName?.toString()).to.eql(name);
+      });
+      it('parses a versioned branch name with component', () => {
+        const name = 'release-storage-v1.2.3';
+        const branchName = BranchName.parse(name);
+        expect(branchName).to.not.be.undefined;
+        expect(branchName?.getTargetBranch()).to.be.undefined;
+        expect(branchName?.getComponent()).to.eql('storage');
+        expect(branchName?.getVersion()).to.eql('1.2.3');
+        expect(branchName?.toString()).to.eql(name);
+      });
+    });
+    it('parses a target branch', () => {
+      const name = 'release-please/branches/main';
+      const branchName = BranchName.parse(name);
+      expect(branchName).to.not.be.undefined;
+      expect(branchName?.getTargetBranch()).to.eql('main');
+      expect(branchName?.getComponent()).to.be.undefined;
+      expect(branchName?.getVersion()).to.be.undefined;
+      expect(branchName?.toString()).to.eql(name);
+    });
+
+    it('parses a target branch and component', () => {
+      const name = 'release-please/branches/main/components/storage';
+      const branchName = BranchName.parse(name);
+      expect(branchName).to.not.be.undefined;
+      expect(branchName?.getTargetBranch()).to.eql('main');
+      expect(branchName?.getComponent()).to.eql('storage');
+      expect(branchName?.getVersion()).to.be.undefined;
+      expect(branchName?.toString()).to.eql(name);
+    });
+
+    it('fails to parse', () => {
+      const branchName = BranchName.parse('release-foo');
+      expect(branchName).to.be.undefined;
+    });
+  });
+  describe('ofVersion', () => {
+    it('builds the autorelease versioned branch name', () => {
+      const branchName = BranchName.ofVersion('1.2.3');
+      expect(branchName.toString()).to.eql('release-v1.2.3');
+    });
+  });
+  describe('ofComponentVersion', () => {
+    it('builds the autorelease versioned branch name with component', () => {
+      const branchName = BranchName.ofComponentVersion('storage', '1.2.3');
+      expect(branchName.toString()).to.eql('release-storage-v1.2.3');
+    });
+  });
+});