diff --git a/DEVELOPER.md b/DEVELOPER.md index c30ebd17da5..97ad5217a58 100644 --- a/DEVELOPER.md +++ b/DEVELOPER.md @@ -122,6 +122,7 @@ dnf install \ perl-IPC-Cmd \ protobuf-devel \ unzip \ + tar \ valgrind \ valgrind-devel \ zlib-devel @@ -145,6 +146,8 @@ You can follow [Managing your personal access token](https://docs.github.com/en/ # export GITHUB_TOKEN=ghp_xxxxxx_your_access_token ``` +The build process is based on [Bazel](https://bazel.build/). Please make sure that you have the [required version](https://github.com/Kong/kong/blob/master/.bazelversion) installed. For more details please check out the [the build guide](https://github.com/Kong/kong/blob/master/build/README.md) + Finally, we start the build process: ``` diff --git a/build/README.md b/build/README.md index 7e795dff777..611173bdd84 100644 --- a/build/README.md +++ b/build/README.md @@ -3,6 +3,7 @@ This directory contains the build system for the project. The build system is designed to be used with the [Bazel](https://bazel.build/). It is designed to be running on Linux without root privileges, and no virtualization technology is required. +However, you need to match exactly the version of Bazel as configured [here](https://github.com/Kong/kong/blob/master/.bazelversion). The build system is tested on Linux (x86_64 and aarch64) and macOS (Intel chip and AppleSilicon Chip). @@ -252,3 +253,4 @@ Note: - On macOS, the build may not work with only Command Line Tools installed, you will typically see errors like `../libtool: line 154: -s: command not found`. In such case, installing Xcode should fix the issue. - If you have configure `git` to use SSH protocol to replace HTTPS protocol, but haven't setup SSH agent, you might see errors like `error: Unable to update registry crates-io`. In such case, set `export CARGO_NET_GIT_FETCH_WITH_CLI=true` to use `git` command line to fetch the repository. +- There are problems with [ccache](https://ccache.dev/) on Fedora. You can solve this by removing the path pointing to ccache from that `PATH` variable in you shell.