1
1
Usage (from a cloned CPython directory) ::
2
2
3
- cherry_picker [--pr-remote REMOTE] [--dry-run] [--status] [--abort/--continue] [--push/--no-push] <commit_sha1> <branches>
3
+ cherry_picker [--pr-remote REMOTE] [--dry-run] [--config-path CONFIG-PATH] [-- status] [--abort/--continue] [--push/--no-push] <commit_sha1> <branches>
4
4
5
5
|pyversion status |
6
6
|pypi status |
@@ -117,22 +117,22 @@ Available config options::
117
117
e.g. a sha1 hash from the very first initial commit
118
118
("7f777ed95a19224294949e1b4ce56bbffcb1fe9f" by default)
119
119
120
- To setup the tool for using by custom project:
120
+ To customize the tool for used by other project:
121
121
122
- 1. Create a file called `.cherry_picker.toml ` in the project's root
123
- folder (alongside with `.git ` forlder ).
122
+ 1. Create a file called `` .cherry_picker.toml ` ` in the project's root
123
+ folder (alongside with `` .git `` folder ).
124
124
125
- 2. Add `team `, `repo ` and `check_sha ` config values as described above.
125
+ 2. Add `` team `` , `` repo `` and `` check_sha ` ` config values as described above.
126
126
127
- 3. Use `git add .cherry_picker.toml ` / `git commit ` to add the config
128
- into git.
127
+ 3. Use `` git add .cherry_picker.toml `` / `` git commit ` ` to add the config
128
+ into `` git `` .
129
129
130
- 4. Add `cherry_picker ` to development dependencies or just install it
131
- by `pip install cherry_picker `
130
+ 4. Add `` cherry_picker `` to development dependencies or install it
131
+ by `` pip install cherry_picker ` `
132
132
133
- 5. Now everything is ready, use `cherry_picker <commit_sha> <branch1 >
134
- <branch2> ` for cherry-picking changes from `<commit_sha ` into
135
- maintainance branches.
133
+ 5. Now everything is ready, use `` cherry_picker <commit_sha> <branch1>
134
+ <branch2> `` for cherry-picking changes from `` <commit_sha ` ` into
135
+ maintenance branches.
136
136
137
137
Demo
138
138
----
@@ -243,10 +243,11 @@ cherry-pick additional commits, by::
243
243
$ git cherry-pick -x <commit_sha1>
244
244
245
245
`--config-path ` option
246
- -------------------
246
+ ----------------------
247
247
248
248
Allows to override default config file path
249
- (`<PROJ-ROOT>/.cherry_picker.toml `) with a custom one.
249
+ (`<PROJ-ROOT>/.cherry_picker.toml `) with a custom one. This allows cherry_picker
250
+ to backport projects other than CPython.
250
251
251
252
252
253
Creating Pull Requests
@@ -308,3 +309,11 @@ in the directory where ``pyproject.toml`` exists::
308
309
.. |travis status | image :: https://travis-ci.org/python/core-workflow.svg?branch=master
309
310
:target: https://travis-ci.org/python/core-workflow
310
311
312
+ Changelog
313
+ =========
314
+
315
+ 1.0.0
316
+ -----
317
+
318
+ - Support configuration file by using `--config-path ` option, or by adding
319
+ `.cherry-picker.toml ` file to the root of the project.
0 commit comments