diff options
| author | Javier López <graulopezjavier@gmail.com> | 2022-03-26 07:22:03 -0500 |
|---|---|---|
| committer | Javier López <graulopezjavier@gmail.com> | 2022-03-26 12:38:36 -0500 |
| commit | 45dbb78747b8caea01fa11916f875bdcfa3ff09e (patch) | |
| tree | 4de23aa179461df127d021afea57a2766ed77475 | |
| parent | 85821d8b6fa366f7361f84e07e62dc8fc951f26d (diff) | |
| download | rneovim-45dbb78747b8caea01fa11916f875bdcfa3ff09e.tar.gz rneovim-45dbb78747b8caea01fa11916f875bdcfa3ff09e.tar.bz2 rneovim-45dbb78747b8caea01fa11916f875bdcfa3ff09e.zip | |
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]
| -rw-r--r-- | .github/workflows/api-docs-check.yml | 1 | ||||
| -rw-r--r-- | .github/workflows/api-docs.yml | 3 |
2 files changed, 4 insertions, 0 deletions
diff --git a/.github/workflows/api-docs-check.yml b/.github/workflows/api-docs-check.yml index 46922391f5..f76c035de4 100644 --- a/.github/workflows/api-docs-check.yml +++ b/.github/workflows/api-docs-check.yml @@ -7,6 +7,7 @@ on: paths: - 'src/nvim/api/*.[ch]' - 'runtime/lua/**.lua' + - 'runtime/doc/**' jobs: call-regen-api-docs: diff --git a/.github/workflows/api-docs.yml b/.github/workflows/api-docs.yml index 2e22a1200f..ce8ed7996a 100644 --- a/.github/workflows/api-docs.yml +++ b/.github/workflows/api-docs.yml @@ -7,6 +7,7 @@ on: paths: - 'src/nvim/api/*.[ch]' - 'runtime/lua/**.lua' + - 'runtime/doc/**' branches: - 'master' - 'release-[0-9]+.[0-9]+' @@ -56,6 +57,8 @@ jobs: if: ${{ steps.docs.outputs.UPDATED_DOCS != 0 && inputs.check_only }} run: | echo "Job failed, run ./scripts/gen_vimdoc.py and commit your doc changes" + echo "The doc generation produces the following changes:" + git --no-pager diff exit 1 - name: Automatic PR |