[doc-only] Improve CI workflow comments for maintainability #1504
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
Clarify why build and test jobs are split by platform rather than using a matrix: to allow independent dependencies so faster platforms can proceed through build & test without waiting for slower ones. Document the allowed textual differences between job definitions. Also unify the if: conditions across test jobs for consistency.
Contributor
Contributor
Author
|
/ok to test b404012 |
This comment has been minimized.
This comment has been minimized.
mdboom
approved these changes
Jan 15, 2026
Contributor
Author
|
pre-commit.ci run |
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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
if:conditions across test jobs for consistencyChanges
This is a documentation/comment-only change to
ci.yml. No functional changes to the CI behavior.Build jobs:
host-platformvalue andif:conditionTest jobs:
if:conditions uniform (added doc-only check to all test jobs)should-skiptoneeds:where required