New documentation for groups feature (Infra) #2208
Open
Conversation
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
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive documentation for the groups feature in Checkbox, enabling users to organize related test jobs that should run as a contiguous block.
Key changes:
- New how-to guide explaining groups functionality with practical examples
- Tutorial section demonstrating basic group usage with network tests
- Reference documentation for the
groupfield in job units
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/tutorial/writing-tests/test-case.rst | Adds tutorial section showing how to group network tests with setup/teardown |
| docs/reference/units/job.rst | Documents the group field and its dependency resolution rules |
| docs/how-to/using-groups.rst | New comprehensive guide with multiple examples of group usage patterns |
| docs/how-to/index.rst | Adds the new using-groups guide to the index |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <[email protected]>
pieqq
requested changes
Nov 19, 2025
| id: network_available | ||
| flags: simple | ||
| depends: network_available |
Collaborator
There was a problem hiding this comment.
Suggested change
| depends: network_available | |
| depends: network_setup |
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.
Description
This PR includes:
Resolved issues
https://warthogs.atlassian.net/browse/CHECKBOX-2012
Documentation
Tests