← Back to issue list

docs(dump): add usage examples

View original Github issue

Metadata

Project
craft-parts
Number
#1597
Type
pull request
State
open
Author
gcomneno
Labels
—
Created
Updated
Closed
—

Current evaluation

Docs-only PR adding declarative Dump plugin usage examples (local dir, per-file copies, organize remapping). Approved by 2 reviewers, 0 unresolved comments; CI green except an unrelated Minimum-dependencies failure.

Suggested action: needs review

Reason: Approved by 2 reviewers with 'Unresolved review comments: 0', and the author reports applying feedback in b6f3d726 (declarative examples, kept `source: .`, dropped the charm-specific example). The only red check, 'test-common / Minimum dependencies (all tests)', was assessed by jahn-junior as unrelated ('os.mknod ... Operation not permitted' environment issue, not docs), and the noted lint concern is attributed to not yet incorporating canonical/starbase#551 rather than this diff. medubelko's 'Shall we merge?' shows it is now only awaiting a maintainer decision.

Evaluated by: mr-cal-bot

Impact: 30 Quick Win: 23 Complexity: 8 Confidence: 78 Actionability: 82

Issue body

## Summary Add practical Dump plugin examples showing how to copy a local directory as-is, copy files to specific locations, organize directory contents, and copy files into a charm payload. Fixes #1531. ## Tests - `git diff --check` - `make docs`

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha
Impact: 30
Quick Win: 23
Complexity: 8
Confidence: 78
Actionability: 82
needs review Docs-only PR adding declarative Dump plugin usage examples (local dir, per-file copies, organize remapping). Approved by 2 reviewers, 0 unresolved comments; CI green except an unrelated Minimum-dependencies failure.
stealth/space-bunny-alpha
Impact: 12
Quick Win: 9
Complexity: 6
Confidence: 76
Actionability: 82
needs review Adds declarative YAML usage examples to the Dump plugin docs page, closing #1531. Approved by 2 reviewers, 0 unresolved comments; only failing CI check is an unrelated environment permissions error.
stealth/space-bunny-alpha
Impact: 25
Quick Win: 16
Complexity: 10
Confidence: 95
Actionability: 72
needs review Adds declarative usage examples to the Dump plugin documentation, fixes #1531, and has two approvals. Tests pass, but lint/files remains failing pending an update related to canonical/starbase#551.
qwen/qwen3.6-35b-a3b
Impact: 35
Quick Win: 30
Staleness: 10
Complexity: 15
Confidence: 75
needs review Adds practical Dump plugin usage examples to documentation. Under review with changes requested and 5 unresolved comments; CI mostly passing.
qwen/qwen3.6-35b-a3b
Impact: 35
Quick Win: 30
Staleness: 25
Complexity: 15
Confidence: 75
needs review Adds practical Dump plugin usage examples to documentation, addressing issue #1531. Has changes requested by a reviewer with 5 unresolved comments, all CI passing, and recent activity.
qwen3.6-35b-a3b-mtp-q6
Impact: 30
Quick Win: 26
Staleness: 25
Complexity: 15
Confidence: 70
needs review Adds practical Dump plugin usage examples to documentation. Has 5 unresolved review comments with changes requested; last updated 4 days ago.
qwen/qwen3.6-35b-a3b
Staleness: 15
Complexity: 5
Confidence: 90
needs review Adds usage examples for the Dump plugin to resolve issue #1531. Documentation-only change with passing CI checks. Currently awaiting maintainer review with no comments or requested changes.
qwen/qwen3.6-35b-a3b
Staleness: 60
Complexity: 10
Confidence: 85
needs review Adds practical usage examples for the Dump plugin to improve documentation. Currently pending maintainer review with no comments or activity in 60 days. CI shows some failing slow tests on specific architectures.
qwen3.6-35b-a3b-mtp-q6
Staleness: 45
Complexity: 15
Confidence: 85
needs review Adds practical usage examples for the Dump plugin covering directory copying, file placement, content organization, and charm payload integration. Currently awaiting maintainer review with zero comments or recent activity.

Update history

Date Change
updated
updated
updated
updated
updated
updated
updated
updated
updated
updated

Related work

  • Related To: canonical/craft-parts#1531 (confidence 92%)

    Issue this PR declares 'Fixes #1531'; that doc request is still open and was only partly satisfied by #1547.

  • Related To: canonical/craft-parts#1547 (confidence 75%)

    Merged PR (fb57e5a3) already added one nginx-style Dump YAML example to the same page, so this PR is additive/overlapping on the same doc section.

  • Related To: canonical/snapcraft#5770 (confidence 55%)

    Upstream doc request complaining that dump plugin docs lack get-started examples; this PR addresses part of that gap.

Related issues

Issue Project State Summary Similarity
#676 docs(plugins): add dump plugin docs craft-parts merged Merged dump-plugin documentation covering usage, source behavior, overrides, and an example via commit 2c7b7170.
79%
#1531 docs: Add more explanation and/or examples to dump_plugin craft-parts open Doc request for examples on the dump plugin reference page; resolved by merged PR #1547 (fb57e5a3), which added a YAML example with local source and organize remapping. Issue still open in tracker.
78%
#1547 docs: add example to dump plugin craft-parts merged Merged PR #1547 in commit fb57e5a3, adding a practical Dump plugin documentation example based on an nginx rock configuration.
70%