Skip to content

Commit ad2d96b

Browse files
committed
doc: update README to instruction to use new script
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 <[email protected]>
1 parent fe1cd4d commit ad2d96b

File tree

1 file changed

+14
-28
lines changed

1 file changed

+14
-28
lines changed

README.md

Lines changed: 14 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,16 @@ git submodule add https://github.com/rust-vmm/rust-vmm-ci.git
2525
git commit -s -m "Added rust-vmm-ci as submodule"
2626
```
2727

28-
2. Create the coverage test configuration file named
28+
2. Run the initial setup script for configuring dependabot for automated cargo
29+
and submodule updates, as well as configuring which hardware platforms CI
30+
should be run for:
31+
32+
```bash
33+
# Script has to be run relative to the repository root!
34+
./rust-vmm-ci/setup_repository.sh
35+
```
36+
37+
3. Create the coverage test configuration file named
2938
`coverage_config_ARCH.json` in the root of the repository, where `ARCH` is the
3039
architecture of the machine.
3140
There are two coverage test configuration files, one per each platform.
@@ -55,14 +64,6 @@ Additionally, the following optional fields are available:
5564
This file is required for the coverage integration so it needs to be added
5665
to the repository as well.
5766

58-
3. Copy one of the two provided dependabot configurations to `.github/dependabot.yml`,
59-
e.g. run `cp rust-vmm-ci/dependabot-{weekly,monthly}.yml .github/dependabot.yml`.
60-
Note that just symlinking the file does not work, as dependabot will not
61-
follow symlinks into submodules. This means that updates to these files made in
62-
rust-vmm-ci will need to be manually consumed for now. We recommend setting up
63-
weekly dependabot updates only if the crate receives multiple contributions a week,
64-
and if you expect to have the bandwidth to address weekly dependency PRs.
65-
6667
4. Create a new pipeline definition in Buildkite. For this step ask one of the
6768
rust-vmm Buildkite [admins](CODEOWNERS) to create one for you. The process is explained
6869
[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.
119120
want to do so if, for example, the platform needs a custom device that is not available
120121
on the existing test instances or if we need a specialized hypervisor.
121122

122-
6. Tests will be running on `x86_64` and `aarch64` platforms by default. To change
123-
this, e.g. to enable other experimental platforms like `riscv64`, a `.platform`
124-
file can be included in the repository root. This file documents what platforms
125-
are to be enabled for the repository.
126-
127-
If `.platform` file is provided, it will be strictly observed. In `.platform`
128-
file, each platform are separated by newline character. Currently, we support
129-
`x86_64`, `aarch64` and `riscv64` platforms.
130-
131-
For example, we can enable tests to be run on `riscv64` platform in addition to
132-
`x86_64` and `aarch64` by:
133-
```
134-
x86_64
135-
aarch64
136-
riscv64
137-
```
138-
139-
7. The code owners of the repository will have to setup a WebHook for
123+
6. The code owners of the repository will have to setup a WebHook for
140124
triggering the CI on
141125
[pull request](https://developer.github.com/v3/activity/events/types/#pullrequestevent)
142126
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
148132
be run as part of the CI. It includes steps for running unit tests and linters
149133
(including coding style checks), and computing the coverage.
150134

151-
Currently the tests can run on Linux `x86_64` and `aarch64` hosts.
135+
Currently the tests can run on Linux `x86_64`, `aarch64` and `riscv64`
136+
(virtualized inside QEMU) hosts. Which hosts tests should be ran for is
137+
determined by the `.platform` file in the repository root.
152138

153139
Example of step that checks the build:
154140

0 commit comments

Comments
 (0)