Add Cherry pick script guide #593
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kubeedge-bot
added
the
size/M
fisherxu
reviewed
Jul 3, 2024
docs/developer/cherry_pick.md
Outdated
| ./cherry_pick_pull.sh upstream/release-3.14 12345 56789 | ||
| ``` | ||
|
|
||
| If the arguments number less than 2, this script will exit with help information. |
There was a problem hiding this comment.
Suggested change
| If the arguments number less than 2, this script will exit with help information. | |
| If the number of parameters is less than 2, this script will exit with help information. |
There was a problem hiding this comment.
changed according to the review comment
xuemingdi
force-pushed
the
Cherry_pick_updates
branch
from
0ee4344
to
3b0232b
Compare
fisherxu
reviewed
Jul 5, 2024
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: fisherxu The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
kubeedge-bot
added
the
approved
docs/developer/cherry_pick.md
Outdated
| This page explains how to use shell script `hack/cherry_pick_pull.sh` in kubeedge/kubeedge repo to cherry pick the patch to release branch. | ||
|
|
||
|
|
||
| # Cherry Pick Settings |
There was a problem hiding this comment.
A little suggestion: ## Cherry Pick Settings is better than # . This way, we can display the catogary on the right and generate links for each part like:
There was a problem hiding this comment.
Thanks for reminding, I have changed.
docs/developer/cherry_pick.md
Outdated
|
|
||
| ```shell | ||
| # set GITHUB_USER | ||
| export GITHUB_USER = <your-github-user> |
There was a problem hiding this comment.
export GITHUB_USER=<your-github-user>
There was a problem hiding this comment.
Thanks, modified already
|
|
||
| ```shell | ||
| # examine whether the hub is installed successfully | ||
| which hub |
There was a problem hiding this comment.
Is it possible to add the command to install hub directly here?
There was a problem hiding this comment.
The installation of the hub command involves handling different platform and various scenarios. Therefore I am concerned that too many hub command installation description might affect the completeness and consistency of the current document. User could gain hub installation instructions easily from the link below.
docs/developer/cherry_pick.md
Outdated
|
|
||
| 3. Other environment variables setting | ||
|
|
||
| - variable `DRY_RUN` is used to skip `git push` and creating PR steps, This is useful for creating patches to a release branch without making a PR.When DRY_RUN is set the script will leave you in a branch containing the commits you cherry-picked. |
There was a problem hiding this comment.
Suggested change
| - variable `DRY_RUN` is used to skip `git push` and creating PR steps, This is useful for creating patches to a release branch without making a PR.When DRY_RUN is set the script will leave you in a branch containing the commits you cherry-picked. | |
| - The variable `DRY_RUN` is used to skip `git push` and create PR steps, This is useful for creating patches to a release branch without making a PR. When DRY_RUN is set the script will leave you in a branch containing the commits you cherry-picked. |
docs/developer/cherry_pick.md
Outdated
|
|
||
| - variable `DRY_RUN` is used to skip `git push` and creating PR steps, This is useful for creating patches to a release branch without making a PR.When DRY_RUN is set the script will leave you in a branch containing the commits you cherry-picked. | ||
|
|
||
| - variable `REGENERATE_DOCS` is used to regenerate documentation for the target branch after picking the specified commits, This is useful when picking commits containing changes to API documentation. **Note**: Set variable `REGENERATE_DOCS` may affect the cherry pick performance. |
There was a problem hiding this comment.
Suggested change
| - variable `REGENERATE_DOCS` is used to regenerate documentation for the target branch after picking the specified commits, This is useful when picking commits containing changes to API documentation. **Note**: Set variable `REGENERATE_DOCS` may affect the cherry pick performance. | |
| - The variable `REGENERATE_DOCS` is used to regenerate documentation for the target branch after picking the specified commits, This is useful when picking commits containing changes to API documentation. **Note**: Set variable `REGENERATE_DOCS` may affect the cherry pick performance. |
docs/developer/cherry_pick.md
Outdated
|
|
||
| - variable `REGENERATE_DOCS` is used to regenerate documentation for the target branch after picking the specified commits, This is useful when picking commits containing changes to API documentation. **Note**: Set variable `REGENERATE_DOCS` may affect the cherry pick performance. | ||
|
|
||
| - variables `UPSTREAM_REMOTE` (default: upstream) and `FORK_REMOTE` (default: origin) are used to override the default remote names to what you have locally. |
There was a problem hiding this comment.
Suggested change
| - variables `UPSTREAM_REMOTE` (default: upstream) and `FORK_REMOTE` (default: origin) are used to override the default remote names to what you have locally. | |
| - The variables `UPSTREAM_REMOTE` (default: upstream) and `FORK_REMOTE` (default: origin) are used to override the default remote names to what you have locally. |
docs/developer/cherry_pick.md
Outdated
|
|
||
| # Execution steps | ||
|
|
||
| 1. execute cherry_pick_pull.sh with parameters, at least include `remote branch` and `pr number` (could be multiple pr numbers) |
There was a problem hiding this comment.
Suggested change
| 1. execute cherry_pick_pull.sh with parameters, at least include `remote branch` and `pr number` (could be multiple pr numbers) | |
| 1. Execute cherry_pick_pull.sh with parameters, at least include `remote branch` and `pr number` (could be multiple pr numbers) |
xuemingdi
force-pushed
the
Cherry_pick_updates
branch
from
3b0232b
to
b4f5ecc
Compare
Signed-off-by: Xue Mingdi <[email protected]>
xuemingdi
force-pushed
the
Cherry_pick_updates
branch
from
b4f5ecc
to
9cd75cb
Compare
|
/lgtm |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Which issue(s) this PR fixes:
Fixes #
#425
What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
docs update
What is the current behavior? (You can also link to an open issue here)
Add auto cherry-pick guidance document for developers #425
What is the new behavior (if this is a feature change)?
Add user guide for cherry pick shell script usage.
Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)
No
Other information:
N.A