docs: make docs spread-testable
Metadata
Current evaluation
Merged PR #143 as commit 1676433, adding infrastructure to manually spread-test the restructured documentation without running docs spread tests in CI.
Resolution: closed resolved
Reason: PR #143 was approved and merged as commit 1676433. It made the documentation spread-testable for manual execution and intentionally did not add spread tests to CI.
Evaluated by: mr-cal-bot
No scores available.
Issue body
Requires #142
- [x] Have you followed the guidelines for contributing?
- [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
- [x] Have you successfully run `tox`?
-----
This doesn't include running spread tests for docs, just setting up the infrastructure to spread test them oneself.
The test passes on my machine using the command:
```
CRAFT_STORE_CHARMCRAFT_CREDENTIALS=$(cat ~/.charmhub-secret) SNAPCRAFT_STORE_CREDENTIALS=$(cat ~/.snapcraft-creds) spread -reuse -resend multipass:
```
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #143 as commit 1676433, adding infrastructure to manually spread-test the restructured documentation without running docs spread tests in CI. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged #143 via commit 1676433, adding infrastructure for manually spread-testing documentation after #142 split the docs into separate pages; docs tests were not added to CI. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged in canonical/craft-store#143 via commit 1676433, adding infrastructure for manually spread-testing documentation without adding docs tests to CI. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #143 added infrastructure to run documentation examples locally with Spread; it did not integrate them into CI. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged documentation spread-testing infrastructure setup. Approved by two reviewers and passing CI, the change modifies six files (+136/-41 lines) to enable local spread test execution for documentation. |
Update history
No update history recorded yet.
Related work
-
Related To:
canonical/craft-store#142
(confidence 99%)
Required prerequisite that separated documentation pages into individual files before #143 added spread-test infrastructure.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #2126 ci(docs): spread test documentation | charmcraft | merged | Merged PR #2126 in commit f1b73a6e, adding CI for documentation spread tests and adapting spread tasks for Google-hosted runners. | |
| #2029 Run documentation spread tests in CI | charmcraft | closed | Documentation spread tests were enabled in CI by merged PR #2126 (commit f1b73a6e), adding the docs spread workflow and fixes for Google-hosted runners. | |
| #1962 Spread test the documentation examples | charmcraft | open | Documentation examples are now covered by dedicated Spread tests and CI through merged PR #2126; the still-open issue should be closed. | |
| #2276 spread: move legacy wiki tests to spread | snapcraft | merged | Merged PR #2276 as commit 806b0b0db, moving all non-fake-server legacy wiki tests from the general integration suite to Spread. | |
| #5440 docs: reorganise pages | snapcraft | merged | Docs-only PR by medubelko reorganising documentation page hierarchy and chunking content (140 files, +504/-526). Approved by 2 reviewers and merged as commit 47574a240 after spread tests were unjammed. | |
| #153 test technical documentation | rockcraft | merged | Merged in PR #153 as 39d0d9ab: technical docs now reuse Spread-tested code blocks; READMEs and dependencies were updated and copybutton added. Fixes #54. | |
| #291 Refactor spread testing to use spread extensions | fetch-service | closed | Fixed by merged PR #299 (commit 44d9906), which refactored spread tests to generate spread.yaml and use the new spread extension framework. | |
| #1205 ci: make workflows conditional, add docs-only spread tests | rockcraft | closed | Superseded by merged PR canonical/rockcraft#1206 (commit 3624f64c), which implemented conditional CI and split source and docs Spread tests. | |
| #2313 Spread docs fixes | charmcraft | closed | Closed unmerged in favor of #2338, which replaced the Spread docs changes and merged as 8f83306c, moving docs tests from Google CI to self-hosted GitHub CI. |