update_groovy_doc_on_commit

[ngrozae]

🛠 Summary

JIRA/Issue if applicable.
Describe the changes.

🧪 Checklist

• Unit tests added.
• The documentation updated.
• Change follows security best practices.
  ``

[Copilot]

Pull request overview

This PR updates the on-commit Jenkins pipeline logic for selecting documentation tests, and adds a small snippet to the project README.

Changes:

• Adjusts how the list of changed documentation files is converted into a pytest -k filter in ci/build_test_OnCommit.groovy (Linux + Windows doc-test stages).
• Adds a short console example snippet to README.md.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File	Description
README.md	Adds a console snippet under the Contact section.
ci/build_test_OnCommit.groovy	Modifies construction of the pytest -k expression used to select documentation tests on Linux/Windows.

Suppressed comments (1)

ci/build_test_OnCommit.groovy:406

• Same issue as the Linux stage: prefixing each entry with - alters the pytest -k filter expression and can make it syntactically invalid or prevent any documentation tests from being selected. Use the unmodified list joined with or, and (if needed) create a separate formatted string for human-readable output.

                      def test_doc_files_str = test_doc_files_windows.split('\n').collect { '-' + it }.join(' or ')

[Copilot]

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

Suppressed comments (3)

ci/build_test_OnCommit.groovy:343

• test_doc_files_linux is populated with plain .md paths (e.g., from check_md_code_changes.sh or the commit override), but this code prepends an extra - to each entry. That changes the filter terms away from the actual paths and can prevent selecting the intended documentation tests.

                      def test_doc_files_str = test_doc_files_linux.split('\n').collect { '"' + '-' + it + '"' }.join(' or ')

ci/build_test_OnCommit.groovy:406

• test_doc_files_windows is populated with plain .md paths, but this code prepends an extra - to each entry. That changes the filter terms away from the actual paths and can prevent selecting the intended documentation tests.

                      def test_doc_files_str = test_doc_files_windows.split('\n').collect { "'" + '-' + it + "'" }.join(' or ')

README.md:84

• The README uses the non-standard "Github" capitalization; project documentation should use "GitHub".

If you have a question, a feature request, or a bug report, feel free to submit a Github issue.


```console
mkdir test