ci(docs): add a check for PR's to commit their doc changes

Repurpose the api-docs workflow to also run in all PR's but work only as
a check, if the changes in the PR introduce doc changes that are not
committed fail.

[skip ci]
This commit is contained in:
Javier López
2022-03-18 10:46:35 -05:00
parent 9e66d27d37
commit 9191401025
2 changed files with 32 additions and 0 deletions

17
.github/workflows/api-docs-check.yml vendored Normal file
View File

@@ -0,0 +1,17 @@
name: Missing API docs
on:
pull_request:
types: [opened, synchronize, reopened, ready_for_review]
branches-ignore:
- 'marvim/api-doc-update**'
paths:
- 'src/nvim/api/*.[ch]'
- 'src/nvim/**.lua'
- 'runtime/lua/**.lua'
jobs:
call-regen-api-docs:
if: github.event.pull_request.draft == false
uses: ./.github/workflows/api-docs.yml
with:
check_only: true