search

rust-vmm / community

rust-vmm community content
499 stars 28 forks source link

Add documentation about how to update rust-vmm-ci #94

Closed andreeaflorescu closed 4 years ago

andreeaflorescu commented 4 years ago

Add contribution guidelines about how to update the rust-vmm-ci version.

We could make it easier to trace changes by listing the summary of newly introduced commits. This can be in a contributing.md file, along with other thing we find useful.

Example of such commit: https://github.com/rust-vmm/event-manager/commit/90b55ec098f1675aac1a06be0aaeae9109ecb64d

andreeaflorescu commented 4 years ago

Instructions:

  1. Get the commit sha of the current commit. The following commands need to be run in the git repository where the submodule needs to be updated:

    cd rust-vmm-ci
OLD_COMMIT=`git rev-parse HEAD`

  2. Get the pretty print of commits:

    git log --abbrev-commit --pretty=oneline ${OLD_COMMIT}..HEAD

  3. Add the submodule update to a new commit:

    # 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 2, but remove any branch information that it might contains. The text should only have a list of sha1 and a short descriptions.