Skip to content

Commit 205cdb7

Browse files
committed
Stronger wording on plugin compat guarantees
Signed-off-by: Andrew Harding <[email protected]>
1 parent 5ee1465 commit 205cdb7

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

doc/upgrading.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,11 @@ For example:
2222
SPIRE plugins generally follow the same overall guarantees as all other SPIRE components with small exception for changes made to external plugins outside of SPIRE's control.
2323

2424
#### Configuration and Behavior Compatibility
25-
A built-in plugin undergoing a backwards incompatible change (e.g. change to configuration semantics, change to selectors produced, etc.) should log a warning but otherwise maintain backwards compatibility for one minor version after the change is introduced, giving operators time to adopt requisite changes.
25+
A built-in plugin undergoing a backwards incompatible change (e.g. change to configuration semantics, change to selectors produced, etc.) will log a warning but otherwise maintain backwards compatibility for one minor version after the change is introduced, giving operators time to adopt requisite changes.
2626
SPIRE cannot make any guarantees around configuration or behavior compatibility for external plugins.
2727

2828
#### Interface Compatibility
29-
All efforts will be made to introduce changes to plugin interfaces in a backwards compatible manner. If a breaking change is introduced to a plugin interface, existing plugins compiled against the old interface will still continue to function for one minor version release cycle to give operators time to adopt requisite changes. SPIRE will log warnings to make operators aware of the change.
29+
When a breaking change is introduced to a plugin interface, existing plugins compiled against the old interface will still continue to function for one minor version release cycle to give operators time to adopt requisite changes. SPIRE will log warnings to make operators aware of the change.
3030

3131
## Supported Upgrade Paths
3232

0 commit comments

Comments
 (0)