-
Notifications
You must be signed in to change notification settings - Fork 9.9k
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
Add a test status section to display testgrid status. #17508
Conversation
Not sure README.md is the right place for this, but it seems to be useful information to display somewhere on the website. @ahrtr @serathius |
README.md
Outdated
@@ -133,6 +133,19 @@ Now it's time to dig into the full etcd API and other guides. | |||
[security]: https://etcd.io/docs/latest/op-guide/security | |||
[tuning]: https://etcd.io/docs/latest/tuning | |||
|
|||
## Test Status |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would it be better to have it in CONTRIBUTING.md? or one of Documentation/contributor-guide
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My vote would be CONTRIBUTING.md
as a new heading below the "Create a pull request" header: https://github.com/etcd-io/etcd/blob/main/CONTRIBUTING.md#create-a-pull-request
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggest to add one more doc something like test-status.md
under Documentation/contributor-guide
, and then add an item under Find something to work on to point to the doc.
Either way works for me. The goal is to have people periodically check and drive to fix all the flaky test. Leave it to @jmhbnz to coordinate this via the bi-weekly bug triage meeting?
1b7704a
to
3341150
Compare
/retest |
CONTRIBUTING.md
Outdated
|
||
If you find any flaky tests on testgrid, please | ||
|
||
1. open an issue with the `type/flake` label. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we expect each contributor raise issue for the flaky test? Or should we take care of it? @jmhbnz
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm happy for contributors to open issues. We should probably suggest the check for existing issues first though.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should probably suggest the check for existing issues first though.
Agreed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall LGTM - Just a few nitpicks below if you have time.
CONTRIBUTING.md
Outdated
|
||
If you find any flaky tests on testgrid, please | ||
|
||
1. open an issue with the `type/flake` label. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm happy for contributors to open issues. We should probably suggest the check for existing issues first though.
Signed-off-by: Siyuan Zhang <[email protected]>
3341150
to
e2d159f
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm
Thanks
Please read https://github.com/etcd-io/etcd/blob/main/CONTRIBUTING.md#contribution-flow.
Related to #13167.