-
Notifications
You must be signed in to change notification settings - Fork 29
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
move update rust-vmm-ci to its own file
It was rather hard to find this runbook because it was hiding in the contributing guidelines readme. The runbook was also slightly outdated, so it now mentions Dependabot. Signed-off-by: Andreea Florescu <fandree@amazon.com>
- Loading branch information
1 parent
e0489ab
commit d30acb0
Showing
4 changed files
with
83 additions
and
79 deletions.
There are no files selected for viewing
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
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
# Updating the rust-vmm-ci | ||
|
||
All rust-vmm components are tested using the | ||
[rust-vmm-ci](https://github.com/rust-vmm/rust-vmm-ci/) submodule. | ||
For repositories that have Dependabot enabled, PRs for updating rust-vmm-ci | ||
will be opened automatically every week in case of changes. The repository | ||
maintainers (or the gatekeepers in case the repository does not have | ||
active maintainers) are responsible for reviewing the PRs that update | ||
rust-vmm-ci, and fix or find owners for any problems that arise from the update. | ||
|
||
## Manual Update of rust-vmm-ci | ||
|
||
In case the automatic update via Dependabot is not working or you want to get | ||
the update in before the automatic schedule, you can follow the next steps to | ||
manually update it. | ||
|
||
The following commands must run starting from the local directory that | ||
corresponds to the git repository where the submodule needs to be updated. | ||
|
||
1. Make sure the `rust-vmm-ci` submodule is initialized locally: | ||
|
||
```bash | ||
git submodule update --init --recursive | ||
``` | ||
|
||
2. Get the commit sha of the current commit. | ||
|
||
```bash | ||
cd rust-vmm-ci | ||
OLD_COMMIT=`git rev-parse HEAD` | ||
``` | ||
|
||
3. Update rust-vmm-ci to the latest commit on main: | ||
|
||
```bash | ||
git pull https://github.com/rust-vmm/rust-vmm-ci/ main | ||
``` | ||
|
||
4. Get the pretty print of commits (this helps us keep track of updates): | ||
|
||
```bash | ||
git log --abbrev-commit --pretty=oneline ${OLD_COMMIT}..HEAD | ||
``` | ||
|
||
5. Add the submodule update to a new commit: | ||
|
||
```bash | ||
# Change the directory to the root directory of the repo | ||
cd .. | ||
git add rust-vmm-ci | ||
git commit -s | ||
``` | ||
|
||
For the commit message use the text from step 4, but remove any branch | ||
information that it might contain. The text should only have a list of sha1 | ||
and a short description. | ||
|
||
Example of commit message update: | ||
|
||
```bash | ||
commit 6c984917be09327cfbe4c72b92825dbed3477c81 (HEAD -> update_rust_vmm_ci) | ||
Author: Andreea Florescu <fandree@amazon.com> | ||
Date: Tue Aug 11 12:00:59 2020 +0200 | ||
|
||
updated rust-vmm-ci | ||
|
||
0fc8ced refactor test_benchmark.py | ||
741b894 checkout to PR branch before finishing test_bench | ||
645a5c3 test_bench: don't crash when no bench on master | ||
bd32544 Fetch origin in benchmark test | ||
35beb91 Fix commit message test | ||
53427aa benchmarks: add test that can run at every PR | ||
abd2c90 Add test for commit message format | ||
fe859f4 Update container image to v6 | ||
75d7254 run cargo check on all features | ||
Signed-off-by: Andreea Florescu <fandree@amazon.com> | ||
``` |