Skip to content

Commit e0b02e7

Browse files
committed
README.md: document usage of --squash
1 parent 9289fd1 commit e0b02e7

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

README.md

+9-2
Original file line numberDiff line numberDiff line change
@@ -44,10 +44,17 @@ is the recommended way of maintaining a copy of the rules inside the
4444
changes also locally, test them and then push them back to the shared
4545
repository at a later time.
4646

47+
We no longer care about importing the full commit history, so `--squash` should be used
48+
when submitting a `release-tools` update. Also make sure that the PR for that
49+
contains the automatically generated commit message in the PR description.
50+
It contains the list of individual commits that were squashed. The script from
51+
https://github.com/kubernetes-csi/csi-release-tools/issues/7 can create such
52+
PRs automatically.
53+
4754
Cheat sheet:
4855

49-
- `git subtree add --prefix=release-tools https://github.com/kubernetes-csi/csi-release-tools.git master` - add release tools to a repo which does not have them yet (only once)
50-
- `git subtree pull --prefix=release-tools https://github.com/kubernetes-csi/csi-release-tools.git master` - update local copy to latest upstream (whenever upstream changes)
56+
- `git subtree add --squash --prefix=release-tools https://github.com/kubernetes-csi/csi-release-tools.git master` - add release tools to a repo which does not have them yet (only once)
57+
- `git subtree pull --squash --prefix=release-tools https://github.com/kubernetes-csi/csi-release-tools.git master` - update local copy to latest upstream (whenever upstream changes)
5158
- edit, `git commit`, `git subtree push --prefix=release-tools [email protected]:<user>/csi-release-tools.git <my-new-or-existing-branch>` - push to a new branch before submitting a PR
5259

5360
verify-shellcheck.sh

0 commit comments

Comments
 (0)