Merge branch 'main' into #56-copilot-setup-steps

Author: mumenthalers

.github/workflows/main.yml

@@ -93,6 +93,9 @@ jobs:
       # build lint plugins before linting
       - name: Build lint plugins
         run: npm run build:lint:ci
+      # check formatting
+      - name: Check Formatting
+        run: npm run format:ci
       # lint
       - name: Lint
         run: npm run lint:ci

package-lock.json

@@ -11,9 +11,10 @@
   "scripts": {
     "build:ci": "lerna run build",
     "build:lint:ci": "lerna run build:lint:ci",
+    "format": "lerna run format",
+    "format:ci": "lerna run format:ci",
     "lint:ci": "lerna run lint:ci",
     "prepare": "husky",
-    "prettier": "lerna run prettier",
     "publish-libs": "node packages/publish-helper/dist/publish-lib",
     "test:ci": "lerna run test:ci"
   },

package.json

@@ -1,7 +1,6 @@
-# we use eslint instead of ng lint, because we can't use --project (tsconfig specifying files with include, exclude)
-# and --files argument pointing to other files
-src/{**/,}*.ts,test/{**/,}*.ts:
-  - npm run prettier:staged
+# Reformat all .ts / .js
+"**/*.(t|j)s":
+  - npm run format:staged
   - npm run lint:staged
 
 # sort package.json keys

packages/branch-utilities/.lintstagedrc.yml

