Prepare main branch for v3 alpha (#1225)

Author: ecraig12345

.ado/publish.yml

@@ -109,9 +109,12 @@ extends:
                 displayName: Test
 
               # TODO: figure out if this should bump or not (currently does bump)
+              # and currently uses a prerelease prefix of 'test' to avoid interfering with real versions
+              # TODO (release): change back to:
+              # yarn beachball publish --prerelease-prefix test -y --no-push --pack-to-path '$(Build.StagingDirectory)/pkg'
               - script: |
-                  yarn beachball publish -y --no-push --pack-to-path '$(Build.StagingDirectory)/pkg'
-                displayName: 'Pack packages'
+                  yarn release:canary --no-push --pack-to-path '$(Build.StagingDirectory)/pkg'
+                displayName: 'Pack packages (canary)'
 
               - script: |
                   ls -R '$(Build.StagingDirectory)/pkg'

.github/pull_request_template.md

@@ -0,0 +1,5 @@
+<!--
+The `main` branch of beachball is currently being used for development of a new major version. If this is a non-breaking change which you'd like to pick up right away in beachball v2, it should target the `v2` branch instead of `main`.
+-->
+
+<!-- Don't forget to include a change file! -->

.github/workflows/docsite.yml

@@ -2,7 +2,8 @@ name: Update documentation site
 
 on:
   push:
-    branches: [main]
+    # The docsite publishes from the v2 branch for now
+    branches: [v2]
     paths:
       - 'docs/**'
       - .github/workflows/docsite.yml
@@ -23,6 +24,14 @@ jobs:
       - name: Check out code
         uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
 
+      # TODO (release): release from main
+      - name: Verify v2 branch
+        run: |
+          if [[ "${GITHUB_REF}" != "refs/heads/v2" ]]; then
+            echo "Releases can only be triggered from the v2 branch."
+            exit 1
+          fi
+
       # The docs have a separate installation using Node 22 due to needing newer dependencies
       - name: Install Node.js
         uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6

.github/workflows/pr.yml

@@ -1,19 +1,16 @@
-# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
-# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
-
 name: PR
 
 on:
   pull_request:
-    branches: [main]
+    branches: [main, v2]
   push:
-    branches: [main]
+    branches: [main, v2]
 
 concurrency:
   # For PRs, use the ref (branch) in the concurrency group so that new pushes cancel any old runs.
   # For pushes to main, ideally we wouldn't set a concurrency group, but github actions doesn't
   # support conditional blocks of settings, so we use the SHA so the "group" is unique.
-  group: ${{ github.workflow }}-${{ github.ref == 'refs/heads/main' && github.sha || github.ref }}
+  group: ${{ github.workflow }}-${{ (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/v2') && github.sha || github.ref }}
   cancel-in-progress: true
 
 permissions: {}

.github/workflows/release.yml

@@ -34,6 +34,14 @@ jobs:
           # Don't save creds in the git config (so it's easier to override later)
           persist-credentials: false
 
+      # Prereleases from main are disabled until the canary/prerelease flow is fixed
+      - name: Verify v2 branch
+        run: |
+          if [[ "${GITHUB_REF}" != "refs/heads/v2" ]]; then
+            echo "Releases can only be triggered from the v2 branch."
+            exit 1
+          fi
+
       - name: Install Node.js ${{ env.nodeVersion }}
         uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6
         with:
@@ -48,7 +56,8 @@ jobs:
 
       - run: yarn test --verbose
 
-      - name: Publish package
+      # TODO (release): switch back to regular release
+      - name: Publish package (canary)
         run: |
           git config user.email "kchau@microsoft.com"
           git config user.name "Ken Chau"
@@ -60,6 +69,6 @@ jobs:
           # Add a token to the remote URL for auth during release
           git remote set-url origin "https://$REPO_PAT@github.com/$GITHUB_REPOSITORY"
 
-          yarn release
+          yarn release:canary
         env:
           REPO_PAT: ${{ secrets.REPO_PAT }}

README.md

@@ -1,3 +1,7 @@
 # [beachball](https://microsoft.github.io/beachball/) monorepo
 
 the sunniest version bumping tool - see [`packages/beachball`](./packages/beachball) for details
+
+## `main` is currently the development branch for beachball v3 (alpha)
+
+The code for beachball v2 (`latest`) is in the `v2` branch. If you're making a PR with a non-breaking change, it should target the `v2` branch.

beachball.config.js

@@ -4,9 +4,12 @@ const config = {
   access: 'public',
   branch: 'main',
   commit: false,
-  disallowedChangeTypes: ['major'],
   groupChanges: true,
   ignorePatterns: ['.*ignore', '.eslintrc.js', 'jest.*.js', 'src/__*/**'],
+  // TODO (release): change back to major
+  disallowedChangeTypes: ['prerelease'],
+  // TODO (release): remove
+  canaryName: 'alpha',
 };
 
 module.exports = config;

change/change-c8006efc-15a3-4418-871f-356266015edf.json

@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "type": "none",
+      "comment": "Start preparing for v3 release",
+      "packageName": "beachball",
+      "email": "elcraig@microsoft.com",
+      "dependentChangeType": "none"
+    }
+  ]
+}

package.json

@@ -33,7 +33,7 @@
     "lint:versions": "yarn syncpack:check",
     "lint:marketplace": "node scripts/lintMarketplace.js",
     "postinstall": "patch-package",
-    "release": "yarn beachball publish -y",
+    "release:canary": "yarn beachball canary -y",
     "release:docs": "echo \"Run this from the docs folder instead\" && exit 1",
     "syncpack:check": "syncpack list-mismatches",
     "syncpack:update": "syncpack fix-mismatches",

packages/beachball/package.json

@@ -1,6 +1,6 @@
 {
   "name": "beachball",
-  "version": "2.65.3",
+  "version": "3.0.0-alpha.0",
   "description": "The Sunniest Semantic Version Bumper",
   "repository": {
     "type": "git",