Issue 6039: Generate system test suite documentation - #7680
Merged
patchwork01 merged 1 commit intoJul 16, 2026
Conversation
patchwork01
approved these changes
Jul 16, 2026
Collaborator
|
Thanks very much for this! Waiting on a second review. |
Rob9786
approved these changes
Jul 16, 2026
rtjd6554
approved these changes
Jul 16, 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.
Issue
Tests
I added a unit test for SystemTestSuiteTable, verifying standard functionality.
I added an integration test for GenerateSystemTestSuiteDocumentation
Changes
Documentation
I changed the documentation in docs/development/dev-scripts.md and docs/development/system-tests.md to accurately reflect the new state of the repo with my changes applied.
SystemTestSuiteTable.java has a class-level comment as per repo style. SystemTestSuitable.create has a Javadoc.
GenerateSystemTestSuiteDocumentation.java has a class-level comment as per repo style. Added a Javadoc to both methods I thought needed a Javadoc.
Notes
I chose to keep the styling consistent with the old format by removing empty cells, however in my experience it is cleaner and easier to parse when you have explicitly empty cells. I am open to implementing this is preferred.
I added a note to dev-scripts.md to clarify that generateDocumentation.sh touches docker image documentation. I do recognise that this could be out of the scope of this PR, and I am happy to disregard the change, open a new PR or follow any procedure needed. I also added docs/deployment/docker-images.md to the workflow trigger list (located in java-status.yaml).
I noticed what could potentially be a bug - in the workflow trigger list (located in java-status.yaml) there is an entry referencing a root level directory "examples", which seems to not exist, however a directory called "example" does exist.
I implemented an atomic write using a temporary file, however I do not know if it was too convoluted for this repo. I felt that the safety and predictability it gave was worth it in a repo that prioritises such values, however I am open to making it a standard file write.