ci: run the docs validator test suite - #440
Open
HugoFernandezz wants to merge 1 commit into
Open
Conversation
tools/test_validate_docs.py has never run in CI. The workflow runs mypy over every file in tools/ (validate_docs.py included) but only executes the generator's tests, so the validator's 37 tests were dead weight -- a regression in the tool that gates every pull request would have gone unnoticed. Add a step alongside the generator test. Both suites are stdlib unittest and need no extra dependencies; the whole job stays under a second. Signed-off-by: HugoFernandezz <104948166+HugoFernandezz@users.noreply.github.com>
HugoFernandezz
force-pushed
the
ci/run-validate-docs-tests
branch
from
August 25, 2026 15:35
dbec0bc to
ccb2a15
Compare
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.
What's wrong
tools/test_validate_docs.pyhas never run in CI.test-open-tasks-generator.ymlrunsmypyover every file intools/—validate_docs.pyincluded — but only executestest_generate_open_tasks.py. The validator's 37 tests are dead weight, so a regression in the tool that gates every pull request from the Validate workflow would go unnoticed.How to reproduce
.github/workflows/test-open-tasks-generator.ymlhas a single test step,python3 tools/test_generate_open_tasks.py. Nothing anywhere in.github/workflows/mentionstest_validate_docs.py.The fix
One extra step next to the existing one. Both suites are stdlib
unittestand need no new dependencies; together they run in well under a second. The workflow already triggers ontools/**, which is exactly when these tests need to run.Note for maintainers
The workflow is still called "Test Open Tasks generator" though it already covers all of
tools/. Renaming it would be tidier, but it changes the check name and could break branch protection rules, so I left it alone — happy to rename in a follow-up if you'd prefer.Checks
python3 tools/test_generate_open_tasks.py→ 11 tests OKpython3 tools/test_validate_docs.py→ 37 tests OK (on this branch, without PR Pull request for Flipper One Docs #1's changes)