docs: plugin manager update --level behavior

elastic · Jan 14, 2025 · 9feb4b7 · 9feb4b7
1 parent 93e8e50
commit 9feb4b7
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/docs/static/plugin-manager.asciidoc b/docs/static/plugin-manager.asciidoc
@@ -112,6 +112,21 @@ bin/logstash-plugin update logstash-input-github <2>
 <1> updates all installed plugins
 <2> updates only the plugin you specify
 
+[NOTE]
+.Major-version plugin updates
+==============================
+By default, the plugin manager will consume _minor_ updates containing non-breaking features and fixes.
+If you wish to also include breaking changes, specify `--level=major`.
+
+[source,shell]
+----------------------------------
+bin/logstash-plugin update --level=major <1>
+bin/logstash-plugin update --level=major logstash-input-github <2>
+----------------------------------
+<1> updates all installed plugins to latest, including major-version breaking changes
+<2> updates only the plugin you specify to latest, including major-version breaking changes
+==============================
+
 [discrete]
 [[removing-plugins]]
 === Removing plugins