From 91914010252a1f5c8a3358d09c3be92f30585ee3 Mon Sep 17 00:00:00 2001 From: Javier López Date: Fri, 18 Mar 2022 10:46:35 -0500 Subject: 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] --- .github/workflows/api-docs-check.yml | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 .github/workflows/api-docs-check.yml (limited to '.github/workflows/api-docs-check.yml') diff --git a/.github/workflows/api-docs-check.yml b/.github/workflows/api-docs-check.yml new file mode 100644 index 0000000000..8ae6e6ff92 --- /dev/null +++ b/.github/workflows/api-docs-check.yml @@ -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 -- cgit