CVS-188020_on_commit_doc_tests#4272
Open
ngrozae wants to merge 14 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Enables documentation testing in the on-commit CI pipeline by detecting Markdown changes within shell/console fenced code blocks and conditionally running a documentation test suite.
Changes:
- Added
ci/check_md_code_changes.shto identify changed.mdfiles where edits overlap withbash/bat/```console blocks. - Updated
ci/build_test_OnCommit.groovyto collect those files and run a new “Documentation tests” stage when applicable. - Introduced placeholder text/commands in several demo READMEs (these should be removed before merging).
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
demos/vehicle_analysis_pipeline/python/README.md |
Adds a placeholder command inside a bash snippet (should be removed). |
demos/universal-sentence-encoder/README.md |
Adds a placeholder command inside a bash snippet (should be removed). |
demos/person_vehicle_bike_detection/python/README.md |
Adds placeholder text under prerequisites (should be removed). |
demos/embeddings/README.md |
Adds placeholder text in the demo instructions (should be removed). |
ci/check_md_code_changes.sh |
New script to detect Markdown code-block-overlapping changes (has correctness tweaks needed). |
ci/build_test_OnCommit.groovy |
Wires the detection into Jenkins and adds a documentation test stage; introduces a sequential release-image stage impacting parallelism. |
ngrozae
force-pushed
the
on_commit_doc_tests
branch
2 times, most recently
from
0c8c09f to
eebde43
Compare
ngrozae
force-pushed
the
on_commit_doc_tests
branch
from
eebde43 to
fa6a1d2
Compare
ngrozae
force-pushed
the
on_commit_doc_tests
branch
9 times, most recently
from
1b6e538 to
b0256d5
Compare
…inux_doc=ovms_lnl][agent_name_windows_doc=ovms_win_lnl] add parameters override from commit
ngrozae
force-pushed
the
on_commit_doc_tests
branch
4 times, most recently
from
25b1a44 to
8e853de
Compare
…nged_files_windows=demos/continuous_batching/README.md][agent_name_linux_doc=ovms_lnl] updates
ngrozae
force-pushed
the
on_commit_doc_tests
branch
2 times, most recently
from
731e099 to
faca86f
Compare
ngrozae
force-pushed
the
on_commit_doc_tests
branch
from
faca86f to
036d60f
Compare
ngrozae
force-pushed
the
on_commit_doc_tests
branch
4 times, most recently
from
cd0689e to
a859749
Compare
…nged_files_windows=demos/continuous_batching/README.md][agent_name_linux_doc=ovms_lnl] cleanup
…nged_files_windows=demos/continuous_batching/README.md][agent_name_linux_doc=ovms_lnl] add input validation
ngrozae
force-pushed
the
on_commit_doc_tests
branch
from
a859749 to
4c2c172
Compare
dtrawins
reviewed
Jun 9, 2026
| // [agent_name_windows_doc=<node>] - Run Windows doc tests on <node> (default: ovms_win_ptl) | ||
| // | ||
| // Override file list (space-separated, converted to pytest -k filter joined with ' or '): | ||
| // [doc_changed_files_linux=<files>] - Use <files> instead of auto-detected list (Linux) |
Collaborator
There was a problem hiding this comment.
Suggested change
| // [doc_changed_files_linux=<files>] - Use <files> instead of auto-detected list (Linux) | |
| // [test_doc_files_linux=<files>] - Use <files> instead of auto-detected list (Linux) |
Collaborator
There was a problem hiding this comment.
it will be easier to remember
| // [disable_doc_tests_windows] - Skip the Windows documentation tests stage | ||
| // | ||
| // Override agent node: | ||
| // [agent_name_linux_doc=<node>] - Run Linux doc tests on <node> (default: ovms_ptl) |
Collaborator
There was a problem hiding this comment.
Suggested change
| // [agent_name_linux_doc=<node>] - Run Linux doc tests on <node> (default: ovms_ptl) | |
| // [test_agent_linux=<node>] - Run Linux doc tests on <node> (default: ovms_ptl) |
It will be easier to remember
Collaborator
Author
There was a problem hiding this comment.
this name was chosen to match previously used: agent_name_linux. Do you want only agent_name_linux_doc changed?
Collaborator
There was a problem hiding this comment.
I see your point but agent_name_linux is not to be defined in commit message. I think shorted name for will be less error prone when it needs to be entered manually. It is not a blocker from me but a suggestion. Let's check other reviewers.
| @@ -1,43 +1,47 @@ | |||
|
|
|||
| custom_nodes | |||
| libOpenCL.so->libOpenCL.so.1.0.0 | |||
Collaborator
There was a problem hiding this comment.
are those changes related?
Collaborator
Author
There was a problem hiding this comment.
needed after change from redhat to ubuntu as default os
dtrawins
reviewed
Jun 9, 2026
dtrawins
left a comment
dtrawins
left a comment
Collaborator
There was a problem hiding this comment.
can we rename the special tags?
dtrawins
approved these changes
Jun 9, 2026
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
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.
🛠 Summary
CVS-188020 enable documentation testing in CI
🧪 Checklist
``