docs: add example to dump plugin
Metadata
Current evaluation
Merged PR #1547 in commit fb57e5a3, adding a practical Dump plugin documentation example based on an nginx rock configuration.
Resolution: closed resolved
Reason: PR #1547 was approved and merged as commit fb57e5a3, adding the requested Dump plugin usage example. A maintainer confirmed the lone OSV scanner failure was unrelated and flaky.
Evaluated by: mr-cal-bot
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 |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #1547 in commit fb57e5a3, adding a practical Dump plugin documentation example based on an nginx rock configuration. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #1547 in commit fb57e5a3, adding a practical Dump plugin documentation example based on the nginx rock configuration. CI passed except for a maintainer-dismissed flaky OSV scan. | |
| 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 |
|---|---|---|---|---|
| #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. | |
| #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. | |
| #1597 docs(dump): add usage examples | craft-parts | open | 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. |