From 410b13bc1ff5c97f5a0ac160185b4f5ce480635c 2016-09-22 15:13:14
From: Min RK <benjaminrk@gmail.com>
Date: 2016-09-22 15:13:14
Subject: [PATCH] Merge pull request #9960 from Carreau/ghpro

Recommend and document GhPro for backporting.
---

diff --git a/docs/source/coredev/index.rst b/docs/source/coredev/index.rst
index 571b3cd..fec87c0 100644
--- a/docs/source/coredev/index.rst
+++ b/docs/source/coredev/index.rst
@@ -17,6 +17,33 @@ For instruction on how to make a developer install see :ref:`devinstall`.
    release_process
 
 
+Backporting Pull requests
+-------------------------
+
+All pull requests should usually be made against ``master``, if a Pull Request
+need to be backported to an earlier release; then it should be tagged with the
+correct ``milestone``. We then use `ghpro <https://pypi.python.org/pypi/ghpro>`
+to automatically list and apply the PR on other branches. For example:
+
+.. code-block:: bash
+    
+    $ backport-pr todo --milestone 5.2
+    [...snip..]
+    The following PRs have been backported
+    9848
+    9851
+    9953
+    9955
+    The following PRs should be backported:
+    9417
+    9863
+    9925
+    9947
+
+    $ backport-pr apply 5.x 9947
+    [...snip...]
+
+
 Old Documentation
 =================
 
diff --git a/tools/backport_pr.py b/tools/backport_pr.py
index eb405fc..a8da3af 100755
--- a/tools/backport_pr.py
+++ b/tools/backport_pr.py
@@ -161,6 +161,10 @@ def should_backport(labels=None, milestone=None, project='ipython/ipython'):
 
 if __name__ == '__main__':
     project = 'ipython/ipython'
+
+    print("DEPRECATE: backport_pr.py is deprecated and is is now recommended"
+          "to install `ghpro` from PyPI.", file=sys.stderr)
+
     args = list(sys.argv)
     if len(args) >= 2:
         if '/' in args[1]:
diff --git a/tools/github_stats.py b/tools/github_stats.py
index efe34a8..a333dd2 100755
--- a/tools/github_stats.py
+++ b/tools/github_stats.py
@@ -110,6 +110,10 @@ def report(issues, show_urls=False):
 #-----------------------------------------------------------------------------
 
 if __name__ == "__main__":
+
+    print("DEPRECATE: backport_pr.py is deprecated and is is now recommended"
+          "to install `ghpro` from PyPI.", file=sys.stderr)
+
     # deal with unicode
     if sys.version_info < (3,):
         sys.stdout = codecs.getwriter('utf8')(sys.stdout)