Skip to content

Commit

Permalink
Update DEVELOPER_GUIDE.md (#9368) (#9373)
Browse files Browse the repository at this point in the history
When building the OpenSearch Dashboards artifact for Linux, the build may fail on certain distributions. This issue stems from the recent upgrade from node-sass to dart-sass. The new process uses an embeddable module from dart-sass to process Sass files, which relies on a platform-specific compiler. On Linux, this module depends on glibc. However, some distributions—like Alpine Linux—use musl libc instead, which is incompatible with this module. I'm updating the DEVELOPER_GUIDE documentation to help other developers choose the appropriate distro for Docker images and avoid the pitfalls I encountered.
See the issue I created in Github explaining this reasoning: #9329
Also the forum where I posted the kind of error you see when building with a Linux Distribution that is incompatible with glibc: https://forum.opensearch.org/t/docker-a-error-error-worker-exitted-unexpectedly-with-code-1-last-message-bundleid-embeddable-type-running/23214


(cherry picked from commit 57e1d27)

Signed-off-by: Luis Beltrán <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
  • Loading branch information
1 parent 60c9cd6 commit b990e64
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion DEVELOPER_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -372,7 +372,7 @@ You could pass one or multiple flags. If you don't pass any flag, `yarn build-pl
Currently, the supported flags for this script are:

- `darwin` (builds Darwin x64)
- `linux` (builds Linux x64)
- `linux` (builds Linux x64) **Note:** This build relies on the `dart-sass-embeddable` module, which uses `glibc`. Some Linux distributions (such as Alpine Linux) use `musl` instead of `glibc` and are not compatible with this build. If you are using a musl-based distro, consider building on a glibc-based environment (for example, using a Docker image based on Debian or CentOS) to avoid compatibility issues.
- `linux-arm` (builds Linux ARM64).
- `windows` (builds Windows x64)

Expand Down

0 comments on commit b990e64

Please sign in to comment.