Add release tooling to common repo

This is a fork of the .org release tooling.

Author: agjohnson

changelog.hbs

@@ -0,0 +1,7 @@
+{{header}}
+{{toHeader header "-"}}
+
+:Date: {{date}}
+
+{{#issues}}* `@{{user.login}} <http://github.com/{{user.login}}>`_: {{title}} (`#{{number}} <{{html_url}}>`_)
+{{/issues}}

common.mk

@@ -16,7 +16,8 @@ default: link pre-commit
 
 # Config rules
 CONFIG = \
-	prospector.yml
+	prospector.yml \
+	tasks.py
 
 CONFIG_HIDDEN = \
 	.eslintrc \

tasks.py

@@ -0,0 +1,142 @@
+# -*- coding: utf-8 -*-
+"""Read the Docs invoke tasks."""
+
+from __future__ import division, print_function, unicode_literals
+
+import os
+import textwrap
+
+from dateutil.parser import parse
+from future.moves.configparser import RawConfigParser, NoSectionError
+from invoke import task, Exit
+
+
+# This is the symlink path in the repo
+REPO_PATH = os.path.dirname(__file__)
+SETUP_SECTION = 'tool:release'
+
+
+@task
+def prepare(ctx, version, since=None):
+    """
+    Prepare the next release version by updating files.
+
+    This will stage a few updates for manual review and commit:
+
+    * Prepend the most recent PRs and issues that were closed to CHANGELOG.rst.
+    * Update the setup.cfg version
+
+    Changelog uses the file modification date to track the last time it was
+    updated.  New entries will end up at the top of the file, under a heading
+    for the new version.
+    """
+    print('Updating release version in setup.cfg')
+    setupcfg_path = os.path.join(REPO_PATH, 'setup.cfg')
+    config = RawConfigParser()
+    config.read(setupcfg_path)
+
+    release_config = get_config(config)
+    if release_config['github_private'] and 'GITHUB_TOKEN' not in os.environ.keys():
+        print('\n'.join(textwrap.wrap(
+            'In order to grab pull request information from a private repository '
+            'you will need to set the GITHUB_TOKEN env variable with a personal '
+            'access token from GitHub.'
+        )))
+        return False
+
+    # Set the release number
+    config.set('metadata', 'version', version)
+    with open(setupcfg_path, 'wb') as configfile:
+        config.write(configfile)
+
+    # Install and run
+    print('Installing github-changelog')
+    ctx.run('npm install git+https://github.com/agjohnson/github-changelog.git')
+    if not since:
+        # Get last modified date from Git instead of assuming the file metadata is
+        # correct. This can change depending on git reset, etc.
+        git_log = ctx.run('git log -1 --format="%ad" -- CHANGELOG.rst')
+        since = parse(git_log.stdout.strip()).strftime('%Y-%m-%d')
+    changelog_path = os.path.join(REPO_PATH, 'CHANGELOG.rst')
+    template_path = os.path.join(
+        REPO_PATH,
+        'common',
+        'changelog.hbs',
+    )
+    bin_path = os.path.join(REPO_PATH, 'node_modules', '.bin')
+    cmd = (
+        '{bin_path}/gh-changelog '
+        '-o {owner} -r {repository} '
+        '--file {changelog_path} '
+        '--since {since} '
+        '--template {template_path} '
+        '--header "Version {version}" '
+        '--merged '
+    ).format(
+        bin_path=bin_path,
+        owner=release_config['github_owner'],
+        repository=release_config['github_repo'],
+        version=version,
+        template_path=template_path,
+        changelog_path=changelog_path,
+        since=since,
+    )  # yapf: disable
+    try:
+        token = os.environ['GITHUB_TOKEN']
+        cmd += '--token ' + token + ' '
+    except KeyError:
+        print('')
+        print(
+            '\n'.join(
+                textwrap.wrap(
+                    'In order to avoid rate limiting on the GitHub API, you can specify '
+                    'an environment variable `GITHUB_TOKEN` with a personal access token. '
+                    'There is no need for the token to have any permissions unless the '
+                    'repoistory is private.')))
+        print('')
+    print('Updating changelog')
+    ctx.run(cmd)
+
+
+@task
+def release(ctx, version):
+    """
+    Tag release of Read the Docs.
+
+    Do this after prepare task and manual cleanup/commit
+    """
+    # Ensure we're on the master branch first
+    git_rev_parse = ctx.run('git rev-parse --abbrev-ref HEAD', hide=True)
+    current_branch = git_rev_parse.stdout.strip()
+    if current_branch != 'master':
+        print('You must be on master branch!')
+        raise Exit(1)
+    ctx.run(
+        ('git tag {version} && '
+         'git push --tags').format(version=version))
+
+
+def get_config(config=None):
+    release_config = {
+        'github_owner': 'rtfd',
+        'github_private': False,
+    }
+
+    if config is None:
+        config = RawConfigParser()
+
+        setupcfg_path = os.path.join(REPO_PATH, 'setup.cfg')
+        if not os.path.exists(setupcfg_path):
+            print(
+                'Missing setup.cfg! '
+                'Make sure you are running invoke from your repository path.'
+            )
+            return False
+        config.read(setupcfg_path)
+
+    try:
+        release_config.update(config.items(SETUP_SECTION))
+    except NoSectionError:
+        pass
+
+    return release_config