Formalise style preference description (#2818)

[etc/vim.git] / .github / workflows / doc.yml

diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml
index 6023a02a7f7f895f19851b5f8702805aa7e1cbfa..5689d2887c4fdf5ac70a44e3b15808b657dea223 100644 (file)
--- a/.github/workflows/doc.yml
+++ b/.github/workflows/doc.yml
@@ -1,36 +1,33 @@
 name: Documentation Build
 
-on:
-  push:
-    paths:
-      - "docs/**"
-      - "README.md"
-      - "CHANGES.md"
-      - "CONTRIBUTING.md"
-  pull_request:
-    paths:
-      - "docs/**"
-      - "README.md"
-      - "CHANGES.md"
-      - "CONTRIBUTING.md"
+on: [push, pull_request]
 
 jobs:
   build:
-    runs-on: ubuntu-latest
+    # We want to run on external PRs, but not on our own internal PRs as they'll be run
+    # by the push to the branch. Without this if check, checks are duplicated since
+    # internal PRs match both the push and pull_request events.
+    if:
+      github.event_name == 'push' || github.event.pull_request.head.repo.full_name !=
+      github.repository
 
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+
+    runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v2
 
-      - name: Set up Python 3.8
+      - name: Set up latest Python
         uses: actions/setup-python@v2
-        with:
-          python-version: 3.8
 
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip setuptools wheel
-          python -m pip install -e "."
+          python -m pip install -e ".[d]"
           python -m pip install -r "docs/requirements.txt"
 
       - name: Build documentation
-        run: sphinx-build -a -b html -W docs/ docs/_build/
+        run: sphinx-build -a -b html -W --keep-going docs/ docs/_build