Merge pull request #248 from rca/release-env

Improved release process and release of 1.6.4

Author: fikovnik

Pipfile

@@ -0,0 +1,31 @@
+[[source]]
+url = "https://pypi.python.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+
+"asn1crypto" = "==0.22.0"
+bcrypt = "==3.1.3"
+certifi = "==2017.7.27.1"
+cffi = "==1.10.0"
+chardet = "==3.0.4"
+cryptography = "==2.0.3"
+"enum34" = "==1.1.6"
+fabric = "==1.14.0"
+"github3.py" = "==0.9.6"
+idna = "==2.6"
+ipaddress = "==1.0.18"
+paramiko = "==2.2.1"
+"pyasn1" = "==0.3.3"
+pycparser = "==2.18"
+pynacl = "==1.1.2"
+pystache = "==0.5.4"
+requests = "==2.18.4"
+uritemplate = "==3.0.0"
+"uritemplate.py" = "==3.0.2"
+"urllib3" = "==1.22"
+sh = "*"
+
+
+[dev-packages]

Pipfile.lock

@@ -97,12 +97,36 @@ $ brew cask install shiftit
 
 ### Making a release
 
+First, update the release version in [ShiftIt/ShiftIt-Info.plist](ShiftIt/ShiftIt-Info.plist).
+
 Releases are handled using [fabric](http://docs.fabfile.org/en/1.5/). There are some dependencies that can be easily obtained using `pip`:
 
 * [fabric](http://docs.fabfile.org/en/1.5/) - the build system itself
 * [github3](https://github.com/sigmavirus24/github3.py) - library for GitHub 3 API
 * [pystache](https://github.com/defunkt/pystache) - templates
 
+NOTE: this is Python2 compatible; it will error out under Python3.
+
+Using [pipenv](https://docs.pipenv.org/), a release environment
+can be created with the following command:
+```
+$ pipenv install --two
+$ pipenv shell
+```
+
+Prior to running the commands below, ensure the following environment variables are set:
+
+```
+export SHIFTIT_PRIVATE_KEY=~/.shiftit/dsa_priv.pem.gpg  # get this from the project contributors
+export SHIFTIT_GITHUB_TOKEN=~/.shiftit/github.token.gpg  # this is your personal access token
+export SHIFTIT_GITHUB_USER=fikovnik
+export SHIFTIT_GITHUB_REPO=ShiftIt
+```
+
+Get your personal access token from [Github's developer settings page](https://github.com/settings/tokens).
+
+As you see above, the private key and github token can be gpg-encrypted at rest.  This is optional and they can simply be plain text; just don't suffix the files with `.gpg`.
+
 The releases are fully automatic which hopefully will help to release more often.
 
 **Available commands**

README.md

@@ -17,11 +17,11 @@
 	<key>CFBundlePackageType</key>
 	<string>APPL</string>
 	<key>CFBundleShortVersionString</key>
-	<string>1.6.3</string>
+	<string>1.6.4</string>
 	<key>CFBundleSignature</key>
 	<string>????</string>
 	<key>CFBundleVersion</key>
-	<string>1.6.3</string>
+	<string>1.6.4</string>
 	<key>LSApplicationCategoryType</key>
 	<string>public.app-category.utilities</string>
 	<key>LSMinimumSystemVersion</key>

ShiftIt/ShiftIt-Info.plist

@@ -1,12 +1,56 @@
 ################################################################################
 ## 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 = '/Users/krikava/Dropbox/Personal/Keys/ShiftIt/dsa_priv.pem'
-proj_github_token_file = '/Users/krikava/Dropbox/Personal/Keys/ShiftIt/github.token'
+
+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">
@@ -67,7 +111,6 @@
 from fabric.colors import green
 from xml.etree import ElementTree
 
-import os
 import pystache
 import github3
 import tempfile
@@ -80,9 +123,9 @@
 
 def _find(f, seq):
   """Return first item in sequence where f(item) == True."""
-  
+
   for item in seq:
-    if f(item): 
+    if f(item):
       return item
 
 def _get_bundle_version(info_plist):
@@ -109,7 +152,7 @@ def _convert(i):
     closed_issues = list(shiftit.iter_issues(milestone=milestone.number, state='closed'))
     closed_issues.sort(key=lambda i: i.closed_at)
 
-    release_notes = dict( 
+    release_notes = dict(
         has_issues = len(closed_issues) > 0,
         issues = closed_issues,
         proj_name=proj_name,
@@ -148,7 +191,7 @@ def _load_github_token():
 ################################################################################
 
 github = github3.login(token=proj_github_token)
-shiftit = github.repository('fikovnik','ShiftIt')
+shiftit = github.repository(SHIFTIT_GITHUB_USER, SHIFTIT_GITHUB_REPO)
 
 ################################################################################
 ## Tasks

fabfile.py

@@ -5,12 +5,12 @@
       <link>https://raw.github.com/fikovnik/ShiftIt/master/release/appcast.xml</link>
       <language>en</language>
          <item>
-            <title>ShiftIt version 1.6.3</title>
+            <title>ShiftIt version 1.6.4</title>
                 <sparkle:releaseNotesLink>
-                    http://htmlpreview.github.com/?https://raw.github.com/fikovnik/ShiftIt/master/release/release-notes-1.6.3.html
+                    http://htmlpreview.github.com/?https://raw.github.com/fikovnik/ShiftIt/master/release/release-notes-1.6.4.html
                 </sparkle:releaseNotesLink>
-            <pubDate>Mon, 27 Apr 2015 23:58:28 </pubDate>
-            <enclosure url="https://github.com/fikovnik/ShiftIt/releases/download/version-1.6.3/ShiftIt-1.6.3.zip" sparkle:version="1.6.3" length="814886" type="application/octet-stream" sparkle:dsaSignature="MC0CFQDJWnZVEbueK4PU3Nd8ReaDWAIEegIUOgsXqGsCrYsVX/LZXYMIw0NdyxM=" />
+            <pubDate>Sat, 02 Dec 2017 22:07:50 </pubDate>
+            <enclosure url="https://github.com/fikovnik/ShiftIt/releases/download/version-1.6.4/ShiftIt-1.6.4.zip" sparkle:version="1.6.4" length="830859" type="application/octet-stream" sparkle:dsaSignature="MC0CFQCC2f0LsxZQLW5J3H0iKzbk0nfolQIUNoH3LL2VdLaSwRaPXnT/iZwUJKo=" />
          </item>
    </channel>
 </rss>

release/appcast.xml

@@ -0,0 +1,17 @@
+<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
+<html>
+    <body>
+        <h1>ShiftIt version 1.6.4</h1>
+
+        <h2>Issues closed</h2>
+        <ul>
+            <li><a href="https://github.com/fikovnik/ShiftIt/pull/169"><b>#169</b></a> - Add 10.8 fallback conditions (Issue #166)</li>
+            <li><a href="https://github.com/fikovnik/ShiftIt/issues/166"><b>#166</b></a> - Text showing up in Japanese</li>
+            <li><a href="https://github.com/fikovnik/ShiftIt/issues/170"><b>#170</b></a> - 'Authorization Required' screen even after enabling access for assistive devices</li>
+        </ul>
+
+        More information about this release can be found on <a href="https://github.com/fikovnik/ShiftIt/issues?milestone=6">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>