More monorepo updates (#1207)

Author: ecraig12345

.ado/publish.yml

@@ -42,10 +42,9 @@ extends:
 
     stages:
       - stage: main
-        displayName:
         jobs:
           - job: build
-            displayName: Build and test
+            displayName: Build, test, pack
             cancelTimeoutInMinutes: 45 # to allow more time to collect CodeQL debug info.
 
             pool:
@@ -76,8 +75,6 @@ extends:
                   version: '${{ variables.nodeVersion }}.x'
                   checkLatest: false
 
-              - script: npm i -g npm@${{ variables.npmVersion }}
-
               # For multiline scripts, we want the whole task to fail if any line of the script fails.
               # ADO doesn't have bash configured this way by default. To fix we override the SHELLOPTS built-in variable.
               # https://www.gnu.org/software/bash/manual/html_node/The-Set-Builtin.html
@@ -95,11 +92,13 @@ extends:
                 displayName: Show environment
 
               - script: yarn --frozen-lockfile
+                displayName: Install dependencies
+
+              - script: yarn build --verbose
+                displayName: Build
 
-              - script: yarn build
-              - script: yarn test:unit
-              - script: yarn test:func
-              - script: yarn test:e2e
+              - script: yarn test --verbose
+                displayName: Test
 
               # TODO: figure out if this should bump or not (currently does bump)
               - script: |

.ado/release.yml

@@ -15,13 +15,13 @@ resources:
             - main
 
   repositories:
-    - repository: CustomPipelineTemplates
+    - repository: OfficePipelineTemplates
       type: git
       name: 1ESPipelineTemplates/OfficePipelineTemplates
       ref: refs/tags/release
 
 extends:
-  template: v1/Office.Official.PipelineTemplate.yml@CustomPipelineTemplates
+  template: v1/Office.Official.PipelineTemplate.yml@OfficePipelineTemplates
   parameters:
     pool:
       name: Azure-Pipelines-1ESPT-ExDShared

.github/workflows/pr.yml

@@ -64,20 +64,16 @@ jobs:
 
       - run: yarn --frozen-lockfile
 
-      - run: yarn build
+      - run: yarn build --verbose
 
       - run: yarn checkchange --verbose
 
       - run: yarn format:check
         if: matrix.os == 'ubuntu-latest' && matrix.node == 14 && matrix.npm == 8
 
-      - run: yarn lint
+      - run: yarn lint:ci
 
-      - run: yarn test:unit
-
-      - run: yarn test:func
-
-      - run: yarn test:e2e
+      - run: yarn test --verbose
 
   # The docs have a separate installation using Node 22 due to needing newer dependencies
   docs:

.github/workflows/release.yml

@@ -44,14 +44,9 @@ jobs:
 
       - run: yarn --frozen-lockfile
 
-      - run: yarn build
+      - run: yarn build --verbose
 
-      - run: yarn test:unit
-
-      - run: yarn test:func
-
-      - name: yarn test:e2e (npm ${{ env.npmVersion }})
-        run: yarn test:e2e
+      - run: yarn test --verbose
 
       - name: Publish package
         run: |

.prettierignore

@@ -1,4 +1,5 @@
 *.log
+*.patch
 *.snap
 *.styl
 *.svg

CLAUDE.md

@@ -4,28 +4,49 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
 
 ## Overview
 
-Beachball is a CLI tool for automating semantic version bumping, changelog generation, and npm publishing in monorepos and single-package repos. It is a single-package TypeScript project (not a monorepo itself).
+Beachball is a CLI tool for automating semantic version bumping, changelog generation, and npm publishing in monorepos and single-package repos.
+
+## Monorepo structure
+
+- `packages/beachball`: `beachball` package
+- `scripts`: repo-internal scripts (`@microsoft/beachball-scripts`)
 
 ## Commands
 
-TODO: Beachball has been updated to a monorepo and this needs to be updated
+### Top-level
+
+These commands work at the top level of the monorepo.
+
+DO NOT run `jest` or `tsc` directly from the top level!
+
+| Task               | Command                 |
+| ------------------ | ----------------------- |
+| Build              | `yarn build`            |
+| Test               | `yarn test`             |
+| Lint (code + deps) | `yarn lint`             |
+| Lint code only     | `yarn lint:code`        |
+| Format             | `yarn format`           |
+| Update snapshots   | `yarn update-snapshots` |
+
+### Per-package commands
+
+These commands work in the `beachball` package and potentially other future packages.
 
 | Task                          | Command                         |
 | ----------------------------- | ------------------------------- |
 | Build                         | `yarn build`                    |
-| Watch mode                    | `yarn start`                    |
 | All tests in correct order    | `yarn test:all`                 |
 | Unit tests only               | `yarn test:unit`                |
 | Functional tests only         | `yarn test:func`                |
 | E2E tests only                | `yarn test:e2e`                 |
 | Single test file (wraps jest) | `yarn test <test path or name>` |
-| Lint (code + deps)            | `yarn lint`                     |
-| Lint code only                | `yarn lint:code`                |
-| Format                        | `yarn format`                   |
+| Lint                          | `yarn lint`                     |
 | Update snapshots              | `yarn update-snapshots`         |
 
 ## Architecture
 
+All these paths refer to the `beachball` package under `packages/beachball`.
+
 **Entry point:** `src/cli.ts` dispatches to commands: `check`, `change`, `bump`, `publish`, `canary`, `sync`, `init`, `config`.
 
 **Key modules:**
@@ -79,7 +100,7 @@ TODO: Beachball has been updated to a monorepo and this needs to be updated
 
 ### Test structure
 
-Three Jest projects:
+`packages/beachball` has three Jest projects:
 
 - **Unit** (`src/__tests__/`): Unit tests for individual functions (no filesystem)
 - **Functional** (`src/__functional__/`): Single-function tests with realistic setups, or unit-like tests which must run against the actual filesystem

beachball.config.js

@@ -1,9 +1,10 @@
 // @ts-check
-/** @type {Partial<import('./src/types/BeachballOptions').RepoOptions>}*/
+/** @type {Partial<import('./packages/beachball/src/types/BeachballOptions').RepoOptions>}*/
 const config = {
   branch: 'main',
   commit: false,
   disallowedChangeTypes: ['major'],
+  groupChanges: true,
   ignorePatterns: ['.*ignore', '.eslintrc.js', 'jest.*.js', 'src/__*/**'],
 };
 

change/change-f6eb2a6d-4609-4bed-841a-f6249e831fed.json

@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "type": "patch",
+      "comment": "Update workspace-tools to 0.41.4",
+      "packageName": "beachball",
+      "email": "elcraig@microsoft.com",
+      "dependentChangeType": "patch"
+    }
+  ]
+}

