From 9b13b90066c3707c3888b3a1762ea5a50d218c2c Mon Sep 17 00:00:00 2001 From: steviez Date: Mon, 30 Jan 2023 12:14:25 -0600 Subject: [PATCH] Add backwards compatibility clarification on CLI tooling output (#29961) Json output should remain consistent to avoid breaking automation; however, we want to be free to update human-reader-centric output to remove output as it becomes deprecated. --- docs/src/developing/backwards-compatibility.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/src/developing/backwards-compatibility.md b/docs/src/developing/backwards-compatibility.md index ce60557b1..4a3c60b8e 100644 --- a/docs/src/developing/backwards-compatibility.md +++ b/docs/src/developing/backwards-compatibility.md @@ -149,3 +149,9 @@ software releases. If a new attack vector is discovered in existing code, the above processes may be circumvented in order to rapidly deploy a fix, depending on the severity of the issue. + +#### CLI Tooling Output + +CLI tooling json output (`output --json`) compatibility will be preserved; however, output directed +for a human reader is subject to change. This includes output as well as potential help, warning, or +error messages.