From 04c185559ff65f981a141ca755e6e12526c0eaac Mon Sep 17 00:00:00 2001 From: Patrick Clausen Date: Sat, 5 Nov 2022 15:43:26 +0100 Subject: [PATCH 1/2] [Doc] Correct "help" command to reflect actual behaviour Signed-off-by: Patrick Clausen --- packages/osd-plugin-helpers/README.md | 2 +- packages/osd-plugin-helpers/src/cli.ts | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) 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 f108f9a2f6ca..c4b1a83fedaf 100644 --- a/packages/osd-plugin-helpers/src/cli.ts +++ b/packages/osd-plugin-helpers/src/cli.ts @@ -66,7 +66,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 }) { From 66b170bb6b1d5b204bcf5696e977d87d56e0aad0 Mon Sep 17 00:00:00 2001 From: Patrick Clausen Date: Sat, 5 Nov 2022 16:11:21 +0100 Subject: [PATCH 2/2] Update CHANGELOG.md Signed-off-by: Patrick Clausen --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 753971bd5823..8a78f7019e52 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -72,6 +72,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) - [MD] Add design documents of multiple data source feature [#2538](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2538) - [MD] Tweak multiple data source design doc [#2724](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2724) +- Corrected README and help command of osd-plugin-helpers ([#2810](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2810)) ### 🛠 Maintenance