docs: adding an initial CI documentation #8988
Conversation
There was a problem hiding this comment.
Thanks for making this more official @beraldoleal ! We can then work to improve it with the community.
|
Hi @beraldoleal ! This still requires the usual |
beraldoleal
changed the title
|
/test |
ci/README.md
Outdated
| ### Running the tests as part of the CI | ||
|
|
||
| If you're a maintainer of the project, you'll be able to kick in the tests by | ||
| yourself. With the current approach, you just need to add the `"ok-to-test"` | ||
| label and the tests will automatically start. We're moving, though, to use a | ||
| `/test` command as part of a GitHub review comment, which will simplify this | ||
| process. | ||
|
|
||
| If you're not a maintainer, please, send a message on Slack or wait till one of | ||
| the maintainers reviews your PR. Maintainers will then kick in the tests on | ||
| your behalf. | ||
|
|
||
| In case a test fails and there's the suspicion it happens due to flakiness in | ||
| the test itself, please, create an issue for us, and then re-run the tests | ||
| following these steps: | ||
|
|
||
| - Locate which tests is failing | ||
| - Click in "details" | ||
| - In the top right corner, click in "Re-run jobs" | ||
| - And then in "Re-run failed jobs" | ||
| - And finally click in the green "Re-run jobs" button | ||
|
|
||
| > [!NOTE] | ||
| > TODO: We need figures here |
There was a problem hiding this comment.
I wrote a script to find failed tests in one click. Maybe it is worth listing here for a quick check. See: #9030.
|
Sorry for the late reply here. Fixed with force-push. |
|
/test |
beraldoleal
force-pushed
the
ci-docs
branch
3 times, most recently
from
9205350
to
4452f43
Compare
|
@beraldoleal CI fails with : which is indeed the case AFAICT. Also, do we really need a symbolic link ? Cannot you just add a Or maybe even |
beraldoleal
force-pushed
the
ci-docs
branch
2 times, most recently
from
1f3675b
to
ef60126
Compare
|
/test |
|
/retest-arm-main |
| - Run the following tests: | ||
| - Tests depending on the generated tarball | ||
| - Metrics (runs on bare-metal) | ||
| - `docker` (runs on Azure small instances) |
There was a problem hiding this comment.
I know it'd be harder and more prone to changes but it'd be nice to put links to the workflow files at least for the main pipelines so people can quickly find them and see the details.
There was a problem hiding this comment.
Definitely helpful, but I will leave this to others in following PRs. This is just an attempt to move the content from google docs here, because of annoying spam/bots there.
| - And finally click in the green "Re-run jobs" button | ||
|
|
||
| > [!NOTE] | ||
| > TODO: We need figures here |
There was a problem hiding this comment.
Do you want to mention the re-run all button? From my experience that's what people use the most anyway... (which is sad)
There was a problem hiding this comment.
It is mentioned already on line 156. I would keep like that and improve the workflow later.
| ## Known limitations | ||
|
|
||
| As the GitHub actions are structured right now we cannot: Test the addition of a | ||
| GitHub action that's not triggered by a pull_request event as part of the PR. |
There was a problem hiding this comment.
How about discussing the workaround (sending a PR with always-passing version and then follow-up with the real code?)
There was a problem hiding this comment.
Given this is a current limitation, I would suggest creating an issue to discuss the workaround there.
|
@beraldoleal I've made this a draft to be sure it doesn't get merged before you had time to look at @ldoktor 's comments. |
This is actually a first attempt to document our CI, and all this content was based on the document created by Fabiano Fidencio (kudos to him). We are just moving the content and discussion from Google Docs to here. I used the "poetic license" to add some notes on what I believe our CI will look like in the future. Fixes kata-containers#9006 Co-authored-by: Fabiano Fidêncio <fabiano.fidencio@intel.com> Signed-off-by: Beraldo Leal <bleal@redhat.com>
|
/test |
|
Unrelated flaky CI blocking the way again. I'll force merge this PR. |
Nice, |
This is actually a first attempt to document our CI, and all this content was based on the document created by @fidencio (kudos to him). We are just moving the content and discussion from Google Docs to here.
I used the "poetic license" to add some notes on what I believe our CI will look like in the future.
TIP: I suggest viewing the file in preview mode and also enabling the TOC feature in Github for better navigation.