.github/workflows/api-docs-check.yml


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

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]'
      - 'runtime/lua/**.lua'
      - 'runtime/doc/**'

jobs:
  call-regen-api-docs:
    if: github.event.pull_request.draft == false
    permissions:
      contents: write
      pull-requests: write
    uses: ./.github/workflows/api-docs.yml
    with:
      check_only: true