mirror of
https://github.com/neovim/neovim.git
synced 2025-01-02 17:33:28 -07:00
01e82eba20
Summary: Separate the lint job (`make lintdoc`) to validate runtime/doc, it is no longer as a part of functionaltest (help_spec). Build (cmake) and CI: - `make lintdoc`: validate vimdoc files and test-generate HTML docs. CI will run this as a part of the "docs" workflow. - `scripts/lintdoc.lua` is added as an entry point (executable script) for validating vimdoc files. scripts/gen_help_html.lua: - Move the tests for validating docs and generating HTMLs from `help_spec.lua` to `gen_help_html`. Added: - `gen_help_html.run_validate()`. - `gen_help_html.test_gen()`. - Do not hard-code `help_dir` to `build/runtime/doc`, but resolve from `$VIMRUNTIME`. Therefore, the `make lintdoc` job will check doc files on `./runtime/doc`, not on `./build/runtime/doc`. - Add type annotations for gen_help_html.
38 lines
1020 B
YAML
38 lines
1020 B
YAML
name: docs
|
|
on:
|
|
pull_request:
|
|
types: [opened, synchronize, reopened, ready_for_review]
|
|
paths:
|
|
- 'src/nvim/api/*.[ch]'
|
|
- 'src/nvim/eval.lua'
|
|
- 'runtime/lua/**.lua'
|
|
- 'runtime/doc/**'
|
|
- 'scripts/gen_vimdoc.py'
|
|
- 'scripts/gen_help_html.lua'
|
|
jobs:
|
|
docs:
|
|
runs-on: ubuntu-latest
|
|
if: github.event.pull_request.draft == false
|
|
permissions:
|
|
contents: write
|
|
pull-requests: write
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- uses: ./.github/actions/setup
|
|
|
|
- name: Install dependencies
|
|
run: |
|
|
sudo apt-get install -y doxygen python3-msgpack
|
|
|
|
- name: Generate docs
|
|
run: |
|
|
make doc
|
|
if [ -n "$(git status --porcelain)" ]; then
|
|
echo "::error::Job failed, run 'make doc' and commit your doc changes."
|
|
echo "::error::The doc generation produces the following changes:"
|
|
git diff --color --exit-code
|
|
fi
|
|
|
|
- name: Validate docs
|
|
run: make lintdoc
|