From 9b7023f87bc58ce751d7e7fa74f968497738c9ca Mon Sep 17 00:00:00 2001 From: "opensearch-trigger-bot[bot]" <98922864+opensearch-trigger-bot[bot]@users.noreply.github.com> Date: Tue, 29 Nov 2022 18:23:43 -0800 Subject: [PATCH] [Backport 1.x] [Doc] Correct "help" command to reflect actual behaviour (#2943) * [Doc] Correct "help" command to reflect actual behaviour (#2810) * [Doc] Correct "help" command to reflect actual behaviour Signed-off-by: Patrick Clausen * Update CHANGELOG.md Signed-off-by: Patrick Clausen Signed-off-by: Patrick Clausen Co-authored-by: Josh Romero (cherry picked from commit 311fe91a85869436bdc547a38c562b39f88679fe) Signed-off-by: github-actions[bot] # Conflicts: # CHANGELOG.md * [Chore] Update changelog Signed-off-by: Josh Romero Signed-off-by: Josh Romero Co-authored-by: github-actions[bot] Co-authored-by: Josh Romero --- CHANGELOG.md | 3 ++- packages/osd-plugin-helpers/README.md | 2 +- packages/osd-plugin-helpers/src/cli.ts | 2 +- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 185d61da7d28..20a4d9c3245e 100644 --- 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 index 4a16bc9afe23..700999c26bf7 100644 --- 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 index 69a656db668b..6596e33bb178 100644 --- 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 }) {