aboutsummaryrefslogtreecommitdiff
path: root/.github/workflows/docs.yml
diff options
context:
space:
mode:
Diffstat (limited to '.github/workflows/docs.yml')
-rw-r--r--.github/workflows/docs.yml33
1 files changed, 33 insertions, 0 deletions
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
new file mode 100644
index 0000000000..c91f2945fb
--- /dev/null
+++ b/.github/workflows/docs.yml
@@ -0,0 +1,33 @@
+name: docs
+on:
+ pull_request:
+ types: [opened, synchronize, reopened, ready_for_review]
+ paths:
+ - 'src/nvim/api/*.[ch]'
+ - 'src/nvim/eval.lua'
+ - 'runtime/lua/**.lua'
+ - 'runtime/doc/**'
+ - 'scripts/gen_vimdoc.py'
+ - 'scripts/gen_help_html.lua'
+jobs:
+ docs:
+ runs-on: ubuntu-latest
+ if: github.event.pull_request.draft == false
+ permissions:
+ contents: write
+ pull-requests: write
+ steps:
+ - uses: actions/checkout@v4
+ - uses: ./.github/actions/setup
+
+ - name: Generate docs
+ run: |
+ make doc
+ if [ -n "$(git status --porcelain)" ]; then
+ echo "::error::Job failed, run 'make doc' and commit your doc changes."
+ echo "::error::The doc generation produces the following changes:"
+ git diff --color --exit-code
+ fi
+
+ - name: Validate docs
+ run: make lintdoc