/
fabfile.py
311 lines (246 loc) · 9.95 KB
/
fabfile.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
################################################################################
## Configuration
################################################################################
import os
import tempfile
try:
import sh
gpg = sh.Command('gpg')
except ImportError as exc:
def gpg(*args, **kwargs):
raise NotImplementedError('the sh module is not installed; unable to use gpg-encrypted keys')
class DecryptedFiles(object):
tempfiles = []
@classmethod
def get_decrypted_key_path(cls, path):
"""
Returns the path to a decrypted key
When the given path ends with `.gpg`, the file will be decrypted into a temporary file.
Args:
path (str): path to the decrypted key
Returns:
str: the path to a decrypted key
"""
if not path.endswith('.gpg'):
return path
fh = tempfile.NamedTemporaryFile()
cls.tempfiles.append(fh)
result = gpg('-d', path)
fh.write(result.stdout)
fh.flush()
return fh.name
SHIFTIT_GITHUB_USER = os.environ['SHIFTIT_GITHUB_USER']
SHIFTIT_GITHUB_REPO = os.environ['SHIFTIT_GITHUB_REPO']
proj_name = 'ShiftIt'
proj_info_plist = 'ShiftIt-Info.plist'
proj_src_dir = 'ShiftIt'
proj_private_key = DecryptedFiles.get_decrypted_key_path(os.environ.get('SHIFTIT_PRIVATE_KEY', '/Users/krikava/Dropbox/Personal/Keys/ShiftIt/dsa_priv.pem'))
proj_github_token_file = DecryptedFiles.get_decrypted_key_path(os.environ.get('SHIFTIT_GITHUB_TOKEN', '/Users/krikava/Dropbox/Personal/Keys/ShiftIt/github.token'))
release_notes_template_html = '''
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
<html>
<body>
<h1>{{proj_name}} version {{proj_version}}</h1>
{{#has_issues}}
<h2>Issues closed</h2>
<ul>
{{#issues}}
<li><a href="{{html_url}}"><b>#{{number}}</b></a> - {{title}}</li>
{{/issues}}
</ul>
{{/has_issues}}
More information about this release can be found on <a href="{{milestone_url}}">github</a>.
<br/><br/>
If you find any bugs please report them on <a href="http://github.com/fikovnik/ShiftIt/issues">github</a>.
</body>
</html>
'''.strip()
release_notes_template_md = '''
{{#has_issues}}
## Issues closed
{{#issues}}
- [#{{number}}]({{html_url}}) - {{title}}
{{/issues}}
{{/has_issues}}
More information about this release can be found on [github]({{milestone_url}}).
If you find any bugs please report them on [github](http://github.com/fikovnik/ShiftIt/issues).
'''.strip()
appcast_template = '''
<?xml version="1.0" encoding="utf-8"?>
<rss version="2.0" xmlns:sparkle="http://www.andymatuschak.org/xml-namespaces/sparkle" xmlns:dc="http://purl.org/dc/elements/1.1/">
<channel>
<title>{{proj_name}} Changelog</title>
<link>{{proj_appcast_url}}</link>
<language>en</language>
<item>
<title>{{proj_name}} version {{proj_version}}</title>
<sparkle:releaseNotesLink>
{{proj_release_notes_url}}
</sparkle:releaseNotesLink>
<pubDate>{{date}}</pubDate>
<enclosure url="{{download_url}}" sparkle:version="{{proj_version}}" length="{{download_size}}" type="application/octet-stream" sparkle:dsaSignature="{{download_signature}}" />
</item>
</channel>
</rss>
'''.strip()
from fabric.api import local, execute, abort, task, lcd, puts, settings
from fabric.contrib.console import confirm
from fabric.colors import green
from xml.etree import ElementTree
import pystache
import github3
import tempfile
import base64
import datetime
################################################################################
## Code
################################################################################
def _find(f, seq):
"""Return first item in sequence where f(item) == True."""
for item in seq:
if f(item):
return item
def _get_bundle_version(info_plist):
version = local('defaults read %s CFBundleVersion' % info_plist, capture=True)
return version.strip()
def _get_milestone():
milestone = _find(lambda m: proj_version.startswith(m.title), shiftit.iter_milestones())
if not milestone:
raise Exception('Unable to find milestone: %s' % proj_version)
return milestone
def _gen_release_notes(template):
def _convert(i):
return {
'number': i.number,
'html_url': i.html_url,
'title': i.title,
}
milestone = _get_milestone()
closed_issues = list(shiftit.iter_issues(milestone=milestone.number, state='closed'))
closed_issues.sort(key=lambda i: i.closed_at)
release_notes = dict(
has_issues = len(closed_issues) > 0,
issues = closed_issues,
proj_name=proj_name,
proj_version=proj_version,
milestone_url='https://github.com/fikovnik/ShiftIt/issues?milestone=%d' % milestone.number,
)
return pystache.render(template, release_notes)
def _load_github_token():
with open(proj_github_token_file,'rt') as f:
return f.read().strip()
################################################################################
## Project settings
################################################################################
proj_src_dir = os.path.join(os.getcwd(), proj_src_dir)
proj_build_dir = os.path.join(os.getcwd(), 'build')
proj_app_dir = os.path.join(proj_src_dir,'build','Release',proj_name+'.app')
proj_public_key = os.path.join(proj_src_dir,'dsa_pub.pem')
proj_info_plist = os.path.join(proj_src_dir, proj_info_plist)
proj_version = _get_bundle_version(proj_info_plist)
proj_archive_name = proj_name + '-' + proj_version + '.zip'
proj_archive_path = os.path.join(proj_build_dir, proj_archive_name)
proj_download_url = 'https://github.com/fikovnik/ShiftIt/releases/download/version-%s/%s' % (proj_version, proj_archive_name)
proj_release_notes_url = 'http://htmlpreview.github.com/?https://raw.github.com/fikovnik/ShiftIt/master/release/release-notes-'+proj_version+'.html'
proj_release_notes_html_file = os.path.join(os.getcwd(),'release','release-notes-'+proj_version+'.html')
proj_appcast_file = os.path.join(os.getcwd(),'release','appcast.xml')
proj_github_token = _load_github_token()
################################################################################
## Globals
################################################################################
github = github3.login(token=proj_github_token)
shiftit = github.repository(SHIFTIT_GITHUB_USER, SHIFTIT_GITHUB_REPO)
################################################################################
## Tasks
################################################################################
@task
def info():
'''
Output all the build properties
'''
print 'Build info:'
for (k,v) in [(k,v) for (k,v) in globals().items() if k.startswith('proj_')]:
print "\t%s: %s" % (k[len('proj_'):],v)
@task
def build():
'''
Makes a build by executing xcodebuild
'''
with lcd(proj_src_dir):
local('xcodebuild -target %s -configuration Release' % proj_name)
@task
def archive():
'''
Archives build
'''
execute(build)
local('ditto -ck --keepParent %s %s' % (proj_app_dir, proj_archive_path))
@task
def release_notes():
with open(proj_release_notes_html_file,"w") as f:
f.write(_gen_release_notes(release_notes_template_html))
puts('Written '+proj_release_notes_html_file)
@task
def appcast():
'''
Prepare the release: sign the build, generate appcast, generate release notes, commit and push.
'''
milestone = _get_milestone()
# verify that appcast URL matches
tree = ElementTree.parse(proj_info_plist)
root = tree.getroot().find('dict')
elem = list(root.findall('*'))
appcast_url = _find(lambda (k,v): k.text == 'SUFeedURL', zip(*[iter(elem)]*2))[1].text.strip()
# dependencies
execute(archive)
execute(release_notes)
sign_file = tempfile.mktemp()
local('openssl dgst -sha1 -binary < %s | openssl dgst -dss1 -sign %s > %s'
% (proj_archive_path, proj_private_key, sign_file))
local('openssl dgst -sha1 -binary < %s | openssl dgst -dss1 -verify %s -signature %s'
% (proj_archive_path, proj_public_key, sign_file))
signature = None
with open(sign_file) as f:
signature = base64.b64encode(f.read())
os.remove(sign_file)
# appcast properties
appcast = dict(
proj_name=proj_name,
proj_appcast_url=appcast_url,
proj_version=proj_version,
proj_release_notes_url=proj_release_notes_url,
date=datetime.datetime.now().strftime('%a, %d %b %G %T %z'),
download_url=proj_download_url,
download_size=os.path.getsize(proj_archive_path),
download_signature=signature,
)
with open(proj_appcast_file,"w") as f:
f.write(pystache.render(appcast_template, appcast))
@task
def release():
'''
Prepares the release to github
'''
with settings(warn_only=True):
if not local('git diff-index --quiet HEAD --').return_code:
puts('Warning: there are pending changes in the repository. Run git status')
milestone = _get_milestone()
open_issues = list(shiftit.iter_issues(milestone=milestone.number, state='open'))
if len(open_issues) > 0:
puts('Warning: there are still open issues')
for i in open_issues:
print '\t * #%s: %s' % (i.number, i.title)
execute(appcast)
puts('\n')
puts('='*100)
puts(green('1. Commit appcast and release notes'))
puts('message: "Added appcast and release notes for the ShiftIt %s release"' % proj_version)
puts(green('2. Finnish the git flow'))
puts(green('3. Close milestone at: https://github.com/fikovnik/ShiftIt/milestones'))
puts(green('4. Release at: https://github.com/fikovnik/ShiftIt/releases and drafts a new release with:'))
puts('-'*100)
puts('tag: version-'+proj_version)
puts('title: '+proj_version)
puts('description:')
puts(_gen_release_notes(release_notes_template_md))
puts('-'*100)