update RTD config, move doc deps into their own group, update dev group

.github/workflows/cicd.yml

@@ -48,13 +48,41 @@ jobs:
               - 'infrastructure/blueprints/prevent_privilege_escalation.py'
               - 'infrastructure/blueprints/test_runner_boundary.py'
               - 'infrastructure/test-alt/common/**'
+  info:
+    name: Output useful information
+    runs-on: ubuntu-latest
+    outputs:
+      is-actor-bot: ${{ steps.gh-context.outputs.is-actor-bot }}  # if the actor (user) is a bot
+      is-fork: ${{ steps.gh-context.outputs.is-fork }}  # if the action is running in or from (PR) a fork
+      repo-head: ${{ steps.gh-context.outputs.repo-head }}  # repo where change occurred
+      repo-origin: ${{ steps.gh-context.outputs.repo-origin }}  # origin of codebase
+    steps:
+      - name: Output GitHub Context
+        id: gh-context
+        run: |
+          export _REPO_ORIGIN="onicagroup/runway";
+          echo "repo-origin=${_REPO_ORIGIN}" >> "${GITHUB_OUTPUT}";
+          export _REPO_HEAD="${{ github.event.pull_request.head.repo.full_name || github.repository }}";
+          echo "repo-head=${_REPO_HEAD}" >> "${GITHUB_OUTPUT}";
+          if [[ "${_REPO_HEAD}" == "${_REPO_ORIGIN}" ]]; then
+            echo "is-fork=false" >> "${GITHUB_OUTPUT}";
+          else
+            echo "is-fork=true" >> "${GITHUB_OUTPUT}";
+          fi;
+          if [[ ${{ github.actor }} == *"[bot]" ]]; then
+            echo "is-actor-bot=true" >> "${GITHUB_OUTPUT}";
+          else
+            echo "is-actor-bot=false" >> "${GITHUB_OUTPUT}";
+          fi;
   deploy-test-infrastructure:
     name: Deploy Test Infrastructure
     environment: test
     concurrency: test-infrastructure
-    needs: changes
+    needs:
+      - changes
+      - info
     if: |
-      github.repository == 'onicagroup/runway' &&
+      needs.info.outputs.is-fork == 'false' &&
       (needs.changes.outputs.infra-test == 'true' || needs.changes.outputs.infra-test-alt == 'true')
     runs-on: ubuntu-latest
     steps:
@@ -73,7 +101,7 @@ jobs:
       - name: Ensure Cache Is Healthy
         if: runner.os != 'Windows' && steps.cache.outputs.cache-hit == 'true'
         run: poetry run pip --version >/dev/null 2>&1 || rm -rf .venv
-      - run: poetry install --extras docs -vv
+      - run: poetry install -vv
       - name: Configure AWS Credentials
         uses: aws-actions/configure-aws-credentials@v4
         with:
@@ -115,7 +143,7 @@ jobs:
       - name: Ensure Cache Is Healthy
         if: runner.os != 'Windows' && steps.cache.outputs.cache-hit == 'true'
         run: poetry run pip --version >/dev/null 2>&1 || rm -rf .venv
-      - run: poetry install --extras docs -vv
+      - run: poetry install -vv
       - name: Install Node Dependencies
         run: make npm-ci
       - name: Run Linters
@@ -141,16 +169,17 @@ jobs:
       - name: Ensure Cache Is Healthy
         if: runner.os != 'Windows' && steps.cache.outputs.cache-hit == 'true'
         run: poetry run pip --version >/dev/null 2>&1 || rm -rf .venv
-      - run: poetry install --extras docs -vv
+      - run: poetry install -vv
       - uses: pre-commit/[email protected]
   test-functional:
     name: Functional Tests
-    needs: deploy-test-infrastructure
-    # will fail if run from forks
+    needs:
+      - deploy-test-infrastructure
+      - info
     if: |
       always() &&
