← Back to issue list

docs: what are the values that the `source-type` can have?

View original Github issue

Metadata

Project
charmcraft
Number
#2552
Type
issue
State
open
Author
panlinux
Labels
Created
Updated
Closed

Current evaluation

Docs gap: dump plugin page doesn't list valid source-type values. Values are documented in craft-parts PartSpec docstring (part_properties.rst) but not cross-referenced from the dump plugin page. Unlabelled, no maintainer response, 215 days old.

Suggested action: needs triage

Reason: No labels, no comments, no assignee, and no maintainer response in 215 days. The documentation gap is real — dump_plugin.rst in craft-parts still says source-type is 'optional, but recommended' without listing values — though the full values table (7z, deb, git, rpm, snap, tar, zip, local, file) exists in the PartSpec.source_type docstring rendered on the part_properties reference page. A maintainer needs to decide whether to add the values inline or add a cross-reference link.

Impact: 25 Quick Win: 22.5 Staleness: 60 Complexity: 10 Confidence: 75 Support Request: 40

Issue body

The docs say: > You must specify at least the source key. The source-type key is optional, but recommended, as it is used to specify how the source should be handled. But it doesn't say what are the possible values that `source-type` can have. --- *Reported from: https://documentation.ubuntu.com/charmcraft/stable/common/craft-parts/reference/plugins/dump_plugin/*

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.8-27b
Impact: 25
Quick Win: 22.5
Staleness: 60
Complexity: 10
Confidence: 75
Support Request: 40
needs triage Docs gap: dump plugin page doesn't list valid source-type values. Values are documented in craft-parts PartSpec docstring (part_properties.rst) but not cross-referenced from the dump plugin page. Unlabelled, no maintainer response, 215 days old.
qwen/qwen3.6-35b-a3b
Staleness: 85
Complexity: 10
Confidence: 80
Support Request: 70
needs triage Documentation lacks information on valid values for the source-type configuration key. Unanswered and inactive for over 5 months.
qwen3.6-35b-a3b-mtp-q6
Staleness: 85
Complexity: 15
Confidence: 80
Support Request: 20
needs triage Documentation lacks a list of valid values for the source-type configuration key. Unaddressed for 162 days with no maintainer response or labels.
qwen3.6-35b-a3b-mtp-q6
Staleness: 80
Complexity: 10
Confidence: 75
Support Request: 80
needs triage Documentation lacks valid values for the source-type parameter. Unanswered for 160 days, awaiting maintainer assessment or documentation update.
qwen3.6-35b-a3b-mtp-q6
Staleness: 75
Complexity: 10
Confidence: 90
Support Request: 20
needs triage Documentation lacks valid values for the optional source-type parameter. Open 140 days with zero comments and no labels. Requires a documentation update to list accepted values.

Update history

No update history recorded yet.

Related work

  • Related To: craft-parts#1129 (confidence 70%)

    PR that added model docstrings to PartSpec, including the source_type values table (7z, deb, git, rpm, snap, tar, zip, local, file) rendered on the part_properties reference page.

Related issues

No related issues found above the similarity threshold.