← Back to issue list

plugins: improve nil plugin docstring

View original Github issue

Metadata

Project
craft-parts
Number
#300
Type
pull request
State
merged
Author
cmatsuoka
Labels
—
Created
Updated
Closed

Current evaluation

Merged PR #300 in commit d7c1b68d, expanding the nil plugin docstring with guidance for source-less parts and parts using override-build.

Resolution: closed resolved

Reason: PR #300 was approved and landed as commit d7c1b68d, documenting when the nil plugin is useful and how sourced parts must use override-build.

Evaluated by: mr-cal-bot

No scores available.

Issue body

Update nil plugin documentation with useful information. Co-authored-by: Robert P. J. Day <robert.day@canonical.com> Signed-off-by: Claudio Matsuoka <claudio.matsuoka@canonical.com> - [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)? -----

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Merged PR #300 in commit d7c1b68d, expanding the nil plugin docstring with guidance for source-less parts and parts using override-build.
stealth/space-bunny-alpha — closed resolved Merged in craft-parts#300 via commit d7c1b68d, expanding NilPlugin documentation with practical guidance on its no-op behavior and use with sourced parts.
stealth/space-bunny-alpha — closed resolved Merged as commit 64d54ddfb, improving the legacy nil plugin docstring with useful documentation; it replaced the earlier closed PR #3913.
qwen/qwen3.6-35b-a3b — — Merged following approval and passing CI checks. The update revised the nil plugin docstring with additional documentation details, modifying one file.
qwen3.6-35b-a3b-mtp-q6 — — Merged documentation update for the nil plugin, adding useful information. Co-authored by Robert P. J. Day and signed off by Claudio Matsuoka. Enhances clarity for developers.

Update history

No update history recorded yet.

Related work

  • Related To: craft-parts#703 (confidence 85%)

    Later added dedicated nil-plugin reference and how-to documentation building on the improved explanation.

Related issues

Issue Project State Summary Similarity
#3949 legacy/plugins: improve nil plugin docstring snapcraft merged Merged as 64d54ddfb, improving the legacy nil plugin docstring; it remade the earlier unmerged PR #3913.
84%
#1549691 Improve documentation for the nil plugin snapcraft (launchpad) closed Documentation clarified by PR #455, merged as commit 391143bc1. Requested source support was rejected because sources are private per part and left to the copy plugin.
78%
#27 plugins: add the nil plugin craft-parts merged Merged #27, adding a nil plugin for parts with no source (implementation 6f45c94e; merge commit d107f80d).
78%
#703 feat(docs): nil plugin reference and howto craft-parts merged Merged PR #703 added nil-plugin reference and how-to docs for CRAFT-2682 in commit 258fbd8b; the documentation was included in Craft Parts 1.31.0.
74%
#455 Nil plugin: Make purpose more clear in documentation. snapcraft merged Merged in snapcraft#455 (391143bc1), clarifying that nil cannot pull sources, adding examples and tests, and rejecting unsupported source keywords.
74%
#1610 Make the `nil` plugin out-of-source craft-parts closed PR #1610 proposed making the `nil` plugin out-of-source (breaking change for #1609), passed CI, but was closed unmerged by the author to continue the discussion in issue #1609.
73%
#330 plugins: Correct docstring in Dotnet plugin craft-parts merged Merged PR #330 as commit a50c72b3, correcting a one-line copy-and-paste docstring typo in the Dotnet plugin.
71%
#85 Add nil plugin snapcraft merged Merged snapcraft#85 via 8e62b401f, adding a no-op nil plugin for parts whose properties are all optional and incorporating integration tests.
70%