docs: options for links in charmcraft unclear
Metadata
Current evaluation
charmcraft.yaml links section docs don't list allowed fields (contact, documentation, issues, source, website). Maintainer acknowledged and pointed to model definition; docs redo in progress but not yet merged.
Suggested action: keep open
Reason: Maintainer @lengau acknowledged the issue on 2025-07-22, confirmed the valid fields are defined in the Links model (contact, documentation, issues, source, website), and noted @jahn-junior is redoing these docs. The current docs still lack an explicit structure listing for links, so the gap persists. Valid, triaged, and awaiting the docs rework.
Impact:
20
Quick Win:
18.0
Staleness:
55
Complexity:
10
Confidence:
78
Support Request:
20
Issue body
*Please describe the question or issue you're facing with "charmcraft.yaml file - Charmcraft 3.5.2 documentation".*
It is unclear what is allowed to put in the `links:` section in the charmcraft.yaml. It seems that it is limited to specific fields, but those are not mentioned.
Example: I tried to link to upstream in it's own section with
```
links:
upstream:
- your-upstream-here
```
but got:
```
Bad charmcraft.yaml content:
- extra inputs are not permitted (in field 'links.upstream')
```
---
*Reported from: https://canonical-charmcraft.readthedocs-hosted.com/stable/reference/files/charmcraft-yaml-file/*
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.8-27b |
Impact:
20
Quick Win:
18.0
Staleness:
55
Complexity:
10
Confidence:
78
Support Request:
20
|
keep open | charmcraft.yaml links section docs don't list allowed fields (contact, documentation, issues, source, website). Maintainer acknowledged and pointed to model definition; docs redo in progress but not yet merged. | |
| qwen/qwen3.6-35b-a3b |
Staleness:
85
Complexity:
15
Confidence:
90
Support Request:
85
|
close not a bug | Clarification request for allowed fields in charmcraft.yaml links section. Maintainer pointed to the source schema, resolving the query. Issue has been inactive for over a year. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
85
Complexity:
20
Confidence:
80
Support Request:
10
|
keep open | Unclear documentation for valid values in the links section of charmcraft.yaml. Reporter encountered validation errors for unsupported fields. Maintainer pointed to source code model and noted docs are being rewritten. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
80
Complexity:
15
Confidence:
80
Support Request:
65
|
needs triage | Documentation request clarifying valid fields for the links section in charmcraft.yaml. A maintainer pointed to the source code model, but the issue remains unlabelled and pending official documentation updates. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
75
Complexity:
10
Confidence:
85
Support Request:
90
|
close not a bug | Documentation for valid fields in the charmcraft.yaml links section is unclear. Maintainers provided the source model defining allowed values and noted an internal documentation rewrite is underway. Awaiting docs update. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #2262 docs: hotfix for links syntax for charm docs examples | charmcraft | merged | Merged following approval by three reviewers. The change corrected link syntax in the Manage charms documentation and added a Charmhub Discourse link. All required CI checks passed before integration. | |
| #1498 docs: Fix 404 in charmcraft.yaml.j2 | charmcraft | closed | Merged to fix a 404 error in charmcraft.yaml.j2. The single-line change resolved the broken documentation link. Closed without reviews or CI checks. |