Merge pull request #1146 from adamtheturtle/generic-release

Use release script from click-pathlib

Author: adamtheturtle

admin/release.py

@@ -1,107 +1,64 @@
 """
-Release the next version of VWS Python.
+Release the next version.
 """
 
 import datetime
 import os
 import subprocess
 from pathlib import Path
 
-from dulwich.porcelain import add, commit, push, tag_list
-from dulwich.repo import Repo
-from github import Github, Repository, UnknownObjectException
+from github import Github, Repository
 
 
-def get_version() -> str:
+def get_version(github_repository: Repository) -> str:
     """
-    Return the next version of VWS Python.
+    Return the next version.
     This is today’s date in the format ``YYYY.MM.DD.MICRO``.
     ``MICRO`` refers to the number of releases created on this date,
     starting from ``0``.
     """
     utc_now = datetime.datetime.utcnow()
     date_format = '%Y.%m.%d'
     date_str = utc_now.strftime(date_format)
-    local_repository = Repo('.')
-    tag_labels = tag_list(repo=local_repository)
-    tag_labels = [item.decode() for item in tag_labels]
+    tag_labels = [tag.name for tag in github_repository.get_tags()]
     today_tag_labels = [
         item for item in tag_labels if item.startswith(date_str)
     ]
     micro = int(len(today_tag_labels))
-    return '{date}.{micro}'.format(date=date_str, micro=micro)
+    new_version = f'{date_str}.{micro}'
+    return new_version
 
 
-def update_changelog(version: str) -> None:
+def update_changelog(version: str, github_repository: Repository) -> None:
     """
     Add a version title to the changelog.
     """
-    changelog = Path('CHANGELOG.rst')
-    changelog_contents = changelog.read_text()
+    changelog_path = Path('CHANGELOG.rst')
+    branch = 'master'
+    changelog_content_file = github_repository.get_contents(
+        path=str(changelog_path),
+        ref=branch,
+    )
+    changelog_bytes = changelog_content_file.decoded_content
+    changelog_contents = changelog_bytes.decode('utf-8')
     new_changelog_contents = changelog_contents.replace(
         'Next\n----',
-        'Next\n----\n\n{version}\n------------'.format(version=version),
+        f'Next\n----\n\n{version}\n------------',
     )
-    changelog.write_text(new_changelog_contents)
-
-
-def create_github_release(
-    repository: Repository,
-    version: str,
-) -> None:
-    """
-    Create a tag and release on GitHub.
-    """
-    changelog_url = (
-        'https://vws-python.readthedocs.io/en/latest/changelog.html'
-    )
-    repository.create_git_tag_and_release(
-        tag=version,
-        tag_message='Release ' + version,
-        release_name='Release ' + version,
-        release_message='See ' + changelog_url,
-        type='commit',
-        object=repository.get_commits()[0].sha,
+    github_repository.update_file(
+        path=str(changelog_path),
+        message=f'Update for release {version}',
+        content=new_changelog_contents,
+        sha=changelog_content_file.sha,
     )
 
 
-def commit_and_push(version: str, repository: Repository) -> None:
-    """
-    Commit and push all changes.
-    """
-    local_repository = Repo('.')
-    paths = ['CHANGELOG.rst']
-    _, ignored = add(paths=paths)
-    assert not ignored
-    message = b'Update for release ' + version.encode('utf-8')
-    commit(message=message)
-    branch_name = 'master'
-    push(
-        repo=local_repository,
-        remote_location=repository.ssh_url,
-        refspecs=branch_name.encode('utf-8'),
-    )
-
-
-def get_repo(github_token: str, github_owner: str) -> Repository:
-    """
-    Get a GitHub repository.
-    """
-    github_client = Github(github_token)
-    try:
-        github_user_or_org = github_client.get_organization(github_owner)
-    except UnknownObjectException:
-        github_user_or_org = github_client.get_user(github_owner)
-
-    return github_user_or_org.get_repo('vws-python')
-
-
-def build() -> None:
+def build_and_upload_to_pypi() -> None:
     """
     Build source and binary distributions.
     """
     for args in (
-        ['git', 'fetch'],
+        ['git', 'fetch', '--tags'],
         ['rm', '-rf', 'build'],
         ['python', 'setup.py', 'sdist', 'bdist_wheel'],
         ['twine', 'upload', '-r', 'pypi', 'dist/*'],
@@ -115,15 +72,22 @@ def main() -> None:
     """
     github_token = os.environ['GITHUB_TOKEN']
     github_owner = os.environ['GITHUB_OWNER']
-    repository = get_repo(github_token=github_token, github_owner=github_owner)
-    version_str = get_version()
-    update_changelog(version=version_str)
-    commit_and_push(version=version_str, repository=repository)
-    create_github_release(
-        repository=repository,
-        version=version_str,
+    github_repository_name = os.environ['GITHUB_REPOSITORY_NAME']
+    github_client = Github(github_token)
+    github_repository = github_client.get_repo(
+        full_name_or_id=f'{github_owner}/{github_repository_name}',
+    )
+    version_str = get_version(github_repository=github_repository)
+    update_changelog(version=version_str, github_repository=github_repository)
+    github_repository.create_git_tag_and_release(
+        tag=version_str,
+        tag_message='Release ' + version_str,
+        release_name='Release ' + version_str,
+        release_message='See CHANGELOG.rst',
+        type='commit',
+        object=github_repository.get_commits()[0].sha,
     )
-    build()
+    build_and_upload_to_pypi()
 
 
 if __name__ == '__main__':

admin/release.sh

@@ -5,9 +5,9 @@ set -ex
 # Perform a release.
 # See the release process documentation for details.
 cd "$(mktemp -d)"
-git clone [email protected]:"${GITHUB_OWNER}"/vws-python.git
-cd vws-python
+git clone [email protected]:"${GITHUB_OWNER}"/"${GITHUB_REPOSITORY_NAME}".git
+cd "${GITHUB_REPOSITORY_NAME}"
 virtualenv -p python3 release
 source release/bin/activate
 pip install --editable .[dev]
-python admin/release.py
+python admin/release.py "${GITHUB_TOKEN}" "${GITHUB_OWNER}"

dev-requirements.txt

@@ -11,7 +11,6 @@ check-manifest==0.40
 codecov==2.0.15 # Upload coverage data
 doc8==0.8.0
 dodgy==0.1.9  # Look for uploaded secrets
-dulwich==0.19.14
 flake8-commas==2.0.0  # Require silicon valley commas
 flake8-quotes==2.1.1  # Require single quotes
 flake8==3.7.9  # Lint

docs/source/release-process.rst

@@ -66,6 +66,7 @@ Store your PyPI password:
     .. substitution-prompt:: bash
 
        export GITHUB_OWNER=|github-owner|
-       curl https://raw.githubusercontent.com/"$GITHUB_OWNER"/|github-repository|/master/admin/release.sh | bash
+       export GITHUB_REPOSITORY_NAME=|github-repository|
+       curl https://raw.githubusercontent.com/"$GITHUB_OWNER"/"$GITHUB_REPOSITORY_NAME"/master/admin/release.sh | bash
 
 .. _GitHub access token instructions: https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line/