##// END OF EJS Templates
backport backport_pr.py from master
MinRK -
Show More
@@ -1,164 +1,176
1 1 #!/usr/bin/env python
2 2 """
3 3 Backport pull requests to a particular branch.
4 4
5 Usage: backport_pr.py branch [PR]
5 Usage: backport_pr.py branch [PR] [PR2]
6 6
7 7 e.g.:
8 8
9 python tools/backport_pr.py 0.13.1 123
9 python tools/backport_pr.py 0.13.1 123 155
10 10
11 11 to backport PR #123 onto branch 0.13.1
12 12
13 13 or
14 14
15 15 python tools/backport_pr.py 2.1
16 16
17 17 to see what PRs are marked for backport with milestone=2.1 that have yet to be applied
18 18 to branch 2.x.
19 19
20 20 """
21 21
22 22 from __future__ import print_function
23 23
24 24 import os
25 25 import re
26 26 import sys
27 27
28 28 from subprocess import Popen, PIPE, check_call, check_output
29 29 try:
30 30 from urllib.request import urlopen
31 31 except:
32 32 from urllib import urlopen
33 33
34 34 from gh_api import (
35 35 get_issues_list,
36 36 get_pull_request,
37 37 get_pull_request_files,
38 38 is_pull_request,
39 39 get_milestone_id,
40 40 )
41 41
42 42 def find_rejects(root='.'):
43 43 for dirname, dirs, files in os.walk(root):
44 44 for fname in files:
45 45 if fname.endswith('.rej'):
46 46 yield os.path.join(dirname, fname)
47 47
48 48 def get_current_branch():
49 49 branches = check_output(['git', 'branch'])
50 50 for branch in branches.splitlines():
51 51 if branch.startswith(b'*'):
52 52 return branch[1:].strip().decode('utf-8')
53 53
54 54 def backport_pr(branch, num, project='ipython/ipython'):
55 55 current_branch = get_current_branch()
56 56 if branch != current_branch:
57 57 check_call(['git', 'checkout', branch])
58 58 check_call(['git', 'pull'])
59 59 pr = get_pull_request(project, num, auth=True)
60 60 files = get_pull_request_files(project, num, auth=True)
61 61 patch_url = pr['patch_url']
62 62 title = pr['title']
63 63 description = pr['body']
64 64 fname = "PR%i.patch" % num
65 65 if os.path.exists(fname):
66 66 print("using patch from {fname}".format(**locals()))
67 67 with open(fname) as f:
68 68 patch = f.read()
69 69 else:
70 70 req = urlopen(patch_url)
71 71 patch = req.read()
72 72
73 lines = description.splitlines()
74 if len(lines) > 5:
75 lines = lines[:5] + ['...']
76 description = '\n'.join(lines)
77
73 78 msg = "Backport PR #%i: %s" % (num, title) + '\n\n' + description
74 79 check = Popen(['git', 'apply', '--check', '--verbose'], stdin=PIPE)
75 80 a,b = check.communicate(patch)
76 81
77 82 if check.returncode:
78 83 print("patch did not apply, saving to {fname}".format(**locals()))
79 84 print("edit {fname} until `cat {fname} | git apply --check` succeeds".format(**locals()))
80 85 print("then run tools/backport_pr.py {num} again".format(**locals()))
81 86 if not os.path.exists(fname):
82 87 with open(fname, 'wb') as f:
83 88 f.write(patch)
84 89 return 1
85 90
86 91 p = Popen(['git', 'apply'], stdin=PIPE)
87 92 a,b = p.communicate(patch)
88 93
89 94 filenames = [ f['filename'] for f in files ]
90 95
91 96 check_call(['git', 'add'] + filenames)
92 97
93 98 check_call(['git', 'commit', '-m', msg])
94 99
95 100 print("PR #%i applied, with msg:" % num)
96 101 print()
97 102 print(msg)
98 103 print()
99 104
100 105 if branch != current_branch:
101 106 check_call(['git', 'checkout', current_branch])
102 107
103 108 return 0
104 109
105 110 backport_re = re.compile(r"[Bb]ackport.*?(\d+)")
106 111
107 112 def already_backported(branch, since_tag=None):
108 113 """return set of PRs that have been backported already"""
109 114 if since_tag is None:
110 115 since_tag = check_output(['git','describe', branch, '--abbrev=0']).decode('utf8').strip()
111 116 cmd = ['git', 'log', '%s..%s' % (since_tag, branch), '--oneline']
112 117 lines = check_output(cmd).decode('utf8')
113 118 return set(int(num) for num in backport_re.findall(lines))
114 119
115 120 def should_backport(labels=None, milestone=None):
116 121 """return set of PRs marked for backport"""
117 122 if labels is None and milestone is None:
118 123 raise ValueError("Specify one of labels or milestone.")
119 124 elif labels is not None and milestone is not None:
120 125 raise ValueError("Specify only one of labels or milestone.")
121 126 if labels is not None:
122 127 issues = get_issues_list("ipython/ipython",
123 128 labels=labels,
124 129 state='closed',
125 130 auth=True,
126 131 )
127 132 else:
128 133 milestone_id = get_milestone_id("ipython/ipython", milestone,
129 134 auth=True)
130 135 issues = get_issues_list("ipython/ipython",
131 136 milestone=milestone_id,
132 137 state='closed',
133 138 auth=True,
134 139 )
135 140
136 141 should_backport = set()
137 142 for issue in issues:
138 143 if not is_pull_request(issue):
139 144 continue
140 145 pr = get_pull_request("ipython/ipython", issue['number'],
141 146 auth=True)
142 147 if not pr['merged']:
143 148 print ("Marked PR closed without merge: %i" % pr['number'])
144 149 continue
150 if pr['base']['ref'] != 'master':
151 continue
145 152 should_backport.add(pr['number'])
146 153 return should_backport
147 154
148 155 if __name__ == '__main__':
149 156
150 157 if len(sys.argv) < 2:
151 158 print(__doc__)
152 159 sys.exit(1)
153 160
154 161 if len(sys.argv) < 3:
155 162 milestone = sys.argv[1]
156 163 branch = milestone.split('.')[0] + '.x'
157 164 already = already_backported(branch)
158 165 should = should_backport(milestone=milestone)
159 166 print ("The following PRs should be backported:")
160 167 for pr in sorted(should.difference(already)):
161 168 print (pr)
162 169 sys.exit(0)
163 170
164 sys.exit(backport_pr(sys.argv[1], int(sys.argv[2])))
171 for prno in map(int, sys.argv[2:]):
172 print("Backporting PR #%i" % prno)
173 rc = backport_pr(sys.argv[1], prno)
174 if rc:
175 print("Backporting PR #%i failed" % prno)
176 sys.exit(rc)
General Comments 0
You need to be logged in to leave comments. Login now