-      github.repository == 'onicagroup/runway' &&
-      github.actor != 'dependabot[bot]' &&
+      needs.info.outputs.is-fork == 'false' &&
+      needs.info.outputs.is-actor-bot == 'false' &&
       (needs.deploy-test-infrastructure.result == 'success' || needs.deploy-test-infrastructure.result == 'skipped')
     runs-on: ubuntu-latest
     steps:
@@ -172,7 +201,7 @@ jobs:
       - name: Ensure Cache Is Healthy
         if: runner.os != 'Windows' && steps.cache.outputs.cache-hit == 'true'
         run: poetry run pip --version >/dev/null 2>&1 || rm -rf .venv
-      - run: poetry install --extras docs -vv
+      - run: poetry install -vv
       - name: Install Ubuntu Dependencies
         run: |
           sudo apt update -y
@@ -218,7 +247,7 @@ jobs:
       - name: Ensure Cache Is Healthy
         if: steps.cache.outputs.cache-hit == 'true'
         run: poetry run pip --version >/dev/null 2>&1 || rm -rf .venv
-      - run: poetry install --extras docs -vv
+      - run: poetry install -vv
       - name: Install Node Dependencies
         run: make npm-install
       - name: Configure Pagefile  # avoid MemoryError during tests
@@ -266,7 +295,7 @@ jobs:
       - name: Ensure Cache Is Healthy
         if: runner.os != 'Windows' && steps.cache.outputs.cache-hit == 'true'
         run: poetry run pip --version >/dev/null 2>&1 || rm -rf .venv
-      - run: poetry install --extras docs -vv
+      - run: poetry install -vv
       - name: Run Build
         run: make build
       - name: Upload Distribution Artifact

.github/workflows/on-push-pyinstaller.yml

@@ -60,7 +60,7 @@ jobs:
       - name: Ensure Cache Is Healthy
         if: runner.os != 'Windows' && steps.cache.outputs.cache-hit == 'true'
         run: poetry run pip --version >/dev/null 2>&1 || rm -rf .venv
-      - run: poetry install --extras docs -vv
+      - run: poetry install -vv
       - name: Run Build
         run: make build-pyinstaller-file
       - name: Upload Artifacts
@@ -110,7 +110,7 @@ jobs:
       - name: Ensure Cache Is Healthy
         if: runner.os != 'Windows' && steps.cache.outputs.cache-hit == 'true'
         run: poetry run pip --version >/dev/null 2>&1 || rm -rf .venv
-      - run: poetry install --extras docs -vv
+      - run: poetry install -vv
       - name: Run Build
         run: make build-pyinstaller-folder
       - name: Upload Artifacts
@@ -171,7 +171,7 @@ jobs:
       - name: Ensure Cache Is Healthy
         if: runner.os != 'Windows' && steps.cache.outputs.cache-hit == 'true'
         run: poetry run pip --version >/dev/null 2>&1 || rm -rf .venv
-      - run: poetry install --extras docs -vv
+      - run: poetry install -vv
       - name: Download Artifacts (macOS)
         if: steps.check_distance.outcome == 'success'
         uses: actions/download-artifact@v4

.github/workflows/publish-on-release.yml

@@ -54,7 +54,7 @@ jobs:
       - name: Ensure Cache Is Healthy
         if: runner.os != 'Windows' && steps.cache.outputs.cache-hit == 'true'
         run: poetry run pip --version >/dev/null 2>&1 || rm -rf .venv
-      - run: poetry install --extras docs -vv
+      - run: poetry install -vv
       - name: Run Build
         run: make build-pyinstaller-file
       - name: Upload Artifacts
@@ -105,7 +105,7 @@ jobs:
       - name: Ensure Cache Is Healthy
         if: runner.os != 'Windows' && steps.cache.outputs.cache-hit == 'true'
         run: poetry run pip --version >/dev/null 2>&1 || rm -rf .venv
