docs(plugins): document behavior of PluginOption default values#1872
Merged
docs(plugins): document behavior of PluginOption default values#1872
Conversation
github-actions
bot
added
the
documentation
Contributor
There was a problem hiding this comment.
Pull request overview
Documentation update clarifying when PluginOption default values are applied and how to get existing Plugins to pick up updated defaults (PluginPreset-managed vs standalone Plugins).
Changes:
- Clarify that PluginOption defaults are applied during admission on Plugin create/update, and default changes won’t immediately reflect on existing Plugins.
- Document that PluginPreset-managed Plugins get updated automatically when defaults change, while standalone Plugins require a reconciliation trigger.
- Convert several docs callouts to
>blockquote style for consistent rendering.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/reference/components/plugindefinition.md | Adds/clarifies semantics of PluginOption default application and how updates propagate. |
| docs/reference/components/plugin.md | Extends defaulting webhook note to explain PluginPreset vs standalone behavior and reconciliation. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
mikolajkucinski
previously approved these changes
Mar 30, 2026
mikolajkucinski
approved these changes
Mar 30, 2026
PluginOption default values are only applied during admission of a Plugin. This means during Create/Update. Only PluginPresets will ensure the Plugin is updated right away. For standalone plugins the reconcile annotation `greenhouse.sap/recocile=some-key` should be used.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
IvoGoman
force-pushed
the
docs/plugin-defaulting
branch
from
96c7289 to
6984ac8
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
PluginOption default values are only applied during admission of a
Plugin. This means during Create/Update. Only PluginPresets will ensure
the Plugin is updated right away. For standalone plugins the reconcile
annotation
greenhouse.sap/recocile=some-keyshould be used.What type of PR is this? (check all applicable)
Related Tickets & Documents
Added tests?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
Added to documentation?
Checklist