docs: update release step with resource details
Metadata
Current evaluation
Merged documentation update adding resource attachment details to the charm release example, resolving issue #2171. Standardizes charm names across the Publish section. Approved by two reviewers, passed CI, and applied with a minimal eight-line change.
Suggested action: —
No scores available.
Issue body
The HTG Manage charms / Publish > Release example did not include resources, although (1) resources had been mentioned previously and (2) the way to attach them at release time is easy to forget. This has resulted in an issue even for an otherwise expert user: https://github.com/canonical/charmcraft/issues/2171 This PR fixes that. (It also makes the name of the charm the same across all the examples in the Publish section.)
@erik78se Thanks for the example output for releasing with a resource.
Fixes #2171
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | Merged documentation update adding resource attachment details to the charm release example, resolving issue #2171. Standardizes charm names across the Publish section. Approved by two reviewers, passed CI, and applied with a minimal eight-line change. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation update adding resource attachment details to the release step example and standardizing charm names across the Publish section. Resolves issue #2171. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation update adding missing resource details to the release example, resolving issue #2171. Also standardizes the charm name across all Publish section examples. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #259 Support for attaching resources when releasing charms. | charmcraft | merged | Merged after two approvals. Adds support for attaching resources during charm releases, modifying seven files with 188 additions and 26 deletions to update the release workflow. | |
| #2240 docs: update charm definition in security doc | charmcraft | merged | Merged documentation update revising the charm definition in the security guide. Incorporated feedback from a prior discussion, approved by two reviewers, passed CI checks, and successfully merged with minimal line changes. | |
| #2171 "Publish a charm to Charmhub" should include an example with your first resource. | charmcraft | closed | Documentation updated to show how to attach specific resource revisions when publishing charms. Resolved and merged via pull request #2172. | |
| #2748 docs: improve charm naming docs, with links to detailed guidance | charmcraft | merged | Merged documentation updates improving charm naming guidance. Changes remove outdated best practice notes, add value descriptions, link to detailed Ops documentation, and clarify the init command workflow. Approved and merged to resolve issue #2582. | |
| #262 Support resources when showing charm status. | charmcraft | merged | Merged to implement resource support for charm status display, resolving issue #176. Approved by two reviewers as the final step in a related sequence. Changes modify four files with 206 additions and 25 deletions. | |
| #2734 docs: improve versioning logic | charmcraft | merged | Merged after approval and passing CI checks. Updated documentation versioning logic to label the latest release as Charmcraft dev documentation. Integrated with minimal changes ahead of the 4.3 tag. | |
| #471 config: add charm part to documentation (CRAFT-356) | charmcraft | merged | Merged changes adding charm configuration documentation to the configuration schema. Approved by two reviewers with zero unresolved comments. Updated two files with 15 additions and one deletion. Resolves CRAFT-356. | |
| #847 Improve the 'release' response when resources are automatically released with the charm | charmcraft | open | Request to enhance the 'charmcraft release' command output to list resources that Charmhub automatically attaches when a revision is released without explicit --resource flags. Store-side fix was released in 2022, but the client-side message enhancement remains unimplemented. | |
| #2253 docs: add charm docs exemplars links | charmcraft | merged | Merged after approval and CI checks. Added links to charm documentation exemplars to improve guidance. Updated one file with 34 additions and 5 deletions as part of a documentation standardization initiative. | |
| #2300 docs: update "manage configurations" | charmcraft | merged | Merged after two reviewers approved. Updated Charmcraft documentation links and renamed the section to Manage the app configuration per feedback. All CI checks passed and changes were integrated. |