Skip to content

Commit

Permalink
Add PRs format to README
Browse files Browse the repository at this point in the history
Signed-off-by: futuretea <[email protected]>
  • Loading branch information
futuretea committed May 18, 2023
1 parent 3ed7578 commit 366f01e
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,20 @@ task update

Send `help` to the Slack app to get the help message

#### PRs format in commands

1. A number `0` means no PRs
2. A number greater than 0 means the PR number, e.g. `123` means the PR `123`
3. A string means a branch name in fork repo, e.g. `futuretea:dev` means the branch `dev` in user `futuretea`'s fork repo
4. Support multiple PRs or branches, separated by comma, e.g. `123,456,futuretea:dev`
5. Support backport PRs, e.g. `[email protected]` means backport PR `123` to branch `v1.1`
A complete example: `123,futuretea:[email protected]` will:
- Checkout the base branch, default to `master`
- Create a base branch named `pr-123-futuretea-dev-v1-1` from the base master
- Backport PR `123` to branch `v1.1`, cherry-pick the changes
- Backport branch `dev` in user `futuretea`'s fork repo to branch `v1.1`, cherry-pick the changes

#### Commands

- help - help
Expand Down

0 comments on commit 366f01e

Please sign in to comment.