Merge branch 'main' into express-modules

Author: wch

.github/py-shiny/pytest-browsers/action.yaml

@@ -0,0 +1,30 @@
+name: 'Custom merge queue browsers'
+description: 'Trim down pytest browsers for any github event other than merge_group.'
+inputs:
+  all-browsers:
+    description: 'Force all pytest browsers to used when testing'
+    required: false
+    default: 'false'
+outputs:
+  browsers:
+    description: 'pytest browsers to use'
+    value: ${{ steps.browsers.outputs.browsers }}
+runs:
+  using: "composite"
+  steps:
+      - name: Determine browsers to use
+        shell: bash
+        id: browsers
+        run: |
+          if [ "${{ inputs.all-browsers }}" == "true" ]; then
+            echo "Using all browsers!"
+            exit 0
+          fi
+
+          if [ "${{ github.event_name }}" == "pull_request" ]; then
+            echo "Using chrome browser only!"
+            echo 'browsers=PYTEST_BROWSERS="--browser chromium"' >> "$GITHUB_OUTPUT"
+          fi
+
+          echo "No custom pytest browsers!"
+          exit 0

.github/workflows/build-docs.yaml

@@ -1,34 +1,38 @@
-name: Build API docs
+name: Build API docs and Shinylive for GitHub Pages
 
 on:
   workflow_dispatch:
   push:
     branches: ["main"]
   pull_request:
+  merge_group:
 
 jobs:
-  build:
+  build-docs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
         python-version: ["3.12"]
       fail-fast: false
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
 
       - name: Upgrade pip
         run: python -m pip install --upgrade pip
 
+      # =====================================================
+      # API docs
+      # =====================================================
       - name: Install Quarto
         uses: quarto-dev/quarto-actions/setup@v2
         with:
-          version: 1.3.340
+          version: 1.4.549
 
       - name: Install dependencies
         run: |
@@ -42,25 +46,60 @@ jobs:
           make quartodoc
 
       - name: Build site
+        if: ${{ github.ref == 'refs/heads/main' || github.event_name == 'merge_group' || startsWith(github.head_ref, 'docs')  }}
         run: |
           cd docs
           make site
 
+      # =====================================================
+      # Shinylive
+      # =====================================================
+      - name: Check out shinylive
+        if: github.ref == 'refs/heads/main'
+        uses: actions/checkout@v4
+        with:
+          repository: rstudio/shinylive
+          ref: main
+          path: shinylive-repo
+
+      - name: Update shinylive's copy of shiny, htmltools, and other packages
+        if: github.ref == 'refs/heads/main'
+        run: |
+          cd shinylive-repo
+          make submodules
+          make submodules-pull
+
+      - name: Build shinylive
+        if: github.ref == 'refs/heads/main'
+        run: |
+          cd shinylive-repo
+          make all
+
+      # =====================================================
+      # Deploy
+      # =====================================================
+
+      - name: Move built API docs and shinylive to single directory
+        if: github.ref == 'refs/heads/main'
+        run: |
+          mkdir deploy
+          mv docs/_site deploy/docs
+          mv shinylive-repo/_shinylive deploy/shinylive
+
       - name: Upload site artifact
         if: github.ref == 'refs/heads/main'
         uses: actions/upload-pages-artifact@v1
         with:
-          path: "docs/_site"
-
+          path: "deploy"
 
   deploy:
     if: github.ref == 'refs/heads/main'
-    needs: build
+    needs: build-docs
 
     # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
     permissions:
-      pages: write      # to deploy to Pages
-      id-token: write   # to verify the deployment originates from an appropriate source
+      pages: write # to deploy to Pages
+      id-token: write # to verify the deployment originates from an appropriate source
 
     # Deploy to the github-pages environment
     environment:

.github/workflows/pytest.yaml

@@ -5,13 +5,14 @@ on:
   push:
     branches: ["main", "rc-*"]
   pull_request:
+  merge_group:
   release:
     types: [published]
   schedule:
     - cron: "0 8 * * *"
 
 jobs:
-  build:
+  check:
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -21,7 +22,7 @@ jobs:
       fail-fast: false
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Setup py-shiny
         id: install
         uses: ./.github/py-shiny/setup
@@ -33,25 +34,20 @@ jobs:
         run: |
           make check-tests
 
-      - name: Type check with pyright
+      - name: Type check
         if: steps.install.outcome == 'success' && (success() || failure())
         run: |
           make check-types
 
-      - name: Lint with flake8
+      - name: Lint code
         if: steps.install.outcome == 'success' && (success() || failure())
         run: |
           make check-lint
 
-      - name: black
+      - name: Verify code formatting
         if: steps.install.outcome == 'success' && (success() || failure())
         run: |
-          make check-black
-
-      - name: isort
-        if: steps.install.outcome == 'success' && (success() || failure())
-        run: |
-          make check-isort
+          make check-format
 
   playwright-shiny:
     runs-on: ${{ matrix.os }}
@@ -63,16 +59,24 @@ jobs:
       fail-fast: false
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Setup py-shiny
         uses: ./.github/py-shiny/setup
         with:
           python-version: ${{ matrix.python-version }}
 
+      - name: Determine browsers for testing
+        uses: ./.github/py-shiny/pytest-browsers
+        id: browsers
+        with:
+          all-browsers: ${{ startsWith(github.head_ref, 'playwright') }}
+      - name: Display browser
+        shell: bash
+        run: echo '${{ steps.browsers.outputs.browsers }}'
       - name: Run End-to-End tests
         timeout-minutes: 20
         run: |