lage.config.js

@@ -0,0 +1,54 @@
+// @ts-check
+
+/** @typedef {import('lage').ConfigOptions} ConfigOptions */
+/** @typedef {import('lage').CacheOptions} CacheOptions */
+
+/**
+ * Lage config (the types are slightly incorrect about what's required/optional)
+ * @type {Partial<Omit<ConfigOptions, 'cacheOptions'>> & { cacheOptions?: Partial<CacheOptions> }}
+ */
+const config = {
+  npmClient: 'yarn',
+  pipeline: {
+    build: {
+      dependsOn: ['^build'],
+      outputs: ['lib/**/*'],
+    },
+    lint: ['build'],
+    depcheck: [],
+    test: ['build'],
+    'update-snapshots': ['build'],
+    // For the beachball package, run the tests in order during the main test run
+    'beachball#test': {
+      type: 'noop',
+      dependsOn: ['test:unit', 'test:func', 'test:e2e'],
+    },
+    // These are not typically run directly, but the dependencies enforce ordering for beachball#test
+    'test:unit': ['build'],
+    'test:func': ['build', 'test:unit'],
+    'test:e2e': ['build', 'test:unit', 'test:func'],
+  },
+
+  cacheOptions: {
+    // These are relative to the git root, and affects the hash of the cache
+    // Any of these file changes will invalidate cache
+    environmentGlob: [
+      // Folder globs MUST end with **/* to include all files!
+      '!.yarn/**/*',
+      '!node_modules/**/*',
+      '!**/node_modules/**/*',
+      '.github/workflows/*',
+      '*.js',
+      '*.json',
+      '*.yml',
+      'yarn.lock',
+    ],
+
+    // Subset of files in package directories that will be saved into the cache.
+    // (set per target instead)
+    outputGlob: [],
+    // outputGlob: ['lib/**/*', 'temp/*.api.md'],
+  },
+};
+
+module.exports = config;

package.json

