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

ci: update doc about ut #223

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

hawkingrei
Copy link
Member

Signed-off-by: Weizhen Wang [email protected]

What issue does this PR solve?

  • close #xxxx
  • to #xxxx

What is changed:

Signed-off-by: Weizhen Wang <[email protected]>
Copy link
Contributor

@tisonkun tisonkun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also you may fix the markup backquote in the following sections.

@@ -127,15 +127,17 @@ When you write complex unit tests, you may take a look at what test kits we have

### Running all tests

You can always run all tests by executing the `gotest` target in Makefile:
We have two ways to run all tests. The first one is to use `go test` directly:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

make ut is not "use go test directly"

```

This is almost equivalent to `go test ./...` but it enables and disables fail points before and after running tests.
The second one is to use bazel to run tests. The bazel will cache the test results and it is faster than the first one. But it need more storage space to save the cache. it is recommended to use the first one in the CI.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The second one is to use bazel to run tests. The bazel will cache the test results and it is faster than the first one. But it need more storage space to save the cache. it is recommended to use the first one in the CI.
The second one is to use bazel to run tests. Bazel will cache the test results and it is faster than the first one. But it needs more storage space to save the cache.

Also, I don't understand what " it is recommended to use the first one in the CI." means: you're talking about the second approach but now said the first approach is recommended in CI? Or what do you want to mean?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants