Add instructions to run versionize-docs in cherrypick doc

This commit is contained in:
nikhiljindal 2015-12-17 15:04:42 -08:00
parent 13ec258ffd
commit 1560696108

View File

@ -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 This will walk you through the steps to propose an automated cherry pick of pull
#98765 for remote branch `upstream/release-3.14`. #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 Review
Cherry pick pull requests are reviewed differently than normal pull requests. In Cherry pick pull requests are reviewed differently than normal pull requests. In