Skip to content

Commit

Permalink
Convert to table
Browse files Browse the repository at this point in the history
  • Loading branch information
@hugovk
hugovk committed Mar 23, 2024
1 parent 56c66a9 commit f57c3e4
Showing 1 changed file with 12 additions and 46 deletions.
58 changes: 12 additions & 46 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -265,52 +265,18 @@ dry_run: git checkout main
dry_run: git branch -D backport-1e32a1b-3.11
```

### `--pr-remote` option

This will generate pull requests through a remote other than `origin`
(e.g. `pr`)

### `--upstream-remote` option

This will generate branches from a remote other than `upstream`/`origin`
(e.g. `python`)

### `--status` option

This will do `git status` for the CPython directory.

### `--abort` option

Cancels the current cherry-pick and cleans up the cherry-pick branch.

### `--continue` option

Continues the current cherry-pick, commits, pushes the current branch to
`origin`, opens the PR page, and cleans up the branch.

### `--no-push` option

Changes won't be pushed to remote. This allows you to test and make additional
changes. Once you're satisfied with local changes, use `--continue` to complete
the backport, or `--abort` to cancel and clean up the branch. You can also
cherry-pick additional commits, by:

```console
$ git cherry-pick -x <commit_sha1>
```

### `--no-auto-pr` option

PR creation page won't be automatically opened in the web browser or
if GH_AUTH is set, the PR won't be automatically opened through API.
This can be useful if your terminal is not capable of opening a useful web browser,
or if you use cherry-picker with a different Git hosting than GitHub.

### `--config-path` option

Allows to override default config file path
(`<PROJ-ROOT>/.cherry_picker.toml`) with a custom one. This allows cherry_picker
to backport projects other than CPython.
## Options

| Option | Description |
|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `--pr-remote` | This will generate pull requests through a remote other than `origin` (e.g. `pr`) |
| `--upstream-remote` | This will generate branches from a remote other than `upstream`/`origin` (e.g. `python`) |
| `--status` | This will do `git status` for the CPython directory |
| `--abort` | Cancels the current cherry-pick and cleans up the cherry-pick branch |
| `--continue` | Continues the current cherry-pick, commits, pushes the current branch to `origin`, opens the PR page, and cleans up the branch |
| `--no-push` | Changes won't be pushed to remote. This allows you to test and make additional changes. Once you're satisfied with local changes, use `--continue` to complete the backport, or `--abort` to cancel and clean up the branch. You can also cherry-pick additional commits, by:<br><br>`$ git cherry-pick -x <commit_sha1>` |
| `--no-auto-pr` | PR creation page won't be automatically opened in the web browser or if GH_AUTH is set, the PR won't be automatically opened through API. This can be useful if your terminal is not capable of opening a useful web browser, or if you use cherry-picker with a different Git hosting than GitHub |
| `--config-path` | Allows to override default config file path (`<PROJ-ROOT>/.cherry_picker.toml`) with a custom one. This allows cherry_picker to backport projects other than CPython |


## Creating pull requests
Expand Down

0 comments on commit f57c3e4

Please sign in to comment.