@@ -3,6 +3,20 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [5.0.1](https://github.com/shiftcode/sc-commons-public/compare/@shiftcode/[email protected]...@shiftcode/[email protected]) (2025-09-09)
+
+**Note:** Version bump only for package @shiftcode/branch-utilities
+
+# [5.0.0](https://github.com/shiftcode/sc-commons-public/compare/@shiftcode/[email protected]...@shiftcode/[email protected]) (2025-09-04)
+
+### Features
+
+- **branch-utilities:** support naming convention for github copilot branch names ([56dbb58](https://github.com/shiftcode/sc-commons-public/commit/56dbb5846397601a6dc2c238d4b4a828604cb7f1))
+
+### BREAKING CHANGES
+
+- **branch-utilities:** REGEX_BRANCH_NAME is no longer exported. use the utility function `parseBranchName` instead
+
 # [4.0.0](https://github.com/shiftcode/sc-commons-public/compare/@shiftcode/[email protected]...@shiftcode/[email protected]) (2025-05-15)
 
 ### Features

packages/branch-utilities/CHANGELOG.md

@@ -1,6 +1,6 @@
 {
   "name": "@shiftcode/branch-utilities",
-  "version": "4.0.0",
+  "version": "5.0.1",
   "description": "Utilities for local and ci to get branch name and stage",
   "repository": "https://github.com/shiftcode/sc-commons-public",
   "license": "MIT",
@@ -16,13 +16,15 @@
   "scripts": {
     "prebuild": "rm -rf ./dist",
     "build": "tsc",
+    "format": "npm run format:base -- --write",
+    "format:base": "prettier --config ../../.prettierrc.yml '{src,e2e,test}/**/*.ts'",
+    "format:ci": "npm run format:base -- --check",
+    "format:staged": "prettier --write --config ../../.prettierrc.yml",
     "lint": "npm run lint:src:fix",
     "lint:ci": "npm run lint:src",
     "lint:src": "eslint ./src",
     "lint:src:fix": "eslint ./src --cache --fix",
     "lint:staged": "eslint --fix --cache",
-    "prettier": "prettier --write --config ../../.prettierrc.yml '{src,e2e,test}/**/*.ts'",
-    "prettier:staged": "prettier --write --config ../../.prettierrc.yml",
     "prepublish": "node ../publish-helper/dist/prepare-dist.js",
     "test": "NODE_OPTIONS=\"--experimental-vm-modules --trace-warnings\" npx jest --config jest.config.js",
     "test:ci": "npm run test",

packages/branch-utilities/package.json

@@ -82,13 +82,31 @@ describe('base utils', () => {
 
   describe('parseBranchName', () => {
     test('works when valid pattern', () => {
-      expect(parseBranchName('#7-abc').branchId).toBe(7)
+      expect(parseBranchName('#7-abc')).toEqual({ branchId: 7, branchName: 'abc' } satisfies ReturnType<
+        typeof parseBranchName
+      >)
+
       expect(parseBranchName('#72-abc').branchId).toBe(72)
+      expect(parseBranchName('#000-int').branchId).toBe(0)
+      expect(parseBranchName('#001-test').branchId).toBe(1)
+
       expect(parseBranchName('#72- whatever').branchId).toBe(72)
       expect(parseBranchName('feature/#72-ok').branchId).toBe(72)
     })
+
+    test('works for github copilot created branches', () => {
+      expect(parseBranchName('copilot/fix-123')).toEqual({ branchId: 123, branchName: 'fix' } satisfies ReturnType<
+        typeof parseBranchName
+      >)
+      expect(parseBranchName('copilot/feat-123')).toEqual({ branchId: 123, branchName: 'feat' } satisfies ReturnType<
+        typeof parseBranchName
+      >)
+    })
+
     test('throws when invalid pattern', () => {
       expect(() => parseBranchName('whrjwe')).toThrow()
+      expect(() => parseBranchName('copilot/123-fix')).toThrow()
+      expect(() => parseBranchName('feat/copilot/fix-123')).toThrow()
     })
   })
 })

packages/branch-utilities/src/lib/base.utils.spec.ts

@@ -8,8 +8,17 @@ export const REGEX_MASTER = /^master$/
 /** regex to match the main branch */
 export const REGEX_MAIN = /^main$/
 
-/** regex to match our branch conventions with the following capture groups: fullMatch / branch id / branch name */
-export const REGEX_BRANCH_NAME = /^[a-z]*\/?#(\d+)-(.*)/
+/**
+ * regex to match our branch conventions with the following named capture groups: id, name
+ * @example #123-my-feature ->  { id:  '123',  name: 'my-feature' }
+ * @example feature/#456-yanr -> { id:  '456',  name: 'yanr' }
+ */
+const REGEX_BRANCH_NAME_DEFAULT = /^[a-z]*\/?#(?<id>\d+)-(?<name>.*)$/
+/**
+ * regex to match the branch convention github copilot uses with the following named capture groups: id, name
+ * @example copilot/fix-789 -> { id:  '789',  name: 'fix' }
+ */
+const REGEX_BRANCH_NAME_COPILOT = /^copilot\/(?<name>.*)-(?<id>\d+)$/
 
 export interface StageInfo {
   isProd: boolean
@@ -81,9 +90,11 @@ export function getBranchInfo(env: unknown, branchName?: string): BranchInfo {
 }
 
 export function isFullBranchOverrideDefined(envVars: unknown): envVars is CustomScOverrideEnv {
-  return envVars !== null
-    && typeof (envVars as CustomScOverrideEnv).SC_OVERRIDE_BRANCH_NAME ==='string'
-    && typeof (envVars as CustomScOverrideEnv).SC_OVERRIDE_IS_PR ==='string'
+  return (
+    envVars !== null &&
+    typeof (envVars as CustomScOverrideEnv).SC_OVERRIDE_BRANCH_NAME === 'string' &&
+    typeof (envVars as CustomScOverrideEnv).SC_OVERRIDE_IS_PR === 'string'
+  )
 }
 
 export function getBranchNameOverride(env: CustomScOverrideEnv): string {
@@ -134,13 +145,11 @@ export function isMainBranch(branchName: string): boolean {
  * @throws Throws an error if given branchName does not match our convention
  */
 export function parseBranchName(branchName: string): { branchId: number; branchName: string } {
-  const matches = branchName.match(REGEX_BRANCH_NAME)
-  if (matches) {
-    // [0] full match / [1] branch id / [2] branch name
-    const [, branchId, branchN] = matches
+  const matches = REGEX_BRANCH_NAME_DEFAULT.exec(branchName) ?? REGEX_BRANCH_NAME_COPILOT.exec(branchName)
+  if (matches?.groups) {
     return {
-      branchId: parseInt(branchId, 10),
-      branchName: branchN,
+      branchId: parseInt(matches.groups['id'], 10),
+      branchName: matches.groups['name'],
     }
   } else {
     throw new Error(
@@ -156,7 +165,7 @@ export function parseBranchName(branchName: string): { branchId: number; branchN
  * @return returns true if the stage is 'master' or 'main', false if not
  */
 export function isProduction(stageName: string): boolean {
-  return REGEX_MASTER.test(stageName) || REGEX_MAIN.test(stageName)
+  return REGEX_MASTER.test(stageName) ?? REGEX_MAIN.test(stageName)
 }
 
 /**

packages/branch-utilities/src/lib/base.utils.ts

@@ -1,7 +1,6 @@
-# we use eslint instead of ng lint, because we can't use --project (tsconfig specifying files with include, exclude)
-# and --files argument pointing to other files
-src/{**/,}*.ts,test/{**/,}*.ts:
-  - npm run prettier:staged
+# Reformat all .ts / .js
+"**/*.(t|j)s":
+  - npm run format:staged
   - npm run lint:staged
 
 # sort package.json keys

packages/eslint-config-recommended/.lintstagedrc.yml

@@ -3,6 +3,10 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [5.0.1](https://github.com/shiftcode/sc-commons-public/compare/@shiftcode/[email protected]...@shiftcode/[email protected]) (2025-09-09)
+
+**Note:** Version bump only for package @shiftcode/eslint-config-recommended
+
 # [5.0.0](https://github.com/shiftcode/sc-commons-public/compare/@shiftcode/[email protected]...@shiftcode/[email protected]) (2025-06-30)
 
 ### Features