-          make playwright-shiny SUB_FILE=". -vv"
+          make playwright-shiny SUB_FILE=". -vv" ${{ steps.browsers.outputs.browsers }}
       - uses: actions/upload-artifact@v4
         if: failure()
         with:
@@ -90,14 +94,14 @@ jobs:
       fail-fast: false
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Setup py-shiny
         uses: ./.github/py-shiny/setup
         with:
           python-version: ${{ matrix.python-version }}
 
       - name: Install node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: "18"
           cache: npm
@@ -107,10 +111,15 @@ jobs:
         run: |
           npm ci
 
+      - name: Determine browsers for testing
+        uses: ./.github/py-shiny/pytest-browsers
+        id: browsers
+        with:
+          all-browsers: ${{ startsWith(github.head_ref, 'playwright') }}
       - name: Run example app tests
         timeout-minutes: 20
         run: |
-          make playwright-examples SUB_FILE=". -vv"
+          make playwright-examples SUB_FILE=". -vv" ${{ steps.browsers.outputs.browsers }}
       - uses: actions/upload-artifact@v4
         if: failure()
         with:
@@ -129,7 +138,7 @@ jobs:
       fail-fast: false
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Setup py-shiny
         uses: ./.github/py-shiny/setup
         with:
@@ -142,9 +151,16 @@ jobs:
         run: |
           make playwright-deploys SUB_FILE=". -vv"
 
+      - uses: actions/upload-artifact@v4
+        if: failure()
+        with:
+          name: "playright-examples-${{ matrix.os }}-${{ matrix.python-version }}-results"
+          path: test-results/
+          retention-days: 5
+
   playwright-deploys:
     needs: [playwright-deploys-precheck]
-    if: github.event_name != 'release' && (github.event_name == 'push' || (github.event_name == 'pull_request' && startsWith(github.head_ref, 'deploy')))
+    if: github.event_name != 'release' && (github.event_name == 'push' || startsWith(github.head_ref, 'deploy'))
     # Only allow one `playwright-deploys` job to run at a time. (Independent of branch / PR)
     # Only one is allowed to run at a time because it is deploying to the same server location.
     concurrency: playwright-deploys
@@ -157,7 +173,7 @@ jobs:
       fail-fast: false
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Setup py-shiny
         uses: ./.github/py-shiny/setup
         with:
@@ -170,8 +186,7 @@ jobs:
         run: |
           make playwright-deploys SUB_FILE=". -vv"
 
-      - name: Deploy apps and run tests (on `push` or on `pull_request` w/ `deploy**` branch)
-        if: ${{ github.event_name == 'push' || (github.event_name == 'pull_request' && startsWith(github.head_ref, 'deploy')) }}
+      - name: Deploy apps and run tests (on `push` or `deploy**` branches)
         env:
           DEPLOY_APPS: "true"
           DEPLOY_CONNECT_SERVER_URL: "https://rsc.radixu.com/"
@@ -196,9 +211,9 @@ jobs:
     name: "Deploy to PyPI"
     runs-on: ubuntu-latest
     if: github.event_name == 'release'
-    needs: [build]
+    needs: [check]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: "Set up Python 3.10"
         uses: actions/setup-python@v4
         with:
@@ -232,7 +247,7 @@ jobs:
 
   testrail-reporting-nightly:
     runs-on: ${{ matrix.os }}
-    if: ${{ github.event_name == 'schedule' || (github.event_name == 'pull_request' && startsWith(github.head_ref, 'testrail')) }}
+    if: ${{ github.event_name == 'schedule' || startsWith(github.head_ref, 'testrail') }}
     strategy:
       matrix:
         python-version:
@@ -245,14 +260,14 @@ jobs:
       fail-fast: false
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Setup py-shiny
         uses: ./.github/py-shiny/setup
         with:
           python-version: ${{ matrix.python-version }}
 
       - name: Install node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: "18"
           cache: npm

.github/workflows/verify-js-built.yaml

@@ -1,9 +1,10 @@
-name: Build
+name: Verify built assets
 
 on:
   push:
     branches: ["main", "rc-*"]
   pull_request:
+  merge_group:
 
 jobs:
   verify_js_built:

.prettierrc

@@ -1,3 +1,11 @@
 {
-  "organizeImportsSkipDestructiveCodeActions": true
+  "organizeImportsSkipDestructiveCodeActions": true,
+  "overrides": [
+    {
+      "files": "**/*.scss",
+      "options": {
+        "printWidth": 150
+      }
+    }
+  ]
 }

.vscode/extensions.json

@@ -0,0 +1,7 @@
+{
+	"recommendations": [
+    "posit.shiny-python",
+		"esbenp.prettier-vscode",
+    "ms-python.black-formatter",
+	]
+}

.vscode/settings.json

@@ -24,6 +24,10 @@
         "editor.formatOnSave": true,
         "editor.defaultFormatter": "esbenp.prettier-vscode"
     },
+    "[scss]": {
+        "editor.formatOnSave": true,
+        "editor.defaultFormatter": "esbenp.prettier-vscode"
+    },
     "[python]": {
         "editor.defaultFormatter": "ms-python.black-formatter",
         "editor.formatOnSave": true,