kata-containers/rust-vmm-ci
1
0
Fork 0
mirror of https://github.com/rust-vmm/rust-vmm-ci.git synced 2026-08-05 03:08:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: update README to instruction to use new script

Browse Source 
Replace the manual instructions for setting up dependabot and .platform
file with instructions to run the new script. Move the explanation of
the .platform file to the testing section (where we were incorrectly
claiming that we only support x86_64 and aarch64, so fix that up too).

Signed-off-by: Patrick Roy <roypat@amazon.co.uk>
This commit is contained in:
Patrick Roy
2025-08-15 14:37:37 +01:00
committed by ShadowCurse
parent 6df971bbc2
commit 1d65d26c96
1 changed files with 14 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
README.md
View File

@@ -25,7 +25,16 @@ git submodule add https://github.com/rust-vmm/rust-vmm-ci.git
git commit -s -m "Added rust-vmm-ci as submodule" git commit -s -m "Added rust-vmm-ci as submodule"
``` ```
2. Create the coverage test configuration file named 2. Run the initial setup script for configuring dependabot for automated cargo
and submodule updates, as well as configuring which hardware platforms CI
should be run for:
```bash
# Script has to be run relative to the repository root!
./rust-vmm-ci/setup_repository.sh
```
3. Create the coverage test configuration file named
`coverage_config_ARCH.json` in the root of the repository, where `ARCH` is the `coverage_config_ARCH.json` in the root of the repository, where `ARCH` is the
architecture of the machine. architecture of the machine.
There are two coverage test configuration files, one per each platform. There are two coverage test configuration files, one per each platform.
@@ -55,14 +64,6 @@ Additionally, the following optional fields are available:
This file is required for the coverage integration so it needs to be added This file is required for the coverage integration so it needs to be added
to the repository as well. to the repository as well.
3. Copy one of the two provided dependabot configurations to `.github/dependabot.yml`,
e.g. run `cp rust-vmm-ci/dependabot-{weekly,monthly}.yml .github/dependabot.yml`.
Note that just symlinking the file does not work, as dependabot will not
follow symlinks into submodules. This means that updates to these files made in
rust-vmm-ci will need to be manually consumed for now. We recommend setting up
weekly dependabot updates only if the crate receives multiple contributions a week,
and if you expect to have the bandwidth to address weekly dependency PRs.
4. Create a new pipeline definition in Buildkite. For this step ask one of the 4. Create a new pipeline definition in Buildkite. For this step ask one of the
rust-vmm Buildkite [admins](CODEOWNERS) to create one for you. The process is explained rust-vmm Buildkite [admins](CODEOWNERS) to create one for you. The process is explained
[here](https://github.com/rust-vmm/community/blob/main/docs/setup_new_repo.md#set-up-ci). [here](https://github.com/rust-vmm/community/blob/main/docs/setup_new_repo.md#set-up-ci).
@@ -119,24 +120,7 @@ For most use cases, overriding or extending the configuration is not necessary.
want to do so if, for example, the platform needs a custom device that is not available want to do so if, for example, the platform needs a custom device that is not available
on the existing test instances or if we need a specialized hypervisor. on the existing test instances or if we need a specialized hypervisor.
6. Tests will be running on `x86_64` and `aarch64` platforms by default. To change 6. The code owners of the repository will have to setup a WebHook for
this, e.g. to enable other experimental platforms like `riscv64`, a `.platform`
file can be included in the repository root. This file documents what platforms
are to be enabled for the repository.
If `.platform` file is provided, it will be strictly observed. In `.platform`
file, each platform are separated by newline character. Currently, we support
`x86_64`, `aarch64` and `riscv64` platforms.
For example, we can enable tests to be run on `riscv64` platform in addition to
`x86_64` and `aarch64` by:
```
x86_64
aarch64
riscv64
```
7. The code owners of the repository will have to setup a WebHook for
triggering the CI on triggering the CI on
[pull request](https://developer.github.com/v3/activity/events/types/#pullrequestevent) [pull request](https://developer.github.com/v3/activity/events/types/#pullrequestevent)
and [push](https://developer.github.com/v3/activity/events/types/#pushevent) and [push](https://developer.github.com/v3/activity/events/types/#pushevent)
@@ -148,7 +132,9 @@ The [Buildkite](https://buildkite.com) pipeline is the definition of tests to
be run as part of the CI. It includes steps for running unit tests and linters be run as part of the CI. It includes steps for running unit tests and linters
(including coding style checks), and computing the coverage. (including coding style checks), and computing the coverage.
Currently the tests can run on Linux `x86_64` and `aarch64` hosts. Currently the tests can run on Linux `x86_64`, `aarch64` and `riscv64`
(virtualized inside QEMU) hosts. Which hosts tests should be ran for is
determined by the `.platform` file in the repository root.
Example of step that checks the build: Example of step that checks the build: