docs: add example to dump plugin
Metadata
Current evaluation
Merged documentation update adding a practical Dump plugin example based on the nginx rock configuration. Approved by two reviewers. CI passed except for a known flaky OSV security scan, dismissed by maintainers.
Suggested action: —
No scores available.
Issue body
- [x] Have you followed the guidelines for contributing?
- [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
- [x] Have you successfully run `make lint && make test`?
- [ ] Have you added an entry to the changelog (`docs/reference/changelog.rst`)?
---
Recent UR feedback requested documentation updates to provide a practical example for the Dump plugin to illustrate its usage. This PR adds an example from the [nginx rock](https://github.com/canonical/nginx-rock/blob/83d6198ea16986ecdaa204563c2ac5a77828020a/1.27.5/rockcraft.yaml#L14).
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | Merged documentation update adding a practical Dump plugin example based on the nginx rock configuration. Approved by two reviewers. CI passed except for a known flaky OSV security scan, dismissed by maintainers. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation update adding a practical Dump plugin example sourced from the nginx rock. A transient security scan failure was dismissed as a known flaky issue, allowing the contribution to proceed and be integrated. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #1597 docs(dump): add usage examples | craft-parts | open | Adds practical Dump plugin usage examples to documentation. Under review with changes requested and 5 unresolved comments; CI mostly passing. | |
| #676 docs(plugins): add dump plugin docs | craft-parts | merged | Merged documentation update adding dump plugin documentation across nine files. Approved by two reviewers with 265 additions and 3 deletions. Associated unit test fixes were resolved in a separate pull request. | |
| #5770 docs: dump plugin docs don't provide enough information to even get started | snapcraft | open | Documentation for dump plugin lacks examples and key descriptions. Maintainer acknowledged; PR craft-parts#1597 adding examples is actively in review (updated 4 days ago). | |
| #32 plugins: add the dump plugin | craft-parts | merged | Merged the addition of a new dump plugin that copies content from the part source. Approved by two reviewers, the change adds 129 lines across four files and was authored by maintainer cmatsuoka. | |
| #712 New plugin: dump | snapcraft | merged | Merged a new dump plugin that extracts content from a specified source. Reviewers requested an integration test, which was added before final approval and merge. | |
| #1531 docs: Add more explanation and/or examples to dump_plugin | craft-parts | open | Docs request for dump plugin page asking for usage examples (copying folders/files to a charm). Moved to craft-parts by maintainer; one example merged via PR #1547, broader PR #1597 open awaiting review. |