docs: add platform naming rules
Metadata
Current evaluation
PR #2590 by lengau was approved by two reviewers and merged into main as commit 3313a280, adding craft-application's platform naming rules to docs/reference/platforms.rst (docs-only, +49/-13).
Resolution: closed resolved
Reason: The pull request itself was merged: commit 3313a280 ("docs: add platform naming rules (#2590)") appears in the history of docs/reference/platforms.rst, and the new 'Naming rules' section (anchor reference-platforms-naming) is present in main. The failing CI jobs and 9 unresolved review comments are pre-existing/unrelated ty type-check and platform-specific test failures, not caused by this docs-only change.
Evaluated by: mr-cal-bot
No scores available.
Issue body
This adds the platform naming rules reference from craft-application.
Rendered: https://canonical-ubuntu-documentation-library--2590.com.readthedocs.build/charmcraft/2590/reference/platforms/#naming-rules
---
- [x] I've followed the [contribution guidelines](https://github.com/canonical/charmcraft/blob/main/CONTRIBUTING.md).
- [x] I've signed the [CLA](http://www.ubuntu.com/legal/contributors/).
- [x] I've successfully run `make lint && make test`.
- [x] I've added or updated any relevant documentation.
- [x] I've updated the relevant release notes.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | PR #2590 by lengau was approved by two reviewers and merged into main as commit 3313a280, adding craft-application's platform naming rules to docs/reference/platforms.rst (docs-only, +49/-13). | |
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #2590 as commit 3313a280, adding craft-application's platform naming rules to the platforms reference. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #2590 as commit 3313a280, adding craft-application's platform naming rules to the platforms reference. The documentation change was approved by two reviewers. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged documentation update adding platform naming rules from craft-application. Approved by two reviewers. Integrated despite non-blocking CI test failures and type checker notifications. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation update adding platform naming rules from craft-application. Automated type checking flagged unrelated unresolved attribute errors, but the bot noted they require no action. The changes were successfully integrated. |
Update history
No update history recorded yet.
Related work
-
Related To:
canonical/charmcraft#2080
(confidence 45%)
PR #2080 originally added the platforms reference page that this change extends.
-
Related To:
canonical/craft-application#1
(confidence 40%)
The included file /common/craft-application/reference/strict-platform-names.rst originates from the craft-application docs, which is the source of the naming rules content.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #6092 docs(reference): add platform naming rules | snapcraft | merged | Merged platform naming rules into the reference docs and bumped craft-application; the related lint fix was handled in canonical/craft-application#1023 (commit 83c5b7d4e). | |
| #1130 docs: add platform naming rules | rockcraft | merged | Merged PR #1130 in commit c32a5ef0, adding Craft Application's platform naming rules to Rockcraft's documentation. | |
| #2104 docs: update platforms reference | charmcraft | merged | Merged PR #2104 (commit 47f94098), updating the platforms reference with minor corrections from review feedback on #2080. | |
| #1012 docs: add platform naming snippet | craft-application | merged | Merged #1012 as commit 0ab97a38, adding platform-naming documentation across four files with separate guidance for snaps and rocks. | |
| #213 docs: add 'Platform grammar' reference | imagecraft | merged | Merged in #213 via commit 11fee3f, adding platform-grammar and for-statement docs with Craft Grammar 2.3.0 features enabled after PR #207 merged. | |
| #936 feat!(platform): add reserved platform names | craft-application | merged | Merged PR #936 (commit b534c8a8) adding RESERVED_PLATFORM_NAMES in craft_application/models/platforms.py, blocking '*' and 'any'; fixes #890 (CRAFT-4747). Includes ruff 0.14.0 bump. | |
| #6069 docs: rewrite platform docs | snapcraft | merged | Merged PR #6069 (88b36a7d6) rewrote platform docs, renamed architectures to platforms, dropped core20, added core26, and fixed #6039. | |
| #947 feat!(platforms): prevent use of '/' in platform names | craft-application | merged | Merged PR #947 as commit f7f3b1ff, adding validation that rejects platform names containing "/" and fixing #941 (CRAFT-4876). | |
| #84 fix: do not strip base from platform names | craft-platforms | merged | Merged PR #84 via commit 7680af2: shorthand platform names now retain their base, preventing duplicate BuildInfo names required by craft-application. |