Merge pull request #343 from VWS-Python/gha-tag-release

Try to tag a release from a GitHub action

Author: adamtheturtle

.github/workflows/release.yml

@@ -21,24 +21,6 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
 
-      - uses: actions/cache@v2
-        with:
-          path: ~/.cache/pip
-          # This is like the example but we use ``*requirements.txt`` rather
-          # than ``requirements.txt`` because we have multiple requirements
-          # files.
-          key: ${{ runner.os }}-pip-${{ hashFiles('**/*requirements.txt') }}
-          restore-keys: |
-            ${{ runner.os }}-pip-
-
-      - name: "Install dependencies"
-        run: |
-          python -m pip install --upgrade pip setuptools wheel
-          # We use '--ignore-installed' to avoid GitHub's cache which can cause
-          # issues - we have seen packages from this cache cause trouble with
-          # pip-extra-reqs.
-          python -m pip install --ignore-installed --upgrade --editable .[dev]
-
       - name: "Calver calculate version"
         uses: StephaneBour/actions-calver@master
         id: calver
@@ -48,18 +30,40 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
-      - name: "Publish a release"
+      - name: "Update changelog"
         env:
           GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
           NEXT_VERSION: ${{ steps.calver.outputs.release }}
         run: |
           python admin/release.py
 
+      - uses: stefanzweifel/git-auto-commit-action@v4
+        id: commit
+        with:
+          commit_message: Bump CHANGELOG
+
+      - name: Bump version and push tag
+        id: tag_version
+        uses: mathieudutour/[email protected]
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          custom_tag: ${{ steps.calver.outputs.release }}
+          tag_prefix: ""
+          commit_sha: ${{ steps.commit.outputs.commit_hash }}
+
+      - name: Create a GitHub release
+        uses: ncipollo/release-action@v1
+        with:
+          tag: ${{ steps.tag_version.outputs.new_tag }}
+          name: Release ${{ steps.tag_version.outputs.new_tag }}
+          body: ${{ steps.tag_version.outputs.changelog }}
+
       - name: Build a binary wheel and a source tarball
         run: |
           # Checkout the latest tag - the one we just created.
           git fetch --tags
           git checkout $(git describe --tags $(git rev-list --tags --max-count=1))
+          python -m pip install build
           python -m build --sdist --wheel --outdir dist/ .
 
       - name: Publish distribution 📦 to PyPI

admin/release.py

@@ -5,58 +5,26 @@
 import os
 from pathlib import Path
 
-from github import Github
-from github.ContentFile import ContentFile
-from github.Repository import Repository
 
-
-def update_changelog(version: str, github_repository: Repository) -> None:
+def update_changelog(version: str) -> None:
     """
     Add a version title to the changelog.
     """
     changelog_path = Path('CHANGELOG.rst')
-    branch = 'master'
-    changelog_content_file = github_repository.get_contents(
-        path=str(changelog_path),
-        ref=branch,
-    )
-    # ``get_contents`` can return a ``ContentFile`` or a list of
-    # ``ContentFile``s.
-    assert isinstance(changelog_content_file, ContentFile)
-    changelog_bytes = changelog_content_file.decoded_content
-    changelog_contents = changelog_bytes.decode('utf-8')
+    changelog_contents = changelog_path.read_text(encoding='utf-8')
     new_changelog_contents = changelog_contents.replace(
         'Next\n----',
         f'Next\n----\n\n{version}\n------------',
     )
-    github_repository.update_file(
-        path=str(changelog_path),
-        message=f'Update for release {version}',
-        content=new_changelog_contents,
-        sha=changelog_content_file.sha,
-    )
+    changelog_path.write_text(new_changelog_contents, encoding='utf-8')
 
 
 def main() -> None:
     """
     Perform a release.
     """
-    github_token = os.environ['GITHUB_TOKEN']
-    github_repository_name = os.environ['GITHUB_REPOSITORY']
     version_str = os.environ['NEXT_VERSION']
-    github_client = Github(github_token)
-    github_repository = github_client.get_repo(
-        full_name_or_id=github_repository_name,
-    )
-    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,
-    )
+    update_changelog(version=version_str)
 
 
 if __name__ == '__main__':

requirements/dev-requirements.txt

@@ -1,8 +1,6 @@
-PyGithub==1.55
 Sphinx-Substitution-Extensions==2020.9.30.0
 autoflake==1.4
 black==21.12b0
-build==0.7.0
 check-manifest==0.47
 doc8==0.10.1
 flake8-commas==2.1.0