diff options
| author | Yuriy Andamasov <yuriy@vyos.io> | 2026-05-14 00:49:50 +0300 |
|---|---|---|
| committer | Yuriy Andamasov <yuriy@vyos.io> | 2026-05-14 00:49:50 +0300 |
| commit | 1ef5684729646ca3a24aff83ab8edd0aa57914c7 (patch) | |
| tree | fc89c7d027957b377ad9bb9fd0fa5259f59f9007 /docs/_static/css | |
| parent | 379ed4757b62a7c1df965a59bc4f1fd0cef2d3e8 (diff) | |
| download | vyos-documentation-1ef5684729646ca3a24aff83ab8edd0aa57914c7.tar.gz vyos-documentation-1ef5684729646ca3a24aff83ab8edd0aa57914c7.zip | |
ci(doc-linter): lint added + renamed files, not only modified
Previous workflow:
env:
FILES_MODIFIED: ${{ steps.file_changes.outputs.files_modified }}
run: python scripts/doc-linter.py "$FILES_MODIFIED"
`trilom/file-changes-action`'s `files_modified` output is
modifications-only. A PR adding a new `.md`/`.rst` doc page passed
`files_added`, never `files_modified`, so a brand-new page with long
lines or real public IPs slipped past the linter entirely.
Workflow: also pass `files_added` and `files_renamed` as separate
positional args. Each output is a JSON array (action v1.2.4) and is
passed via env to avoid shell-quoting issues.
Linter: `main()` now accepts one OR multiple positional argv entries,
each a JSON array of paths. Arrays are merged and deduplicated before
linting. Single-arg invocations remain backward-compatible. Switched
from `ast.literal_eval` to `json.loads` — the action's outputs are
JSON, and `json.loads` is the right tool (and dodges
literal_eval-via-`eval`-substring linter warnings).
Test coverage:
- Two JSON arrays merge -> single linter run on union.
- Empty-string argv entry skipped (no `files_renamed` in many PRs).
- Malformed JSON -> falls back to walking DOCS_ROOT.
- No argv -> walks DOCS_ROOT.
- Single-arg invocation -> backward-compat preserved.
Tracked as item 7 of the rolling-side cleanup backlog from PR #2014 /
#2019 / #2020 reviews.
🤖 Generated by [robots](https://vyos.io)
Diffstat (limited to 'docs/_static/css')
0 files changed, 0 insertions, 0 deletions
