← Back to issue list

How-to doc for charmcraft test

View original Github issue

Metadata

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

Current evaluation

Documentation request from a maintainer to write a how-to guide for the undocumented `charmcraft test` command. Open with no labels, assignee, or maintainer triage; only an automated Jira-sync bot comment (CRAFT-3957).

Suggested action: needs triage

Reason: The issue is a well-scoped maintainer-authored doc request ('Write a how-to that shows users how to use `charmcraft test`'), with a stated reason ('charmcraft test is currently undocumented'), but it carries no labels, no assignee, and the single comment is an autogenerated bot message ('The internal ticket has been created: CRAFT-3957') rather than any maintainer triage — so it has not yet been assessed and needs_triage is the correct action. Impact is modest (docs gap for a rarely-used command) and the work itself is a straightforward doc page. Confidence is held at 70 rather than higher because the repo search/grep tooling failed (routing to the wrong mirror), so I could not positively confirm whether a how-to has since landed or whether the `test` command still exists; if a maintainer has since written the page, this would instead be close_resolved.

Evaluated by: mr-cal-bot

Impact: 25 Quick Win: 13 Complexity: 20 Confidence: 70 Actionability: 65

Issue body

### What needs to get done Write a how-to that shows users how to use `charmcraft test` to test their charm ### Why it needs to get done charmcraft test is currently undocumented

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha
Impact: 25
Quick Win: 13
Complexity: 20
Confidence: 70
Actionability: 65
needs triage Documentation request from a maintainer to write a how-to guide for the undocumented `charmcraft test` command. Open with no labels, assignee, or maintainer triage; only an automated Jira-sync bot comment (CRAFT-3957).
qwen/qwen3.6-35b-a3b
Impact: 30
Quick Win: 22
Complexity: 10
Confidence: 80
Actionability: 80
needs triage Request to write a how-to documentation guide for the `charmcraft test` command, which is currently undocumented.
qwen/qwen3.8-27b
Impact: 35
Quick Win: 24
Staleness: 70
Complexity: 30
Confidence: 75
Support Request: 0
keep open Request to write a how-to guide for the charmcraft test command, which is currently undocumented. No maintainer response or labels; only an auto-generated Jira sync comment. The command still exists in the codebase (spread tests, release notes), so the gap persists.
qwen/qwen3.6-35b-a3b
Staleness: 90
Complexity: 10
Confidence: 80
Support Request: 20
needs triage Request to document the charmcraft test command. Currently undocumented, lacks labels or assignee, and has seen no maintainer engagement in over a year.
qwen3.6-35b-a3b-mtp-q6
Staleness: 85
Complexity: 10
Confidence: 80
Support Request: 10
needs triage Request to document the charmcraft test command. Currently undocumented and lacks maintainer triage or labels after over a year of inactivity.
qwen3.6-35b-a3b-mtp-q6
Staleness: 85
Complexity: 10
Confidence: 90
Support Request: 10
needs triage Request to document the charmcraft test command. Unlabelled, no maintainer response, inactive for over a year. Awaiting triage and assignment.

Update history

No update history recorded yet.

Related work

  • Related To: charmcraft#695 (confidence 45%)

    Another Charmcraft testing-documentation request (explain how to test project changes when packing charms), closed without an implementing PR; same docs-about-testing theme.

  • Related To: charmcraft#439 (confidence 40%)

    Docs request about running Charmcraft in CI; closed as addressed via official actions, so CI-testing guidance is covered elsewhere.

Related issues

Issue Project State Summary Similarity
#1434 Improve Documentation for 'charmcraft help clean' Command charmcraft open Documentation request for `charmcraft clean` help text; current overview is brief and issue lacks specific gaps. Related PR #2795 was rejected as subpar; no maintainer triage on issue.
77%
#2865 docs: charmcraft release reference is badly formatted charmcraft open Docs bug report: the published `charmcraft release` command reference shows `charmcraft release [options] <None> <None> <None>` in Usage, plus unformatted channel and resource examples. Untriaged, no maintainer response.
74%
#2795 docs: improve `charmcraft clean` command documentation charmcraft closed Closed unmerged; maintainer @lengau rejected the proposed charmcraft clean documentation as subpar, and no documentation commit or replacement PR landed.
74%
#439 [docs] how to run charmcraft as part of a CI? charmcraft closed Closed as addressed: canonical/craft-actions#31 (commit 91513c1) added Charmcraft setup and pack actions, and a maintainer confirmed CI packing and publishing were now supported.
72%
#1657 Document permissions, channels, etc. in Charmhub login charmcraft open Maintainer-created docs request to improve `charmcraft login` command documentation with permissions, channels, and related details; internal Jira ticket CRAFT-2827 exists.
72%
#160 Have a way for charmcraft to run the tests charmcraft closed No dedicated test command was added; maintainers directed users to override-build in charmcraft.yaml, running craftctl build before tests such as pytest.
72%
#1964 Provide internal documentation for templates charmcraft open Maintainer task to add comments in charmcraft templates explaining why certain linters are ignored, following PR #1941 discussion. Still open with an internal Jira ticket (CRAFT-3571).
71%
#1811 Document using Charmcraft under WSL charmcraft open Documentation request to add a how-to for running Charmcraft on Windows via WSL (enable systemd, snapd, reboot, install snapcraft). No labels or comments; still open.
71%
#1092 Some tests will require the charm plugin to be enabled craft-application open Open, unlabelled issue: charmcraft PR #2722 may make craft-application tests depend on the charm plugin; the maintainer asks to remove that dependency, but no affected test or fix is identified.
71%
#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.
71%