Skip to content

Update readme with pip install instructions #130

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Mariatta merged 3 commits into from
Jun 19, 2017
Merged

Update readme with pip install instructions #130

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c819239
Update readme with installation instruction using pip.
Mariatta Jun 19, 2017
fa80613
Not using "how to" in demo section.
Mariatta Jun 19, 2017
e972a6d
Split verifying and setting up upstream remote
Mariatta Jun 19, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 20 additions & 16 deletions cherry_picker/readme.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,6 @@ maintenance branches (``3.6``, ``3.5``, ``2.7``).
It will prefix the commit message with the branch, e.g. ``[3.6]``, and then
opens up the pull request page.

This script will become obsolete once the cherry-picking bot is implemented.

Tests are to be written using pytest.


Expand All @@ -29,24 +27,28 @@ Requires Python 3.6.

::

$ git clone https://github.com/python/core-workflow.git
$ cd core-workflow
$ python3 -m venv venv
$ source venv/bin/activate
(venv) $ python -m pip install wheel
(venv) $ python -m pip install --upgrade .
(venv) $ python -m pip install cherry_picker

Specify an `upstream` remote in the cloned CPython repository::
The cherry picking script assumes that if an ``upstream`` remote is defined, then
it should be used as the source of upstream changes and as the base for
cherry-pick branches. Otherwise, ``origin`` is used for that purpose.

$ git remote add upstream https://github.com/python/cpython.git
Verify that an ``upstream`` remote is set to the CPython repository::

$ git remote -v
...
upstream https://github.com/python/cpython (fetch)
upstream https://github.com/python/cpython (push)

If needed, create the ``upstream`` remote::

$ git remote add upstream https://github.com/python/cpython.git

The cherry picking script assumes that if an `upstream` remote is defined, then
it should be used as the source of upstream changes and as the base for
cherry-pick branches. Otherwise, `origin` is used for that purpose.

By default, the PR branches used to submit pull requests back to the main
repository are pushed to `origin`. If this is incorrect, then the correct
repository are pushed to ``origin``. If this is incorrect, then the correct
remote will need be specified using the ``--pr-remote`` option (e.g.
``--pr-remote pr`` to use a remote named ``pr``).

Expand Down Expand Up @@ -95,7 +97,9 @@ Additional options::
Demo
----

https://asciinema.org/a/122815
- Installation: https://asciinema.org/a/125254

- Backport: https://asciinema.org/a/125256


Example
Expand Down Expand Up @@ -175,7 +179,7 @@ This will generate pull requests through a remote other than ``origin``
`--status` option
-----------------

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

`--abort` option
----------------
Expand All @@ -185,8 +189,8 @@ 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.
Continues the current cherry-pick, commits, pushes the current branch to
``origin``, opens the PR page, and cleans up the branch.

`--no-push` option
------------------
Expand Down