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

name: Missing API docs
on:
  pull_request:
    branches-ignore:
      - 'marvim/api-doc-update**'
    paths:
      - 'src/nvim/api/*.[ch]'
      - 'runtime/lua/**.lua'
      - 'runtime/doc/**'

jobs:
  call-regen-api-docs:
    permissions:
      contents: write
      pull-requests: write
    uses: ./.github/workflows/api-docs.yml
    with:
      check_only: true
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] 2022-03-18 08:46:35 -07:00			`name: Missing API docs`
			`on:`
			`pull_request:`
			`branches-ignore:`
			`- 'marvim/api-doc-update**'`
			`paths:`
			`- 'src/nvim/api/*.[ch]'`
			`- 'runtime/lua/**.lua'`
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] 2022-03-26 05:22:03 -07:00			`- 'runtime/doc/**'`
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] 2022-03-18 08:46:35 -07:00
			`jobs:`
			`call-regen-api-docs:`
fix(ci): provide necessary permissions for calling workflow Also error on the side of security adding an extra check on the automatic PR step. 2022-03-21 20:40:24 -07:00			`permissions:`
			`contents: write`
			`pull-requests: write`
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] 2022-03-18 08:46:35 -07:00			`uses: ./.github/workflows/api-docs.yml`
			`with:`
			`check_only: true`