Update documentation #1136
Merged
Update documentation #1136
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thanks for your PR. The following commands are available:
|
antoninbas
force-pushed
the
documentation-updates
branch
from
e5d0c78 to
1378881
Compare
abhiraut
reviewed
Aug 21, 2020
antoninbas
force-pushed
the
documentation-updates
branch
from
1378881 to
9b70e7c
Compare
abhiraut
previously approved these changes
Aug 25, 2020
lzhecheng
reviewed
Aug 25, 2020
ci/README.md
Outdated
|
|
||
| We run 4 different categories of tests as part of CI: | ||
| * **unit tests**: most Go packages for Antrea include some unit tests written | ||
| using the [Go `testing`] package. Unit tests typically rely on mock testing |
There was a problem hiding this comment.
I wonder why [Go testing], not [Go testing] or Go [testing] ? I think it looks strange.
There was a problem hiding this comment.
Changed to Go [testing]
lzhecheng
reviewed
Aug 25, 2020
ci/README.md
Outdated
| * **unit tests**: most Go packages for Antrea include some unit tests written | ||
| using the [Go `testing`] package. Unit tests typically rely on mock testing | ||
| to isolate the package being tested, and abstract platform-specific | ||
| functionality hidden behing interfaces. When adding a new package or |
There was a problem hiding this comment.
Suggested change
| functionality hidden behing interfaces. When adding a new package or | |
| functionality hidden behind interfaces. When adding a new package or |
tnqn
reviewed
Aug 25, 2020
ci/README.md
Outdated
| typically exercise multiple Go packages to ensure that they are working | ||
| correctly together. In the case of Antrea, integration tests may create an | ||
| actual OVS bridge, which is why they depend on the OVS daemons running, and | ||
| are typically run inside a Docker image, even on Linux. Write integrations |
There was a problem hiding this comment.
Suggested change
| are typically run inside a Docker image, even on Linux. Write integrations | |
| are typically run inside a Docker image, even on Linux. Write integration |
ci/README.md
Outdated
| also written using the [Go `testing`] package. Unlike the two previous test | ||
| categories, these assume that Antrea is running on an actual cluster and | ||
| require a kubeconfig file as well as SSH access to the cluster | ||
| Nodes. Instructions on how to run these tests, including how to setup a local |
There was a problem hiding this comment.
These lines seem not wrapped strictly, e.g. the above line has enough space for "Node."
There was a problem hiding this comment.
It's funny, The auto-wrap in emacs refused to place Nodes on the same line as cluster. I had to do it manually...
* add missing linters * emphasize that new test cases should be added as part of new contributions and include more details about the different categories of tests we support; this is related to antrea-io#989
antoninbas
force-pushed
the
documentation-updates
branch
from
9b70e7c to
03f1179
Compare
|
Thanks for the reviews, I addressed all comments |
|
/skip-all |
GraysonWu
pushed a commit
to GraysonWu/antrea
that referenced
this pull request
Sep 22, 2020
* Update documentation * add missing linters * emphasize that new test cases should be added as part of new contributions and include more details about the different categories of tests we support; this is related to antrea-io#989 * Address review comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
contributions and include more details about the different categories
of tests we support; this is related to
Obtain "passing" CII Best Practices badge #989