fix(ci): regenerate the tracked vimdoc in docs-check - #17
Merged
Merged
Conversation
lettertwo
force-pushed
the
fix/docs-check-ci
branch
from
September 3, 2026 22:01
bcfc922 to
1142eb0
Compare
The docs-check action passed `vimdoc: occurrence.nvim`, so panvimdoc wrote an untracked `doc/occurrence.nvim.txt` while the tracked file is `doc/occurrence.txt` (the Makefile's `--project-name occurrence`). The `git diff doc/` check only sees tracked files, so it never noticed the untracked output and always reported "no changes" — the gate was a silent no-op and README drift never failed CI. Align the action with the Makefile: `vimdoc: occurrence` and `version: NVIM >= 0.10.0` (was `v0.10.0`). The action's other flags already match panvimdoc.sh's defaults, so CI now regenerates the same `doc/occurrence.txt` that `make doc` produces. Also fix the stale `doc/occurrence.nvim.txt` path in the docs-update PR body.
lettertwo
force-pushed
the
fix/docs-check-ci
branch
from
September 3, 2026 22:09
1142eb0 to
4e33df7
Compare
Now that the docs-check action regenerates the tracked doc/occurrence.txt, it reports a diff on every PR: the tracked file was generated with a vendored panvimdoc from August 2025, while CI runs panvimdoc@main, which has since changed the title-line format (kdheepak/panvimdoc#72) and how code fences inside list items are rendered (kdheepak/panvimdoc#74). Regenerate with the vendored clone moved to upstream main. The result matches CI's output line for line, so the check passes. No README content changed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Background
The
docs-checkcomposite action passedvimdoc: occurrence.nvimto panvimdoc, which maps to--project-name, so it wrote an untrackeddoc/occurrence.nvim.txt. The tracked file isdoc/occurrence.txt(the Makefile uses--project-name occurrence). The action then runsgit diff doc/, which only sees tracked files, so the untracked wrong-named output was invisible and the check always reported "no changes."The result: the docs gate was a silent no-op. A README change without a regenerated vimdoc never failed CI, and the auto-update workflow never fired. The version string also mismatched (
NVIM >= v0.10.0vs the Makefile'sNVIM >= 0.10.0).Fix
Align the action with the Makefile:
vimdoc: occurrenceandversion: NVIM >= 0.10.0. The action's remaining flags (toc,dedupsubheadings,treesitter,ignorerawblocks,demojify,docmapping,docmappingprojectname, the heading-shift options, and the date pattern) already equal panvimdoc.sh's defaults, which is whatmake docrelies on, so CI now regenerates the samedoc/occurrence.txtthat contributors produce locally. Also corrects the staledoc/occurrence.nvim.txtreference in the docs-update PR body.Testing
make docon this branch produces no change todoc/, confirming the tracked vimdoc is already current with the local generator, so the corrected check will pass on a clean tree rather than flag a false diff. The generation flags were compared line by line againstvendor/panvimdoc/panvimdoc.shdefaults and match.