[Backport 1.x] [Doc] Correct "help" command to reflect actual behavio…

…ur (#2943) * [Doc] Correct "help" command to reflect actual behaviour (#2810) * [Doc] Correct "help" command to reflect actual behaviour Signed-off-by: Patrick Clausen <[email protected]> * Update CHANGELOG.md Signed-off-by: Patrick Clausen <[email protected]> Signed-off-by: Patrick Clausen <[email protected]> Co-authored-by: Josh Romero <[email protected]> (cherry picked from commit 311fe91) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> # Conflicts: # CHANGELOG.md * [Chore] Update changelog Signed-off-by: Josh Romero <[email protected]> Signed-off-by: Josh Romero <[email protected]> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Josh Romero <[email protected]>
opensearch-project · Nov 30, 2022 · 9b7023f · 9b7023f
1 parent 8bfa3c3
commit 9b7023f
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -30,7 +30,8 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 
 ### 📝 Documentation
 
-Add the release runbook to RELEASING.md ([#2533](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2533))
+* Corrected README and help command of osd-plugin-helpers ([#2810](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2810))
+* Add the release runbook to RELEASING.md ([#2533](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2533))
 
 ### 🛠 Maintenance
 * Remove storybook package and related code ([#2660](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2660))

diff --git a/packages/osd-plugin-helpers/README.md b/packages/osd-plugin-helpers/README.md
@@ -49,7 +49,7 @@ $ plugin-helpers help
 
       Options:
         --skip-archive                       Don't create the zip file, just create the build/opensearch-dashboards directory
-        --opensearch-dashboards-version, -v  OpenSearch Dashboards version that the built plugin will target
+        --opensearch-dashboards-version, -k  OpenSearch Dashboards version that the built plugin will target
     
      
     version

diff --git a/packages/osd-plugin-helpers/src/cli.ts b/packages/osd-plugin-helpers/src/cli.ts
@@ -67,7 +67,7 @@ export function runCli() {
         },
         help: `
           --skip-archive                       Don't create the zip file, just create the build/opensearch-dashboards directory
-          --opensearch-dashboards-version, -v  OpenSearch version that the
+          --opensearch-dashboards-version, -k  OpenSearch Dashboards version that the built plugin will target
         `,
       },
       async run({ log, flags }) {