← 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

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.

Suggested action: keep open

Reason: The charmcraft test command is still present in the codebase (spread tests in tests/spread/ubuntu-24.04/test-cmd, release notes referencing ref_commands_test), and no how-to guide for it exists in docs/howto, so the documentation gap is still valid. The issue was filed by a maintainer (lengau) and synced to an internal Jira ticket (CRAFT-3957), indicating it is tracked and intended to be addressed, so it should remain open despite inactivity.

Impact: 35 Quick Win: 24.5 Staleness: 70 Complexity: 30 Confidence: 75 Support Request: 0

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
qwen/qwen3.8-27b
Impact: 35
Quick Win: 24.5
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.
qwen3.6-35b-a3b-mtp-q6
Staleness: 88
Complexity: 15
Confidence: 80
Support Request: 10
close stale Request for a how-to guide documenting the currently undocumented charmcraft test command. The task remains open, stalled for over a year, and has been synced to internal Jira tracking.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#2365 Add test configuration templates for charmcraft charmcraft closed Closed without implementation. The request to add test configuration templates for charmcraft via charmcraft --init --profile=test was abandoned, with only an automated Jira sync comment recorded.
71%
#2089 Charmcraft terminology glossary charmcraft open Documentation task to create a Charmcraft terminology glossary (Base, Platform, Charm vs .charm file). Filed by a maintainer 591 days ago, no labels, no assignee, no maintainer response beyond a Jira sync bot. No glossary exists in the docs tree.
70%
#1434 Improve Documentation for 'charmcraft help clean' Command charmcraft open Request to improve documentation for the 'charmcraft help clean' command, which the reporter says lacks usage and purpose details. The clean command is inherited from craft-application's lifecycle module; no maintainer has responded (0 comments, no labels).
70%