docs: recommend spread directly, rather than charmcraft test - #2706
Merged
tonyandrewmeyer merged 7 commits intoAug 27, 2026
Conversation
The docs presented `charmcraft test` as the way to run integration tests in parallel, with spread only mentioned as the thing underneath it, and the parallel CI recipe was gated on the experimental `charmcraft init` test profiles. `charmcraft test` is a wrapper around spread, and isn't finalised, so the advice we want to give is to adopt spread: the `spread.yaml` and `task.yaml` files keep working whatever shape the wrapper ends up with. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
tonyandrewmeyer
marked this pull request as ready for review
August 26, 2026 01:26
The minimal workflow just below it has a hard-coded matrix, so adding a task.yaml does nothing until you edit the matrix as well. The dynamic-discovery paragraph further down already makes the claim, where it is true.
The lead-in above it says the tutorial uses the wrapper, and the command that follows is charmcraft init rather than charmcraft test, so framing it as something to try if interested doesn't match either side.
dwilding
approved these changes
Aug 27, 2026
tromai
approved these changes
Aug 27, 2026
tromai
left a comment
tromai
left a comment
Contributor
There was a problem hiding this comment.
Thanks for the PR.
I agree with David's comments. Everything else looks great to me.
Capitalise Spread as a proper noun throughout the prose (leaving filenames, paths and the workflow example alone), and take David's simplifications to the `charmcraft test` explanations in the CI how-to and the tutorial. Also point the integration testing how-to at the new set-up-ci-spread section rather than the more general set-up-ci-integration one, since that is where the per-module fan-out is described. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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
3 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.
The integration testing docs presented
charmcraft testas the way to run tests in parallel, with spread only appearing as a description of what the experimentalcharmcraft inittest profiles generate. Sincecharmcraft testis a wrapper around spread and isn't finalised, the advice we want to be giving is to use spread, which is also what is currently recommended to charm teams.charmcraft inittest profiles to get the parallel setup - any charm can addspread.yamland aspreaddirectory by hand.charmcraft test, since it installs and configures spread for you, but says that's why.charmcraft testfor convenience, and notes that thespread.yamlandtask.yamlfiles are the part that survives if the wrapper changes.