← Back to issue list

docs: document the base key

View original Github issue

Metadata

Project
snapcraft
Number
#5681
Type
pull request
State
merged
Author
jahn-junior
Labels
—
Created
Updated
Closed

Current evaluation

Merged PR #5681 in commit caf905ce5, adding 17 lines documenting the snapcraft.yaml base key.

Resolution: closed resolved

Reason: The documentation change was approved by two reviewers and merged. Commit caf905ce5 records the change with the title “docs: document the base key (#5681)”.

Evaluated by: mr-cal-bot

No scores available.

Issue body

- [X] Have you followed the [guidelines for contributing](https://github.com/canonical/snapcraft/blob/main/CONTRIBUTING.md)? - [X] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)? - [X] Have you successfully run `make lint`? - [X] Have you successfully run `make test`? ---

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Merged PR #5681 in commit caf905ce5, adding 17 lines documenting the snapcraft.yaml base key.
stealth/space-bunny-alpha — closed resolved Merged documentation for the base key in PR #5681 via commit caf905ce5, adding 17 lines.
stealth/space-bunny-alpha — closed resolved Merged documentation update in PR #5681, adding 17 lines describing the base key; commit caf905ce5.
stealth/space-bunny-alpha — closed resolved Merged PR #5681, commit caf905ce5, documenting the base key in Snapcraft’s environment-variable reference.
qwen/qwen3.6-35b-a3b — — Merged documentation update adding 17 lines to document the base key. Approved by two reviewers with zero unresolved comments. CI passed except for one non-blocking test.
qwen3.6-35b-a3b-mtp-q6 — — Documentation for the base key was merged into the repository. The maintainer satisfied all linting and testing requirements, and the changes were accepted without additional review comments.

Update history

No update history recorded yet.

Related work

  • Related To: canonical/snapcraft#6042 (confidence 65%)

    Later PR #6042 reworded the validation error for the same base key.

Related issues

Issue Project State Summary Similarity
#1706564 Please allow the new "base" key in snapcraft.yaml snapcraft (launchpad) closed Added support for snapcraft.yaml's top-level base key in merged snapcore/snapcraft PR #1419 (commit 024b9203c).
78%
#5566 docs: add part keys to `snapcraft.yaml` reference snapcraft merged Merged PR #5566 (commit aee7fe47c, "docs: add part keys to snapcraft.yaml reference") added updated part-key descriptions to the snapcraft.yaml reference; approved by 2 reviewers and shipped in Snapcraft 8.9.5.
76%
#131 add document detailing the snapcraft.yaml syntax snapcraft merged Merged snapcraft.yaml syntax documentation in commit 0039afb12 (merge 4a1f3ff2a); PR #146 later refined the 1.x reference.
72%
#2411 cli: snapcraft init with a base snapcraft merged Merged #2411 as commit 0aa5508a, adding syntax-documentation links after snapcraft init and addressing LP bug #1803776.
72%
#6043 docs: remove duplicate app keys from 'snapcraft.yaml' snapcraft merged Docs-only PR merged as commit 6a43e5742 ("docs: remove duplicate app keys from 'snapcraft.yaml'"), fixing a copy-paste duplication in the snapcraft.yaml reference after 3 approvals; +6/-4 lines in one doc file.
71%
#6293 docs: group app keys into general and daemon sections snapcraft merged Merged PR #6293 via commit 16474a7d3, reorganizing snapcraft.yaml app keys into general and daemon-specific sections.
71%
#5409 docs: migrate 'migrate between bases' snapcraft merged Merged in snapcraft#5409 via commit 30aeaf036, migrating and restructuring the documentation for changing snap bases.
71%
#5571 docs: update 'snapcraft.yaml' key types snapcraft merged Merged PR #5571 updated snapcraft.yaml type presentation for parts, components, and package repositories, and added missing build-attributes headers.
71%
#5511 snapcraft.yaml reference documentation missing descriptions for part keys snapcraft closed Missing part-key descriptions in the new snapcraft.yaml reference were added by merged PR #5566 (commit aee7fe47c), shipped in Snapcraft 8.9.5; tracked internally as CRAFT-4488/SNAPCRAFT-1145 and issue closed by mr-cal.
70%
#4900 docs: add explanation, reference, and how to for bases snapcraft merged 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).
70%