@@ -11,11 +11,12 @@
     "node": ">=14.0.0"
   },
   "workspaces": [
-    "packages/*"
+    "packages/*",
+    "scripts"
   ],
   "scripts": {
     "beachball": "node ./packages/beachball/lib/cli.js",
-    "build": "yarn workspace beachball build",
+    "build": "yarn lage build",
     "bump": "yarn beachball bump",
     "change": "yarn beachball change",
     "checkchange": "yarn beachball check",
@@ -24,19 +25,20 @@
     "format": "prettier --write .",
     "format:check": "prettier --check .",
     "prepare": "husky install",
-    "lint": "yarn lint:deps && yarn lint:marketplace && yarn lint:code",
-    "lint:code": "yarn workspace beachball lint",
-    "lint:deps": "yarn workspace beachball run depcheck .",
+    "lage": "cross-env NODE_OPTIONS=\"--experimental-abortcontroller\" lage",
+    "lint": "yarn lint:deps && yarn lint:versions && yarn lint:marketplace && yarn lint:code",
+    "lint:ci": "yarn lint:deps --verbose && yarn lint:versions && yarn lint:marketplace && yarn lint:code --verbose",
+    "lint:code": "yarn lage lint",
+    "lint:deps": "yarn lage depcheck",
+    "lint:versions": "yarn syncpack:check",
     "lint:marketplace": "node scripts/lint-marketplace.js",
+    "postinstall": "patch-package",
     "release": "yarn beachball publish -y",
     "release:docs": "echo \"Run this from the docs folder instead\" && exit 1",
-    "test": "yarn workspace beachball test",
-    "test:all": "yarn test:unit && yarn test:func && yarn test:e2e",
-    "test:e2e": "yarn workspace beachball test:e2e",
-    "test:func": "yarn workspace beachball test:func",
-    "test:unit": "yarn workspace beachball test:unit",
-    "test:watch": "yarn workspace beachball test:watch",
-    "update-snapshots": "yarn workspace beachball update-snapshots"
+    "syncpack:check": "syncpack list-mismatches",
+    "syncpack:update": "syncpack fix-mismatches",
+    "test": "yarn lage test",
+    "update-snapshots": "yarn lage update-snapshots"
   },
   "lint-staged": {
     "*": [
@@ -50,14 +52,18 @@
     "@typescript-eslint/eslint-plugin": "^5.0.0",
     "@typescript-eslint/parser": "^5.0.0",
     "@typescript-eslint/utils": "^5.0.0",
+    "cross-env": "^7.0.0",
     "depcheck": "^1.4.7",
     "eslint": "^8.0.0",
     "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-etc": "^2.0.3",
     "husky": "^8.0.0",
     "jest": "^29.0.0",
+    "lage": "2.4.0",
     "lint-staged": "^12.0.0",
+    "patch-package": "^8.0.1",
     "prettier": "~2.8.4",
+    "syncpack": "^9.0.0",
     "ts-jest": "29.2.6",
     "typescript": "~5.2.0"
   },
@@ -68,9 +74,11 @@
     "**/body-parser/qs": "^6.14.2",
     "**/express/qs": "^6.14.2",
     "**/@cypress/request/qs": "^6.14.2",
+    "**/syncpack/minimatch": "^6.2.3",
+    "**/syncpack/semver": "^7.7.4",
     "**/verdaccio/handlebars": "^4.7.9",
-    "**/verdaccio/minimatch": "^7.4.9",
     "**/verdaccio/js-yaml": "^4.1.0",
+    "**/verdaccio/minimatch": "^7.4.9",
     "**/verdaccio/validator": "^13.15.22",
     "**/@verdaccio/config/js-yaml": "^4.1.0",
     "**/@verdaccio/config/minimatch": "^7.4.9",
@@ -79,14 +87,16 @@
   },
   "rationale": {
     "devDependencies": {
+      "lage@2.4.0": "Pin to newest version that supports node 14",
       "ts-jest@29.2.6": "29.3.0 introduces type-fest v4 which requires node 16+"
     },
     "resolutions": {
       "**/lodash": "Unpin due to security issue",
       "**/*/qs": "Unpin due to security issue",
+      "**/semver": "Unpin due to security issues",
       "**/verdaccio/*": "Unpin due to security issues",
       "**/@verdaccio/*/*": "Unpin due to security issues",
-      "**/minimatch": "Unpin minimatch v7 due to security issues"
+      "**/minimatch": "Unpin minimatch due to security issues"
     }
   }
 }