Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BUG] yarn build docs are incorrect #836

Closed
dblock opened this issue Oct 1, 2021 · 1 comment
Closed

[BUG] yarn build docs are incorrect #836

dblock opened this issue Oct 1, 2021 · 1 comment
Assignees
Labels
bug Something isn't working

Comments

@dblock
Copy link
Member

dblock commented Oct 1, 2021

Describe the bug

Tried to use #795 as described in code/docs.

$ yarn build --linux-x64 --skip-os-packages 
yarn run v1.22.11
$ node scripts/build --all-platforms --linux-x64 --skip-os-packages
ERROR Unknown flag: linux-x64}
usage: node scripts/build

build the OpenSearch Dashboards distributable

options:
  --skip-archives         Don't produce tar/zip archives
  --skip-os-packages      Don't produce rpm/deb/docker packages
  --all-platforms         Produce archives for all platforms, not just this one
  --linux-x64             Produce archives for only linux x64 platform
  --linux-arm64           Produce archives for only linux arm64 platform
  --darwin-x64            Produce archives for only darwin x64 platform
  --rpm                   Only build the rpm package
  --deb                   Only build the deb package
  --docker                Only build the docker image
  --skip-docker-ubi       Don't build the docker ubi image
  --release               Produce a release-ready distributable
  --version-qualifier     Suffix version with a qualifier
  --skip-node-download    Reuse existing downloads of node.js
  --verbose,-v            Turn on verbose logging
  --no-debug              Turn off debug logging

Expected behavior

The correct arguments are --linux and --linux-arm. There might be other places like developer guide where this needs to be updated.

@dblock dblock added bug Something isn't working untriaged labels Oct 1, 2021
@kavilla kavilla removed the untriaged label Oct 4, 2021
ananzh added a commit to ananzh/OpenSearch-Dashboards that referenced this issue Oct 5, 2021
yarn build flags in /src/dev/build/cli.ts are not updated to match
the renamed flags in de-couple PR (opensearch-project#795). This PR fixes the issue
and update the tests. Also modify words in DEVELOPER_GUIDE.md.

PR resolved:
opensearch-project#836

Signed-off-by: Anan Zhuang <ananzh@amazon.com>
@ananzh
Copy link
Member

ananzh commented Oct 5, 2021

@dblock thanks so much for pointing out this bug. I submitted a PR to fix it. To build a specific platform:

yarn build-platform --darwin // build only darwin x64 platform
yarn build-platform --linux //build only linux x64 platform
yarn build-platform --linux-arm // build only linux arm64 platrform

Can also build multiple supported platforms. For example:

yarn build-platform --linux-arm --darwin // build both darwin x64 and linux arm64 platforms 

Also opened an issue in documentation-website and updated DEVELOPER_GUIDE.md.

@ananzh ananzh self-assigned this Oct 5, 2021
@ananzh ananzh closed this as completed in b07961a Oct 5, 2021
ananzh added a commit to ananzh/OpenSearch-Dashboards that referenced this issue Oct 5, 2021
yarn build flags in /src/dev/build/cli.ts are not updated to match
the renamed flags in de-couple PR (opensearch-project#795). This PR fixes the issue
and update the tests. Also modify words in DEVELOPER_GUIDE.md.

PR resolved:
opensearch-project#836

Backport PR:
opensearch-project#840

Signed-off-by: Anan Zhuang <ananzh@amazon.com>
ananzh added a commit to ananzh/OpenSearch-Dashboards that referenced this issue Oct 5, 2021
yarn build flags in /src/dev/build/cli.ts are not updated to match
the renamed flags in de-couple PR (opensearch-project#795). This PR fixes the issue
and update the tests. Also modify words in DEVELOPER_GUIDE.md.

PR resolved:
opensearch-project#836

Backport PR:
opensearch-project#840

Signed-off-by: Anan Zhuang <ananzh@amazon.com>
ananzh added a commit that referenced this issue Oct 5, 2021
yarn build flags in /src/dev/build/cli.ts are not updated to match
the renamed flags in de-couple PR (#795). This PR fixes the issue
and update the tests. Also modify words in DEVELOPER_GUIDE.md.

PR resolved:
#836

Backport PR:
#840

Signed-off-by: Anan Zhuang <ananzh@amazon.com>
ananzh added a commit that referenced this issue Oct 5, 2021
yarn build flags in /src/dev/build/cli.ts are not updated to match
the renamed flags in de-couple PR (#795). This PR fixes the issue
and update the tests. Also modify words in DEVELOPER_GUIDE.md.

PR resolved:
#836

Backport PR:
#840

Signed-off-by: Anan Zhuang <ananzh@amazon.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

3 participants