Sync versions, update yarn version, other build updates (#876)

Author: ecraig12345

.github/ISSUE_TEMPLATE/rfc--design-spec.md

@@ -6,11 +6,11 @@ labels: dev design
 assignees: kenotron
 ---
 
-# Overview
+## Overview
 
 Provide a high level summary of the feature you are trying to build
 
-## Definitions of terms
+### Definitions of terms
 
 <dl>
   <dt>term 1</dt>
@@ -21,23 +21,23 @@ Provide a high level summary of the feature you are trying to build
   <dd>definition 1</dt>
 </dl>
 
-## Goals & non-goals
+### Goals & non-goals
 
-### Upstream dependencies
+#### Upstream dependencies
 
 1. dep 1
 2. dep 2
 3. dep 3
 
-### Downstream dependencies
+#### Downstream dependencies
 
 1. dep 1
 2. dep 2
 3. dep 3
 
 </details>
 
-# Detailed Design
+## Detailed Design
 
 - Use diagrams
 
@@ -56,23 +56,23 @@ Use images by drag & drop
 - Describe different feature areas and how they are architected (designed)
 - Make sure another set of developer can roughly understand how your code will be organized after reading this section!
 
-# Test Plan
+## Test Plan
 
 - How will you make sure these features are to be tested
 - Specify if leveraging any NEW test framework or techniques
 
-# Performance, Resilience, Monitoring
+## Performance, Resilience, Monitoring
 
 - Discuss any impact on performance (both as a developer and as a consumer)
 - Any expected change in the ability to deal with spotty networks (resilience?)
 - How will you monitor or collect telemetry on the features?
 
-# Security & Privacy
+## Security & Privacy
 
 - Will the feature have any security or privacy issues?
 - What are some ways to mitigate these issues?
 
-# Accessibility
+## Accessibility
 
 - How will your feature conform to accessibility guidelines
 - Check on how you will handle:
@@ -82,12 +82,12 @@ Use images by drag & drop
   - High DPI support
   - High Contrast support
 
-# World Readiness
+## World Readiness
 
 - Globalization: how does yoru feature invoke display or manipulate display of currency, dates, timezones, names?
 - Localization: how does your feature address localization?
 
-# Execution Plan
+## Execution Plan
 
 List out the work items and/or PRs here:
 

.github/workflows/docusaurus-pr.yml

@@ -1,27 +1,41 @@
-name: Test deployment
+name: Docs - PR
 
 on:
   pull_request:
     branches:
       - master
     paths:
+      - .github/workflows/docusaurus-pr.yml
       - "docs/**"
 
+concurrency:
+  # For PRs, use the ref (branch) in the concurrency group so that new pushes cancel any old runs.
+  # For pushes to master, 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/master' && github.sha || github.ref }}
+  cancel-in-progress: true
+
+permissions: {}
+
 jobs:
   test-deploy:
     name: Test deployment
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
         with:
-          node-version: 18.x
-      - name: Test build
+          node-version-file: .nvmrc
+
+      - run: yarn --immutable
         working-directory: docs
-        run: |
-          yarn install --frozen-lockfile
-          yarn build
-      - uses: actions/upload-artifact@v3
+
+      - name: Build website
+        working-directory: docs
+        run: yarn build
+
+      - uses: actions/upload-artifact@v4
         with:
           name: docs
           path: docs/build/**

.github/workflows/docusaurus-release.yml

@@ -1,10 +1,11 @@
-name: Deploy to GitHub Pages
+name: Docs - Release
 
 on:
   push:
     branches:
       - master
     paths:
+      - .github/workflows/docusaurus-release.yml
       - "docs/**"
 
 permissions:
@@ -15,20 +16,23 @@ jobs:
     name: Deploy to GitHub Pages
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
         with:
-          node-version: 18.x
+          node-version-file: .nvmrc
+
+      - run: yarn --immutable
+        working-directory: docs
+
       - name: Build website
         working-directory: docs
-        run: |
-          yarn install --frozen-lockfile
-          yarn build
+        run: yarn build
 
       # Popular action to deploy to GitHub Pages:
       # Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
       - name: Deploy to GitHub Pages
-        uses: peaceiris/actions-gh-pages@v3
+        uses: peaceiris/actions-gh-pages@v4
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           destination_dir: docs

.github/workflows/pr.yml

@@ -7,46 +7,52 @@ on:
   pull_request:
     branches: [master, v1]
 # Ignoring the docs prevents PRs touching only docs from succeeding.
-# Also, the docs do have a build step which must succeed for overall builds to succeed.
 #    paths-ignore:
 #      - "docs/**"
 
+concurrency:
+  # For PRs, use the ref (branch) in the concurrency group so that new pushes cancel any old runs.
+  # For pushes to master, 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/master' && github.sha || github.ref }}
+  cancel-in-progress: true
+
+permissions: {}
+
 jobs:
   build:
     strategy:
       matrix:
-        node-version: [18.x, 20.x, 22.x]
+        node: [18.x, 20.x, 22.x]
         os: [ubuntu-latest, windows-latest, macos-latest]
 
     runs-on: ${{ matrix.os }}
 
     steps:
-      - uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
+      - uses: actions/checkout@v4
 
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
+      - name: Use Node.js ${{ matrix.node }}
+        uses: actions/setup-node@v4
         with:
-          node-version: ${{ matrix.node-version }}
+          node-version: ${{ matrix.node }}
 
-      - run: yarn
+      - run: yarn --immutable
 
       - name: Code Format Check
-        if: ${{ matrix.os == 'ubuntu-latest' }}
+        if: ${{ matrix.os == 'ubuntu-latest' && matrix.node == '22.x' }}
         run: yarn format:check
 
       - name: Check Change Files
-        if: ${{ matrix.os == 'ubuntu-latest' }}
+        if: ${{ matrix.os == 'ubuntu-latest' && matrix.node == '22.x' }}
         run: yarn checkchange
 
       # @see https://www.npmjs.com/package/syncpack
       - name: Check consistent package.json dep versions
-        if: ${{ matrix.os == 'ubuntu-latest' }}
+        if: ${{ matrix.os == 'ubuntu-latest' && matrix.node == '22.x' }}
         run: yarn syncpack list-mismatches
 
       - name: Dependency checks
-        if: ${{ matrix.os == 'ubuntu-latest' }}
+        if: ${{ matrix.os == 'ubuntu-latest' && matrix.node == '22.x' }}
         run: yarn lage depcheck
 
       - name: Build, Test, Lint

.github/workflows/release.yml

@@ -1,14 +1,14 @@
 name: Release
 
 on:
+  # release daily at 8am UTC (midnight or 1am pacific)
+  # https://crontab-generator.org/
+  schedule:
+    - cron: "0 8 * * *"
+  # or manual trigger
   workflow_dispatch:
-  push:
-    branches: [master, v1]
-    paths-ignore:
-      - "docs/**"
 
-permissions:
-  contents: write
+permissions: {}
 
 # Only run one release at a time to avoid duplicate attempts to publish particular versions.
 # To avoid backups after multiple pushes in rapid succession, the prerelease job below emulates
@@ -25,13 +25,13 @@ jobs:
   # Also skip this run if there are any newer pending runs.
   prerelease:
     runs-on: ubuntu-latest
+    permissions:
+      actions: read
     outputs:
       shouldRelease: ${{ steps.shouldRelease.outputs.shouldRelease }}
     steps:
       - name: Check out code
-        uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
+        uses: actions/checkout@v4
 
       # Cancel the release if a newer run is pending or no change files are present
       - uses: ecraig12345/beachball-actions/should-release@v1
@@ -50,22 +50,17 @@ jobs:
     # This environment contains secrets needed for publishing
     environment: release
 
-    strategy:
-      matrix:
-        node-version: [18.x]
-
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           # Don't save creds in the git config (so it's easier to override later)
           persist-credentials: false
 
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
-          node-version: ${{ matrix.node-version }}
+          node-version-file: .nvmrc
 
-      - run: yarn
+      - run: yarn --immutable
 
       - run: yarn ci --concurrency 2 --verbose
 

.nvmrc

@@ -0,0 +1 @@
+18

.prettierignore

@@ -4,14 +4,16 @@
 
 # Generated or imported files
 change/*.json
+docs/build
 CHANGELOG.*
 LICENSE
 SECURITY.md
 *.snap
 yarn.lock
+**/.yarn
 # this is a test fixture
 yarn.js
-.yarn/**
+**/.rush/temp
 
 # These lines from .gitignore can be removed after prettier 3 update
 node_modules

.vscode/settings.json

@@ -8,6 +8,10 @@
   "search.exclude": {
     "**/lib": true,
     "**/node_modules": true,
+    "**/.docusaurus": true,
+    "**/.yarn": true,
+    "**/yarn/yarn.js": true,
+    "**/docs/build": true,
     "**/*.code-search": true
   },
   "[typescript]": {