This is an automated email from the ASF dual-hosted git repository. jiacai2050 pushed a commit to branch fix-compile in repository https://gitbox.apache.org/repos/asf/horaedb-docs.git
commit 369c7d29688f8985db072eda37f44272174e438d Author: jiacai2050 <[email protected]> AuthorDate: Mon Oct 21 15:01:48 2024 +0800 fix: update compile section --- .github/workflows/deploy.yml | 1 - .github/workflows/lint.yml | 13 +++++++++++++ content/cn/docs/dev/compile_run.md | 16 +++++++--------- content/en/docs/dev/compile_run.md | 14 +++++++------- 4 files changed, 27 insertions(+), 17 deletions(-) diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 7b3aff3..20b6c43 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -30,7 +30,6 @@ jobs: HUGO_ENV: production run: | npm i -D postcss postcss-cli autoprefixer - hugo mod get hugo --minify # copy .asf.yaml to ./public, asf site needs it. - run: cp .asf.yaml ./public diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index b94eae6..81cf233 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -28,3 +28,16 @@ jobs: # if you encounter error, rerun the command below and commit the changes make lint git diff --exit-code + - name: Setup Hugo + uses: peaceiris/actions-hugo@v3 + with: + hugo-version: 'latest' + extended: true + - name: Build with Hugo + env: + # For maximum backward compatibility with Hugo modules + HUGO_ENVIRONMENT: production + HUGO_ENV: production + run: | + npm i -D postcss postcss-cli autoprefixer + hugo --minify diff --git a/content/cn/docs/dev/compile_run.md b/content/cn/docs/dev/compile_run.md index ba09a73..5801889 100644 --- a/content/cn/docs/dev/compile_run.md +++ b/content/cn/docs/dev/compile_run.md @@ -5,7 +5,9 @@ weight: 10 为了编译 HoraeDB, 首先需要安装相关的依赖（包括 `Rust` 的工具链)。 -# 依赖(Ubuntu20.04) +# 依赖 + +## Ubuntu 假设我们的开发环境是 Ubuntu20.04, 可以执行如下命令来安装所需的依赖。 @@ -13,11 +15,9 @@ weight: 10 sudo apt install git curl gcc g++ libssl-dev pkg-config cmake protobuf-compiler ``` -需要注意的是，项目的编译对 cmake、gcc、g++等依赖项有版本要求。 - -如果你的开发环境是旧的 Linux 发行版，有必要手动安装这些依赖项的高版本。 +需要注意的是，项目的编译对 cmake 有版本要求。如果你的开发环境是旧的 Linux 发行版，有必要手动安装这些依赖项的高版本。 -# 依赖(MacOS) +## macOS 如果你的开发环境是 `MacOS` ，可以使用如下命令手动安装这些依赖项的高版本。 @@ -52,16 +52,14 @@ source $HOME/.cargo/env # 编译运行 -注意：gcc 版本要求是 8, 更高的版本可能出现编译报错。该问题在 [issue-1506](https://github.com/apache/incubator-horaedb/issues/1506) 中跟进。 - 编译 HoraeDB 命令如下: ``` -cargo build --release +cargo build ``` 然后可以使用特定的配置文件运行 HoraeDB。 ```bash -./target/release/horaedb-server --config ./docs/minimal.toml +./target/debug/horaedb-server --config ./docs/minimal.toml ``` diff --git a/content/en/docs/dev/compile_run.md b/content/en/docs/dev/compile_run.md index 21b31a3..d744d23 100644 --- a/content/en/docs/dev/compile_run.md +++ b/content/en/docs/dev/compile_run.md @@ -5,7 +5,9 @@ weight: 30 In order to compile HoraeDB, some relevant dependencies(including the `Rust` toolchain) should be installed. -# Dependencies(Ubuntu20.04) +# Dependencies + +## Ubuntu Assuming the development environment is Ubuntu20.04, execute the following command to install the required dependencies: @@ -13,9 +15,9 @@ Assuming the development environment is Ubuntu20.04, execute the following comma sudo apt install git curl gcc g++ libssl-dev pkg-config cmake protobuf-compiler ``` -It should be noted that the compilation of the project has version requirements for dependencies such as cmake, gcc, g++, etc. If your development environment is an old Linux distribution, it is necessary to manually install these dependencies of a higher version. +It should be noted that the compilation of the project requires a higher version of CMake; if your development environment is an older Linux distribution, you will need to manually install the dependencies for a higher version. -# Dependencies(MacOS) +## macOS If the development environment is MacOS, execute the following command to install the required dependencies. @@ -49,16 +51,14 @@ source $HOME/.cargo/env # Compile and Run -Note: The gcc version required is 8; using higher versions may result in compilation errors. This issue is being tracked in [issue-1506](https://github.com/apache/incubator-horaedb/issues/1506). - Compile HoraeDB by the following command: ``` -cargo build --release +cargo build ``` Then you can run HoraeDB using the default configuration file provided in the codebase. ```bash -./target/release/horaedb-server --config ./docs/minimal.toml +./target/debug/horaedb-server --config ./docs/minimal.toml ``` --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
