Skip to content

Commit

Permalink
docs: remove cargo test workspace command (#1048)
Browse files Browse the repository at this point in the history
Signed-off-by: Ruihang Xia <waynestxia@gmail.com>
Co-authored-by: Yiran <cuiyiran3@gmail.com>
Co-authored-by: Yingwen <realevenyag@gmail.com>
  • Loading branch information
3 people committed Jul 9, 2024
1 parent b26af97 commit 6115840
Show file tree
Hide file tree
Showing 8 changed files with 60 additions and 28 deletions.
14 changes: 12 additions & 2 deletions docs/nightly/en/contributor-guide/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,20 @@ The artifacts can be found under `$REPO/target/debug` or `$REPO/target/release`,

## Unit test

GreptimeDB is well-tested, the entire unit test suite is shipped with source code. To test them, run
GreptimeDB is well-tested, the entire unit test suite is shipped with source code. To test them, run with [nextest](https://nexte.st/index.html).

To install nextest using cargo, run:

```shell
cargo install cargo-nextest --locked
```

Or you can check their [docs](https://nexte.st/docs/installation/pre-built-binaries/) for other ways to install.

After nextest is ready, you can run the test suite with:

```shell
cargo test --workspace
cargo nextest run
```

## Docker
Expand Down
8 changes: 3 additions & 5 deletions docs/nightly/en/contributor-guide/tests/unit-test.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,10 @@
## Introduction

Unit tests are embedded into the codebase, usually placed next to the logic being tested.
They are written using Rust's `#[test]` attribute and can run with `cargo test --workspace`.
Since `GreptimeDB` orchestrates its components in the "workspace" manner, the tailing
`--workspace` is necessary to run all the unit cases.
They are written using Rust's `#[test]` attribute and can run with `cargo nextest run`.

The default test runner ships with `cargo` is a bit slow. It's recommended to use
[`nextest`](https://nexte.st/) to speed up the test procedure. You can install it with
The default test runner ships with `cargo` is not supported in GreptimeDB codebase. It's recommended
to use [`nextest`](https://nexte.st/) instead. You can install it with

```shell
cargo install cargo-nextest --locked
Expand Down
14 changes: 12 additions & 2 deletions docs/nightly/zh/contributor-guide/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,20 @@ cargo build # --release

## 单元测试

GreptimeDB 经过了充分的测试,整个单元测试套件都随源代码一起提供。通过以下命令来运行测试:
GreptimeDB 经过了充分的测试,整个单元测试套件都随源代码一起提供。要测试它们,请使用 [nextest](https://nexte.st/index.html)

要使用 cargo 安装 nextest,请运行:

```shell
cargo install cargo-nextest --locked
```

或者,你可以查看他们的[文档](https://nexte.st/docs/installation/pre-built-binaries/)以了解其他安装方式。

安装好 nextest 后,你可以使用以下命令运行测试套件:

```shell
cargo test --workspace
cargo nextest run
```

## Docker
Expand Down
8 changes: 3 additions & 5 deletions docs/nightly/zh/contributor-guide/tests/unit-test.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,10 @@
## Introduction

Unit tests are embedded into the codebase, usually placed next to the logic being tested.
They are written using Rust's `#[test]` attribute and can run with `cargo test --workspace`.
Since `GreptimeDB` orchestrates its components in the "workspace" manner, the tailing
`--workspace` is necessary to run all the unit cases.
They are written using Rust's `#[test]` attribute and can run with `cargo nextest run`.

The default test runner ships with `cargo` is a bit slow. It's recommended to use
[`nextest`](https://nexte.st/) to speed up the test procedure. You can install it with
The default test runner ships with `cargo` is not supported in GreptimeDB codebase. It's recommended
to use [`nextest`](https://nexte.st/) instead. You can install it with

```shell
cargo install cargo-nextest --locked
Expand Down
14 changes: 12 additions & 2 deletions docs/v0.8/en/contributor-guide/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,20 @@ The artifacts can be found under `$REPO/target/debug` or `$REPO/target/release`,

## Unit test

GreptimeDB is well-tested, the entire unit test suite is shipped with source code. To test them, run
GreptimeDB is well-tested, the entire unit test suite is shipped with source code. To test them, run with [nextest](https://nexte.st/index.html).

To install nextest using cargo, run:

```shell
cargo install cargo-nextest --locked
```

Or you can check their [docs](https://nexte.st/docs/installation/pre-built-binaries/) for other ways to install.

After nextest is ready, you can run the test suite with:

```shell
cargo test --workspace
cargo nextest run
```

## Docker
Expand Down
8 changes: 3 additions & 5 deletions docs/v0.8/en/contributor-guide/tests/unit-test.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,10 @@
## Introduction

Unit tests are embedded into the codebase, usually placed next to the logic being tested.
They are written using Rust's `#[test]` attribute and can run with `cargo test --workspace`.
Since `GreptimeDB` orchestrates its components in the "workspace" manner, the tailing
`--workspace` is necessary to run all the unit cases.
They are written using Rust's `#[test]` attribute and can run with `cargo nextest run`.

The default test runner ships with `cargo` is a bit slow. It's recommended to use
[`nextest`](https://nexte.st/) to speed up the test procedure. You can install it with
The default test runner ships with `cargo` is not supported in GreptimeDB codebase. It's recommended
to use [`nextest`](https://nexte.st/) instead. You can install it with

```shell
cargo install cargo-nextest --locked
Expand Down
14 changes: 12 additions & 2 deletions docs/v0.8/zh/contributor-guide/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,20 @@ cargo build # --release

## 单元测试

GreptimeDB 经过了充分的测试,整个单元测试套件都随源代码一起提供。通过以下命令来运行测试:
GreptimeDB 经过了充分的测试,整个单元测试套件都随源代码一起提供。要测试它们,请使用 [nextest](https://nexte.st/index.html)

要使用 cargo 安装 nextest,请运行:

```shell
cargo install cargo-nextest --locked
```

或者,你可以查看他们的[文档](https://nexte.st/docs/installation/pre-built-binaries/)以了解其他安装方式。

安装好 nextest 后,你可以使用以下命令运行测试套件:

```shell
cargo test --workspace
cargo nextest run
```

## Docker
Expand Down
8 changes: 3 additions & 5 deletions docs/v0.8/zh/contributor-guide/tests/unit-test.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,10 @@
## Introduction

Unit tests are embedded into the codebase, usually placed next to the logic being tested.
They are written using Rust's `#[test]` attribute and can run with `cargo test --workspace`.
Since `GreptimeDB` orchestrates its components in the "workspace" manner, the tailing
`--workspace` is necessary to run all the unit cases.
They are written using Rust's `#[test]` attribute and can run with `cargo nextest run`.

The default test runner ships with `cargo` is a bit slow. It's recommended to use
[`nextest`](https://nexte.st/) to speed up the test procedure. You can install it with
The default test runner ships with `cargo` is not supported in GreptimeDB codebase. It's recommended
to use [`nextest`](https://nexte.st/) instead. You can install it with

```shell
cargo install cargo-nextest --locked
Expand Down

0 comments on commit 6115840

Please sign in to comment.