← Back to issue list

Fix docs and help messages about OCI image uploads

View original Github issue

Metadata

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

Current evaluation

Docs/help for `upload-resource --image` are outdated: manage-resources.rst and the CLI help still claim only sha256 digests or local image IDs are accepted, while the code now supports OCI archives, directories, and any skopeo transport string.

Suggested action: keep open

Reason: The reported inaccuracy is verifiable in the current tree: manage-resources.rst:50-63 still says '--image must be passed an OCI image digest, prefixed with sha256:, or a local image ID' and that Charmcraft 'first check[s] if that specific image is available in Canonical's Registry', while store.py now branches through docker-daemon, oci-archive, oci (directory) and generic skopeo transports with 'Unknown OCI image reference.' as fallback. The fix is docs/help-string only, hence low complexity and impact. Actionability is held below 80 because the body points to an external Discourse thread and states neither what the correct text should be nor which of the two locations takes precedence; issue charmcraft#2428 is a superset that also demands a dedicated OCI-upload doc.

Evaluated by: mr-cal-bot

Impact: 22 Quick Win: 11 Complexity: 14 Confidence: 84 Actionability: 58

Issue body

### Bug Description The docs and help message about OCI image uploads on Charmcraft 3 are slightly wrong. See: https://discourse.charmhub.io/t/publish-your-charm-on-charmhub/12281/6?u=lengau ### To Reproduce https://discourse.charmhub.io/t/publish-your-charm-on-charmhub/12281/6?u=lengau ### Environment n/a ### charmcraft.yaml ```yaml n/a ``` ### Relevant log output ```shell n/a ```

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha
Impact: 22
Quick Win: 11
Complexity: 14
Confidence: 84
Actionability: 58
keep open Docs/help for `upload-resource --image` are outdated: manage-resources.rst and the CLI help still claim only sha256 digests or local image IDs are accepted, while the code now supports OCI archives, directories, and any skopeo transport string.
qwen/qwen3.6-35b-a3b
Impact: 30
Quick Win: 8
Complexity: 10
Confidence: 60
Actionability: 30
needs triage Documentation and help messages about OCI image uploads in Charmcraft 3 are incorrect. Issue references a Discourse thread for details but lacks specifics in the issue body.
qwen/qwen3.8-27b
Impact: 15
Quick Win: 14
Staleness: 72
Complexity: 10
Confidence: 62
Support Request: 0
needs triage Docs and help messages for OCI image uploads in Charmcraft 3 are slightly wrong per a discourse thread. Filed by maintainer lengau, no labels or assignee, only an auto Jira-sync comment. Docs still reference dockerd while code now uses skopeo.
qwen/qwen3.6-35b-a3b
Staleness: 85
Complexity: 10
Confidence: 85
Support Request: 10
needs triage Documentation and CLI help text for OCI image uploads in Charmcraft 3 are inaccurate. Open for over a year with no maintainer labels or assignment. Requires triage and documentation update.
qwen3.6-35b-a3b-mtp-q6
Staleness: 90
Complexity: 15
Confidence: 80
Support Request: 10
needs triage Outdated documentation and help messages regarding OCI image uploads in Charmcraft 3. Open for over a year with minimal maintainer interaction and no assigned fix.
qwen3.6-35b-a3b-mtp-q6
Staleness: 85
Complexity: 10
Confidence: 75
Support Request: 0
needs triage Documentation and CLI help text for OCI image uploads in Charmcraft 3 contain inaccuracies. Open since ~1.7 years ago with no maintainer triage or fix.

Update history

No update history recorded yet.

Related work

  • Related To: charmcraft#2428 (confidence 80%)

    Triaged follow-up 'docs: dedicated doc for uploading of OCI images' explicitly notes that the CLI help conflicts with the docs about sha256 prefixes and that guidance omits transport/archive forms and multi-arch handling — the same defect this issue reports, scoped more narrowly here.

Related issues

Issue Project State Summary Similarity
#2428 docs: dedicated doc for uploading of OCI images charmcraft open Triaged OCI upload documentation remains incomplete: guidance omits transport/archive forms and multi-architecture handling, while CLI help conflicts with the docs about sha256 prefixes.
75%
#853 The upload-resource command should accept images id or digests charmcraft closed Merged PR #871 resolved support for OCI image IDs and digests in upload-resource, improving local ID handling and missing-image errors.
71%