← Back to issue list

Better document how platform names work

View original Github issue

Metadata

Project
charmcraft
Number
#2087
Type
issue
State
open
Author
lengau
Labels
—
Created
Updated
Closed
—

Current evaluation

Platform-name documentation now covers valid arbitrary names, recommended names, multi-base conventions, and shorthand requirements, resolving the original documentation gap.

Suggested action: close resolved

Reason: The current platforms reference explains that names are arbitrary, recommends the build-for architecture for standard notation and <distribution>-<series>-<build-for-arch> for multi-base charms, and defines valid shorthand forms. Commit 47f94098 (#2104) updated the platforms reference, and 3313a280 (#2590) subsequently added the naming-rules section.

Evaluated by: mr-cal-bot

Impact: 38 Quick Win: 25 Complexity: 20 Confidence: 96 Actionability: 82

Issue body

### What needs to get done Currently it can be confusing to a user how platform names work, especially with multi-base platforms. We need clearer documentation around when you need a specific platform name and when `fred` is fine. ### Why it needs to get done See: https://github.com/canonical/charmcraft/pull/2080#discussion_r1917251250

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha
Impact: 38
Quick Win: 25
Complexity: 20
Confidence: 96
Actionability: 82
close resolved Platform-name documentation now covers valid arbitrary names, recommended names, multi-base conventions, and shorthand requirements, resolving the original documentation gap.
qwen/qwen3.6-35b-a3b
Impact: 30
Quick Win: 17
Complexity: 20
Confidence: 75
Actionability: 70
keep open Documentation request to clarify platform naming conventions, especially for multi-base platforms and when to use "fred" vs explicit names.
qwen/qwen3.8-27b
Impact: 35
Quick Win: 30
Staleness: 70
Complexity: 15
Confidence: 62
Support Request: 10
close stale Docs request to clarify how charmcraft platform names work, especially for multi-base platforms and when a specific name is needed vs. an arbitrary one like 'fred'. The platforms reference now states names are arbitrary and adds naming rules (PR #2590), so it appears addressed.
qwen/qwen3.6-35b-a3b
Staleness: 85
Complexity: 15
Confidence: 80
Support Request: 10
needs triage Request to improve documentation on platform naming conventions, particularly for multi-base platforms. Currently unlabelled and inactive for over a year with no maintainer response.
qwen3.6-35b-a3b-mtp-q6
Staleness: 85
Complexity: 15
Confidence: 80
Support Request: 10
needs triage Request to improve documentation on platform naming conventions, particularly for multi-base platforms, following recent user confusion. Currently unlabelled and inactive for over a year.
qwen3.6-35b-a3b-mtp-q6
Staleness: 85
Complexity: 15
Confidence: 85
Support Request: 10
close stale Request to improve documentation on platform name usage, particularly for multi-base platforms. Open for over a year with minimal interaction and no labels.

Update history

No update history recorded yet.

Related work

  • Related To: canonical/charmcraft#2590 (confidence 98%)

    This later change added an explicit naming-rules section covering permitted platform-name characters and reserved names.

  • Likely Fixed By: canonical/charmcraft#2104 (confidence 96%)

    The platforms-reference update documents naming recommendations and multi-base conventions requested by the issue.

Related issues

No related issues found above the similarity threshold.