← Back to issue list

`prime` and `stage` key reference should be fleshed out

View original Github issue

Metadata

Project
craft-parts
Number
#921
Type
issue
State
open
Author
lengau
Labels
—
Created
Updated
Closed
—

Current evaluation

Documentation request to flesh out the stage and prime part-property references with path include/exclude examples. Current main contains those examples and dedicated fileset guidance, but the issue remains open.

Suggested action: close resolved

Reason: Current stage_files and prime_files model fields contain concrete inclusion and exclusion examples, while the filesets explanation documents relative paths, wildcards, and '-' exclusions. Commit 2cc9d578 (PR #1129) introduced the field examples, satisfying the issue's minimum documentation request.

Evaluated by: mr-cal-bot

Impact: 33 Quick Win: 27 Complexity: 12 Confidence: 92 Actionability: 94

Issue body

### What needs to get done https://canonical-craft-parts.readthedocs-hosted.com/en/latest/common/craft-parts/reference/part_properties.html#stage This should at least include an example or two of including only certain files or including some files. ### Why it needs to get done @tmihoc pointed this out due to some user questions on Charmcraft

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha
Impact: 33
Quick Win: 27
Complexity: 12
Confidence: 92
Actionability: 94
close resolved Documentation request to flesh out the stage and prime part-property references with path include/exclude examples. Current main contains those examples and dedicated fileset guidance, but the issue remains open.
stealth/space-bunny-alpha
Impact: 30
Quick Win: 19
Complexity: 15
Confidence: 82
Actionability: 75
keep open Docs request: flesh out the `stage`/`prime` key reference in part_properties with include/exclude examples. PartSpec docstrings in parts.py mention only wildcards and relative paths, never the `-` exclusion prefix; `prime_files` even has an empty description.
qwen/qwen3.6-35b-a3b
Impact: 30
Quick Win: 22
Complexity: 10
Confidence: 80
Actionability: 80
keep open Documentation improvement request to add examples for `prime` and `stage` keys in craft-parts part_properties documentation
qwen/qwen3.8-27b
Impact: 35
Quick Win: 30
Staleness: 70
Complexity: 15
Confidence: 55
Support Request: 10
needs triage Docs gap: the `prime` and `stage` part-property reference pages lack examples and value semantics (e.g. `-` for exclusions). Filed by a maintainer, acknowledged by a second maintainer, but no labels/assignee and no doc update since.
qwen/qwen3.6-35b-a3b
Staleness: 85
Complexity: 10
Confidence: 80
Support Request: 5
keep open Documentation improvement request to add examples and value descriptions for prime and stage keys. Acknowledged by maintainers but inactive for over a year.
qwen3.6-35b-a3b-mtp-q6
Staleness: 85
Complexity: 15
Confidence: 80
Support Request: 5
keep open Request to improve documentation for the prime and stage keys in craft-parts by adding examples and clarifying path syntax for inclusion and exclusion. Currently unlabelled and awaiting implementation.

Update history

No update history recorded yet.

Related work

  • Related To: craft-parts#456 (confidence 96%)

    This open issue overlaps in requesting documentation that explains stage and prime behavior and defaults.

  • Likely Fixed By: craft-parts#1129 (confidence 95%)

    Commit 2cc9d518 added model documentation and the current stage_files and prime_files examples covering inclusions and exclusions.

Related issues

Issue Project State Summary Similarity
#456 Explain how `stage` and `prime` work in the docs craft-parts open Current docs explain install-to-stage-to-prime migration and fileset filtering, but omitted stage/prime defaults remain implicit; #921 still requests fuller key-reference coverage.
80%