docs: add explanation, reference, and how to for bases
Metadata
Current evaluation
PR merged as commit 91fa63c47, adding explanation, reference and how-to docs pages for bases/build-bases (+369 lines, 8 files) to support documenting kernel snap builds (CRAFT-3083).
Resolution: closed resolved
Reason: The PR itself was merged into snapcraft as commit 91fa63c47 ("docs: add explanation, reference, and how to for bases (#4900)"), approved by 2 reviewers. Unresolved test failures were unrelated and tracked separately in #4910; follow-up doc commits (#5159, #5256, #5409) refined the same pages.
Evaluated by: mr-cal-bot
No scores available.
Issue body
- [x] Have you followed the [guidelines for contributing](https://github.com/snapcore/snapcraft/blob/master/CONTRIBUTING.md)?
- [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
- [x] Have you successfully run `tox run -m lint`?
- [x] Have you successfully run `tox run -e test-py310`? (supported versions: `py39`, `py310`, `py311`, `py312`)
-----
My task is to document how to use `base` and `build-base` for a kernel snap. This required laying groundwork:
* import bases documentation from https://snapcraft.io/docs/base-snaps
* This is a 5-year-old doc with minimal upkeep and wasn't a great starting point
* add [explanation](https://canonical-snapcraft--4900.com.readthedocs.build/en/4900/explanation/bases.html), [reference](https://canonical-snapcraft--4900.com.readthedocs.build/en/4900/reference/bases.html), and [how-to](https://canonical-snapcraft--4900.com.readthedocs.build/en/4900/howto/bases.html) pages for bases
(CRAFT-3083)
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | PR merged as commit 91fa63c47, adding explanation, reference and how-to docs pages for bases/build-bases (+369 lines, 8 files) to support documenting kernel snap builds (CRAFT-3083). | |
| stealth/space-bunny-alpha | — | closed resolved | Merged in canonical/snapcraft#4900 via 91fa63c47, adding explanation, reference, and how-to documentation for base/build-base configuration. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged documentation updates adding explanation, reference, and how-to pages for base and build-base configuration. Content was refined based on reviewer feedback and incorporates existing craft-parts documentation. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation adding explanation, reference, and how-to pages for base and build-base configuration. Review feedback refined content to focus on current kernel snap building methods. Unrelated test failures tracked separately. |
Update history
No update history recorded yet.
Related work
-
Related To:
canonical/snapcraft#4910
(confidence 72%)
Author noted spread test failures seen in CI were unrelated to this docs PR.
-
Related To:
canonical/snapcraft#5159
(confidence 60%)
Follow-up commit c58add3a5 made minor fixes to the bases.rst reference page added by this PR.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #597 doc: add explanation and guide for "bases" | rockcraft | merged | Merged #597 as b8025970, adding Bases documentation and a rock-to-baseless/chiselled conversion guide, fixing devel references, and linking the init YAML template. | |
| #4914 feat: allow interim bases for kernel snaps | snapcraft | merged | Merged PR #4914 added interim base/build-base support for kernel snaps, updated documentation and spread tests, and fixed #4868. | |
| #6426 feat: add build-base to kernel snaps | snapcraft | closed | Merged PR #6426 (commit dd924c747), adding build-base to kernel snap metadata so users can verify build-environment and target-system compatibility. | |
| #5681 docs: document the base key | snapcraft | merged | Merged PR #5681 in commit caf905ce5, adding 17 lines documenting the snapcraft.yaml base key. |