docs: update release step with resource details
Metadata
Current evaluation
Merged documentation PR #2172 in commit df9125d6, adding resource-attachment details and consistent charm naming to the Charmhub release example; it fixes #2171.
Resolution: closed resolved
Reason: PR #2172 was merged as commit df9125d6 and updated the release documentation to show how to attach a resource revision. The change explicitly fixes issue #2171.
Evaluated by: mr-cal-bot
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 |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged documentation PR #2172 in commit df9125d6, adding resource-attachment details and consistent charm naming to the Charmhub release example; it fixes #2171. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged docs PR #2172 (commit df9125d6), adding resource attachment details to the release example and standardizing charm names; fixes #2171. | |
| 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. |
Update history
No update history recorded yet.
Related work
-
Related To:
canonical/charmcraft#2171
(confidence 100%)
PR #2172 explicitly declares that it fixes issue #2171, which asked for a release example including a resource.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #2171 "Publish a charm to Charmhub" should include an example with your first resource. | charmcraft | closed | Documentation now shows how to attach a resource revision when releasing a charm; fixed by merged PR canonical/charmcraft#2172 (commit df9125d6). | |
| #262 Support resources when showing charm status. | charmcraft | merged | Merged PR #262 (commit eb11a844) added resource revision details to charm status output, completing resource support tracked in #176. | |
| #2240 docs: update charm definition in security doc | charmcraft | merged | Merged PR #2240 updated SECURITY.md’s charm definition after review of #2237, resolving documentation feedback in commit c7f258db. | |
| #259 Support for attaching resources when releasing charms. | charmcraft | merged | Merged PR #259 in commit 35855e58, adding resource attachment support when releasing charms through the upload command. | |
| #457 Allow including resources when releasing charms directly in the upload command (CRAFT-381). | charmcraft | merged | Merged PR #457 (b5d735b4), adding --resource support to upload --release and fixing #456; the fix shipped in Charmcraft 1.1.2. | |
| #847 Improve the 'release' response when resources are automatically released with the charm | charmcraft | open | Enhance charmcraft release output to list resources Charmhub automatically attaches; the backend fix is available, but current output only reports resources passed with --resource. | |
| #2748 docs: improve charm naming docs, with links to detailed guidance | charmcraft | merged | Docs PR #2748 merged (commit 0389aeb4): rewrote charm naming guidance in the charmcraft.yaml reference and manage-charms how-to, replacing inline best-practice notes with links to the Ops docs. Fixes #2582; relied on canonical/operator#2610. | |
| #471 config: add charm part to documentation (CRAFT-356) | charmcraft | merged | Merged PR #471 via commit e0b18661, documenting the charm part in the configuration schema for CRAFT-356. | |
| #2248 docs: update to the latest release notes template | charmcraft | merged | Merged as e7a49987: updated Charmcraft's release-notes template to match canonical/starbase#375; non-RST edits were automatic formatting. | |
| #176 Support for charms' resources | charmcraft | closed | Resource support was completed by merged PRs #252, #253, #259, and #262, covering listing, uploading, release attachment, and status output. |