kevin/neovim
1
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2024-12-24 21:25:04 -07:00
Code Issues Packages Projects Releases Wiki Activity

ci(doc): improve missing docs workflow

Browse Source 
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]
This commit is contained in:
Javier López 2022-03-26 07:22:03 -05:00
parent 85821d8b6f
commit 45dbb78747
2 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.github/workflows/api-docs-check.yml vendored
View File

@ -7,6 +7,7 @@ on:
paths: paths:
- 'src/nvim/api/*.[ch]' - 'src/nvim/api/*.[ch]'
- 'runtime/lua/**.lua' - 'runtime/lua/**.lua'
- 'runtime/doc/**'
jobs: jobs:
call-regen-api-docs: call-regen-api-docs:

3
.github/workflows/api-docs.yml vendored
View File

@ -7,6 +7,7 @@ on:
paths: paths:
- 'src/nvim/api/*.[ch]' - 'src/nvim/api/*.[ch]'
- 'runtime/lua/**.lua' - 'runtime/lua/**.lua'
- 'runtime/doc/**'
branches: branches:
- 'master' - 'master'
- 'release-[0-9]+.[0-9]+' - 'release-[0-9]+.[0-9]+'
@ -56,6 +57,8 @@ jobs:
if: ${{ steps.docs.outputs.UPDATED_DOCS != 0 && inputs.check_only }} if: ${{ steps.docs.outputs.UPDATED_DOCS != 0 && inputs.check_only }}
run: | run: |
echo "Job failed, run ./scripts/gen_vimdoc.py and commit your doc changes" 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 exit 1
- name: Automatic PR - name: Automatic PR