mirror of
https://github.com/neovim/neovim.git
synced 2025-09-05 19:08:15 +00:00
b257480955
Having a workflow that creates a PR with the necessary changes on master
is redundant as this check is enforced for each PR anyway.
(cherry picked from commit c84e668242)
39 lines
1.1 KiB
YAML
39 lines
1.1 KiB
YAML
# Check if any PR needs to run the autogenerate script
|
|
name: Autogenerate API docs
|
|
on:
|
|
pull_request:
|
|
paths:
|
|
- 'src/nvim/api/*.[ch]'
|
|
- 'runtime/lua/**.lua'
|
|
- 'runtime/doc/**'
|
|
|
|
jobs:
|
|
regen-api-docs:
|
|
runs-on: ubuntu-latest
|
|
permissions:
|
|
contents: write
|
|
pull-requests: write
|
|
steps:
|
|
- uses: rhysd/action-setup-vim@v1
|
|
with:
|
|
neovim: true
|
|
version: nightly
|
|
- uses: actions/checkout@v3
|
|
- name: Install dependencies
|
|
run: |
|
|
sudo apt-get update
|
|
sudo env DEBIAN_FRONTEND=noninteractive apt-get install -y doxygen python3 python3-msgpack
|
|
|
|
- name: Generate docs
|
|
id: docs
|
|
run: |
|
|
python3 scripts/gen_vimdoc.py
|
|
printf 'UPDATED_DOCS=%s\n' $([ -z "$(git diff)" ]; echo $?) >> $GITHUB_OUTPUT
|
|
|
|
- name: FAIL, PR has not committed doc changes
|
|
if: ${{ steps.docs.outputs.UPDATED_DOCS != 0 }}
|
|
run: |
|
|
echo "Job failed, run ./scripts/gen_vimdoc.py and commit your doc changes"
|
|
echo "The doc generation produces the following changes:"
|
|
git diff --color --exit-code
|