← Back to issue list

Document the creation and use of stage-packages filters

View original Github issue

Metadata

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

Current evaluation

Docs task from maintainer: write a how-to for registering stage-packages filters; still undocumented (docs/how-to/index.rst has no callbacks page) and the register_stage_packages_filter docstring still misleadingly says the mechanism "is now deprecated".

Suggested action: needs triage

Reason: Filed by a maintainer (lengau) with a clear deliverable, but it carries no labels, no assignee and zero comments, so there is no evidence of categorization or prioritization. Verified still unaddressed at HEAD: docs/how-to/index.rst toctree lists no callbacks/stage-packages page, and craft_parts/callbacks.py:71-78 retains the confusing wording "This is now deprecated, and a function providing an explicit list of exclusions should be provided"; a git log -S pickaxe for register_stage_packages_filter in docs found no commits. Work is doc-only (a new how-to page plus a docstring clarification), low complexity but the exact scope/placement of the guide still needs maintainer direction.

Evaluated by: mr-cal-bot

Impact: 28 Quick Win: 14 Complexity: 22 Confidence: 80 Actionability: 66

Issue body

### What needs to get done Write a how-to for registering stage-packgaes filters. ### Why it needs to get done The current documentation is only in the auto-generated package reference, and the docstring for that is confusing, as it implies that it is deprecated. https://canonical-craft-parts.readthedocs-hosted.com/en/latest/reference/gen/craft_parts.callbacks.html#craft_parts.callbacks.register_stage_packages_filter

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha
Impact: 28
Quick Win: 14
Complexity: 22
Confidence: 80
Actionability: 66
needs triage Docs task from maintainer: write a how-to for registering stage-packages filters; still undocumented (docs/how-to/index.rst has no callbacks page) and the register_stage_packages_filter docstring still misleadingly says the mechanism "is now deprecated".
qwen/qwen3.6-35b-a3b
Impact: 30
Quick Win: 19
Complexity: 20
Confidence: 70
Actionability: 80
needs triage Documentation request to write a how-to guide for register_stage_packages_filter, whose current docstring confusingly claims deprecation.
qwen/qwen3.8-27b
Impact: 35
Quick Win: 24
Staleness: 75
Complexity: 30
Confidence: 80
Support Request: 10
needs triage Documentation task to write a how-to for register_stage_packages_filter; the function still exists with a confusing docstring implying deprecation, and no how-to has been written. No labels, no comments, no assignee after 725 days.
qwen/qwen3.6-35b-a3b
Staleness: 92
Complexity: 15
Confidence: 88
Support Request: 5
close stale Request to add user-facing documentation for registering stage-packages filters, as current auto-generated docs are confusing and imply deprecation. Unassigned, no comments, inactive for over a year.
qwen3.6-35b-a3b-mtp-q6
Staleness: 92
Complexity: 10
Confidence: 85
Support Request: 0
needs triage Documentation task requesting a how-to guide for registering stage-packages filters. Currently lacks maintainer triage, has no comments, and has been inactive for over a year.

Update history

No update history recorded yet.

Related issues

No related issues found above the similarity threshold.