6 a.m.
We are not using the gerrit project now, and it was changed to read-only.
We are accepting now pull requests on github:
https://github.com/oVirt/vdsm/pulls
To contribute, use the standard github flow:
1. Fork vdsm on github
Example: https://github.com/nirs/vdsm
(you need to create a github account if you don't have one)
2. Clone your fork
Example: git clone git@github.com:nirs/vdsm.git
3. Push changes to your fork and submit pull requests
Example: https://github.com/oVirt/vdsm/pull/28
4. Check the github CI for your pull request
Example: https://github.com/oVirt/vdsm/pull/28/checks
Note: We don't do squash merges. When addressing comments, force push
to your fork.
Example: https://github.com/oVirt/ovirt-imageio/pull/15
Common issues:
1. How do I add reviewers to my pull request?
Once https://github.com/oVirt/vdsm/pull/28 will be merged, we will have
a CODEOWNERS file:
https://github.com/oVirt/vdsm/blob/96320682a8b41e440fbbb8ca624fd73efa95bd...
so github will assign reviews automatically.
Regardless you can add a comment on you patch like:
@{reviewer} please review.
2. How do I run OST with my pull request?
OST does not run yet automatically. You have 2 choices:
- Run OST locally (ask here how to run it)
- Use the Red Hat OST runner
(ask on rhev-devel(a)redhat.com how to use it)
When running OST, you can use the built rpms from your pull request:
https://github.com/oVirt/vdsm/actions/runs/1673718827
(see the artifacts.zip at the bottom)
3. How to backport a patch to stable branches?
Backport your patch(es) on top of the right stable branch (e.g. ovirt-4.4.z).
When you create a pull request, please choose the right branch.
The stable branches maintainers will be added for review automatically.
4. How to compare changes when a contributor submitted a new version?
When contributor force pushes, github shows:
nirs *force-pushed* the inactivity-timeout branch 2 times, most
recently from *790cc4c* to *38d08c8* 22 days ago
Click the "force-pushed" link to see the differences:
https://github.com/oVirt/ovirt-imageio/compare/790cc4c44c9c6577dae0badb3f...
5. How to download a pull request to my machine?
You can use the github command lline tool "gh":
gh pr checkout 28
See https://cli.github.com/ for more info.
(note: I did not try it yet)
6. How do I comment on commit message?
Github does not have this feature, you can use the review comment, or
add a separate
comment.
7. How to run CI on a single patch in my PR?
Github runs the CI for the entire PR. If your PR have several commits,
issues in early commits
fixed in later commits are hidden. To verify that all commits pass the
tests you can post the
submit a new branch to your local fork.
Example flow:
git checkout -b testing-foobar commit-id
git push origin testing-foobar
(check CI on your fork)
Alternatively, use smaller pull requests. You can submit pull request
based on another pull
request.
Nir