-      - run: poetry install --extras docs -vv
+      - run: poetry install -vv
       - name: Run Build
         run: make build-pyinstaller-folder
       - name: Upload Artifacts
@@ -158,7 +158,7 @@ jobs:
       - name: Ensure Cache Is Healthy
         if: runner.os != 'Windows' && steps.cache.outputs.cache-hit == 'true'
         run: poetry run pip --version >/dev/null 2>&1 || rm -rf .venv
-      - run: poetry install --extras docs -vv
+      - run: poetry install -vv
       - name: Download Artifacts (macOS)
         uses: actions/download-artifact@v4
         with:
@@ -246,7 +246,7 @@ jobs:
       - name: Ensure Cache Is Healthy
         if: runner.os != 'Windows' && steps.cache.outputs.cache-hit == 'true'
         run: poetry run pip --version >/dev/null 2>&1 || rm -rf .venv
-      - run: poetry install --extras docs -vv
+      - run: poetry install -vv
       - name: Run Build
         run: make build
       - name: Upload Distribution Artifact
@@ -282,7 +282,7 @@ jobs:
       - name: Ensure Cache Is Healthy
         if: steps.cache.outputs.cache-hit == 'true'
         run: poetry run pip --version >/dev/null 2>&1 || rm -rf .venv
-      - run: poetry install --extras docs -vv
+      - run: poetry install -vv
       - run: make version
       - name: Publish Distribution 📦 to PyPI
         env:
@@ -349,7 +349,7 @@ jobs:
       - name: Ensure Cache Is Healthy
         if: runner.os != 'Windows' && steps.cache.outputs.cache-hit == 'true'
         run: poetry run pip --version >/dev/null 2>&1 || rm -rf .venv
-      - run: poetry install --extras docs -vv
+      - run: poetry install -vv
       - name: Configure AWS Credentials
         uses: aws-actions/configure-aws-credentials@v4
         with:

.github/workflows/spell-check.yml

@@ -3,13 +3,15 @@ name: Spell Check
 # There is an official action published by cSpell.
 # v1.1.1 was tested but did not function as desired so we are using the CLI.
 
-on: push
-
+on:
+  pull_request:  # any pull request
+  push:
+    branches:
+      - master
 
 env:
   NODE_VERSION: '18'
 
-
 jobs:
   spell-check:
     runs-on: ubuntu-latest

.readthedocs.yml

@@ -7,9 +7,20 @@ version: 2
 
 # Set the version of Python and other tools you might need
 build:
+  jobs:
+    post_create_environment:
+      # Install poetry
+      # https://python-poetry.org/docs/#installing-manually
+      - pip install poetry
+    post_install:
+      # Install dependencies with 'docs' dependency group
+      # https://python-poetry.org/docs/managing-dependencies/#dependency-groups
+      # VIRTUAL_ENV needs to be set manually for now.
+      # See https://github.com/readthedocs/readthedocs.org/pull/11152/
+      - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install --with docs,types
   os: ubuntu-22.04
   tools:
-    python: '3.9'
+    python: '3.12'
 
 # Optionally build your docs in additional formats such as PDF and ePub
 formats: all

.vscode/settings.json

@@ -14,6 +14,8 @@
         "restructuredtext"
     ],
     "cSpell.enabled": true,
+    "esbonio.sphinx.buildDir": "${workspaceRoot}/docs/build",
+    "esbonio.sphinx.confDir": "${workspaceFolder}/docs/source",
     "explorerExclude.backup": null,
     "files.exclude": {
         "**/*.egg-info": true,

Makefile

@@ -124,9 +124,7 @@ setup: setup-poetry setup-pre-commit setup-npm ## setup development environment
 setup-npm: npm-ci ## install node dependencies with npm
 
 setup-poetry: ## setup python virtual environment
-	@poetry install \
-		--extras docs \
-		--sync
+	@poetry install --sync
 
 setup-pre-commit: ## install pre-commit git hooks
 	@poetry run pre-commit install