commit 45dbb78747b8caea01fa11916f875bdcfa3ff09e
parent 85821d8b6fa366f7361f84e07e62dc8fc951f26d
Author: Javier López <graulopezjavier@gmail.com>
Date: Sat, 26 Mar 2022 07:22:03 -0500
ci(doc): improve missing docs workflow
1. Add new pattern `runtime/doc/**`. This is a common case were the
contributor modifies only the help file but the doc gen would discard
their changes.
2. Add to the output what the changes after running doc gen would be.
[skip ci]
Diffstat:
2 files changed, 4 insertions(+), 0 deletions(-)
diff --git a/.github/workflows/api-docs-check.yml b/.github/workflows/api-docs-check.yml
@@ -7,6 +7,7 @@ on:
paths:
- 'src/nvim/api/*.[ch]'
- 'runtime/lua/**.lua'
+ - 'runtime/doc/**'
jobs:
call-regen-api-docs:
diff --git a/.github/workflows/api-docs.yml b/.github/workflows/api-docs.yml
@@ -7,6 +7,7 @@ on:
paths:
- 'src/nvim/api/*.[ch]'
- 'runtime/lua/**.lua'
+ - 'runtime/doc/**'
branches:
- 'master'
- 'release-[0-9]+.[0-9]+'
@@ -56,6 +57,8 @@ jobs:
if: ${{ steps.docs.outputs.UPDATED_DOCS != 0 && inputs.check_only }}
run: |
echo "Job failed, run ./scripts/gen_vimdoc.py and commit your doc changes"
+ echo "The doc generation produces the following changes:"
+ git --no-pager diff
exit 1
- name: Automatic PR