Merge branch 'main' into logFailedTests

.github/workflows/deploy.yaml

@@ -13,26 +13,40 @@ jobs:
     environment: production
     env:
       CURSORLESS_REPO_ROOT: ${{ github.workspace }}
+
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout repository
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - run: corepack enable
-      - uses: actions/setup-node@v4
+
+      - name: Enable Corepack
+        run: corepack enable
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
         with:
           node-version-file: .nvmrc
           cache: pnpm
-      - run: pnpm --color install
-      - run: pnpm --color compile
-      - run: pnpm --color --filter '!cursorless-org' --filter '!cursorless-org-*' build
+
+      - name: Install dependencies
+        run: pnpm --color install
+
+      - name: Compile
+        run: pnpm --color compile
+
+      - name: Build
+        run: pnpm --color --filter '!cursorless-org' --filter '!cursorless-org-*' build
         env:
           CURSORLESS_DEPLOY: true
+
       - name: Publish to Open VSX Registry
         id: publishToOpenVSX
         uses: HaaLeo/publish-vscode-extension@v1
         with:
           pat: ${{ secrets.OPEN_VSX_TOKEN }}
           packagePath: packages/cursorless-vscode/dist
+
       - name: Publish to Visual Studio Marketplace
         uses: HaaLeo/publish-vscode-extension@v1
         with:
@@ -47,36 +61,53 @@ jobs:
     env:
       CURSORLESS_REPO_ROOT: ${{ github.workspace }}
       STAGING_DIRECTORY: ${{ github.workspace }}/cursorless.nvim-staging
+
     steps:
-      - uses: actions/checkout@v4
-      - run: corepack enable
-      - uses: actions/setup-node@v4
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Enable Corepack
+        run: corepack enable
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
         with:
           node-version-file: .nvmrc
           cache: pnpm
-      - run: pnpm --color install
-      - run: pnpm --color compile
-      - run: pnpm --color --filter '!cursorless-org' --filter '!cursorless-org-*' build
+
+      - name: Install dependencies
+        run: pnpm --color install
+
+      - name: Compile
+        run: pnpm --color compile
+
+      - name: Build
+        run: pnpm --color --filter '!cursorless-org' --filter '!cursorless-org-*' build
         env:
           CURSORLESS_DEPLOY: true
-      - uses: actions/checkout@v4
+
+      - name: Checkout cursorless.nvim plugin repo
+        uses: actions/checkout@v4
         with:
           token: ${{ secrets.CURSORLESS_BOT_TOKEN }}
           repository: hands-free-vim/cursorless.nvim
           path: ${{ env.STAGING_DIRECTORY }}
+
       - name: Configure GPG Key
         working-directory: ${{ env.STAGING_DIRECTORY }}
         run: |
           echo -n "$GPG_SIGNING_KEY" | base64 --decode | gpg --import
         env:
           GPG_SIGNING_KEY: ${{ secrets.CURSORLESS_BOT_GPG_SIGNING_KEY }}
+
       - name: git config
         working-directory: ${{ env.STAGING_DIRECTORY }}
         run: |
           git config user.name cursorless-bot
           git config user.email 98099035+cursorless-bot@users.noreply.github.com
           git config user.signingkey A9387720AFC62221
           git config commit.gpgsign true
+
       - name: Push compiled files to cursorless.nvim plugin repo
         run: bash -x scripts/deploy-cursorless-nvim.sh ${{ env.STAGING_DIRECTORY }}
 
@@ -85,20 +116,26 @@ jobs:
     runs-on: ubuntu-latest
     needs: publish-extension
     environment: production
+
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout repository
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
           token: ${{ secrets.CURSORLESS_BOT_TOKEN }}
+
       - name: Configure GPG Key
         run: |
           echo -n "$GPG_SIGNING_KEY" | base64 --decode | gpg --import
         env:
           GPG_SIGNING_KEY: ${{ secrets.CURSORLESS_BOT_GPG_SIGNING_KEY }}
+
       - name: git config
         run: |
           git config user.name cursorless-bot
           git config user.email 98099035+cursorless-bot@users.noreply.github.com
           git config user.signingkey A9387720AFC62221
           git config commit.gpgsign true
-      - run: bash -x scripts/deploy-cursorless-talon.sh
+
+      - name: Push cursorless-talon subrepo
+        run: bash -x scripts/deploy-cursorless-talon.sh

.github/workflows/forbid-todo.yml

@@ -9,7 +9,10 @@ on:
 jobs:
   forbid-todo:
     runs-on: ubuntu-latest
+
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
       - name: Forbid TODO
         run: ./scripts/forbid-todo.sh

.github/workflows/pr-description.yaml

@@ -0,0 +1,30 @@
+name: PR Description
+
+on:
+  pull_request:
+    types: [opened, edited, reopened, synchronize]
+  merge_group:
+    branches: [main]
+
+jobs:
+  validate-pr-description:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set up workspace
+        uses: actions/checkout@v2
+
+      - name: Validate description
+        run: |
+          # Fetch PR description from env with jq
+          PR_DESCRIPTION=$(jq -r ".pull_request.body" "$GITHUB_EVENT_PATH")
+          KEYWORD="REQUIRED_KEYWORD"
+
+          # Ensure PR author removed the welcome comment
+          if [[ $PR_DESCRIPTION = *"<!--"* ]] || [[ $PR_DESCRIPTION = *"-->"* ]]; then
+            echo "FAILED: Please remove the welcome comment from your PR description."
+            exit 1
+          else
+            echo "OK: Welcome comment is removed your PR description."
+          fi
+
+          echo "PASS: All checks OK!"

.github/workflows/pre-commit.yml

@@ -1,5 +1,6 @@
 name: Pre-commit
 permissions: read-all
+
 on:
   push:
     branches:
@@ -16,19 +17,37 @@ jobs:
     runs-on: ubuntu-latest
     env:
       CURSORLESS_REPO_ROOT: ${{ github.workspace }}
+
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup python
+        uses: actions/setup-python@v5
         with:
           python-version: 3.x
-      - run: corepack enable
-      - uses: actions/setup-node@v4
+
+      - name: Enable Corepack
+        run: corepack enable
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
         with:
           node-version-file: .nvmrc
           cache: pnpm
-      - run: pnpm --color install
-      - uses: leafo/gh-actions-lua@v9
-      - uses: leafo/gh-actions-luarocks@v4
-      - uses: pre-commit/action@v3.0.1
-      - uses: pre-commit-ci/lite-action@v1.0.2
+
+      - name: Install dependencies
+        run: pnpm --color install
+
+      - name: Install lua
+        uses: leafo/gh-actions-lua@v9
+
+      - name: Install luarocks
+        uses: leafo/gh-actions-luarocks@v4
+
+      - name: Run pre-commit hooks
+        uses: pre-commit/action@v3.0.1
+
+      - name: Auto-fix pre-commit issues
+        uses: pre-commit-ci/lite-action@v1.0.2
         if: always()

.github/workflows/test-docs.yml

@@ -11,11 +11,19 @@ jobs:
     runs-on: ubuntu-latest
     env:
       CURSORLESS_REPO_ROOT: ${{ github.workspace }}
+
     steps:
-      - uses: actions/checkout@v4
-      - run: corepack enable
-      - uses: actions/setup-node@v4
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Enable Corepack
+        run: corepack enable
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
         with:
           node-version-file: .nvmrc
           cache: pnpm
-      - run: bash -x scripts/build-and-assemble-website.sh
+
+      - name: Build website
+        run: bash -x scripts/build-and-assemble-website.sh