diff options
| author | nikhiljindal <nikhiljindal@google.com> | 2015-12-17 15:04:42 -0800 |
|---|---|---|
| committer | nikhiljindal <nikhiljindal@google.com> | 2015-12-18 15:14:57 -0800 |
| commit | 3d4cf50dd255c732440474b1ddf70e96a65c8f77 (patch) | |
| tree | 0c66f57611305cfc7656a23848f9a5f0670b6668 | |
| parent | 3fe09ccf4765238e57adbed266b2426f5aa0338b (diff) | |
Add instructions to run versionize-docs in cherrypick doc
| -rw-r--r-- | cherry-picks.md | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/cherry-picks.md b/cherry-picks.md index f407c949..6fae778f 100644 --- a/cherry-picks.md +++ b/cherry-picks.md @@ -47,6 +47,23 @@ hack/cherry_pick_pull.sh upstream/release-3.14 98765 This will walk you through the steps to propose an automated cherry pick of pull #98765 for remote branch `upstream/release-3.14`. +### Cherrypicking a doc change + +If you are cherrypicking a change which adds a doc, then you also need to run +`build/versionize-docs.sh` in the release branch to versionize that doc. +Ideally, just running `hack/cherry_pick_pull.sh` should be enough, but we are not there +yet: [#18861](https://github.com/kubernetes/kubernetes/issues/18861) + +To cherrypick PR 123456 to release-1.1, run the following commands after running `hack/cherry_pick_pull.sh` and before merging the PR: + +``` +$ git checkout -b automated-cherry-pick-of-#123456-upstream-release-1.1 + origin/automated-cherry-pick-of-#123456-upstream-release-1.1 +$ ./build/versionize-docs.sh release-1.1 +$ git commit -a -m "Running versionize docs" +$ git push origin automated-cherry-pick-of-#123456-upstream-release-1.1 +``` + ## Cherry Pick Review Cherry pick pull requests are reviewed differently than normal pull requests. In |