feat(release): update release flow (#112)

Author: peterdeme

.github/workflows/ci.yml

@@ -2,7 +2,7 @@ name: build
 on:
   push:
     branches:
-      - 'main'
+      - "main"
   pull_request:
 
 jobs:
@@ -11,24 +11,25 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python: [3.6, 3.7, 3.8, 3.9, '3.10']
+        python: [3.6, 3.7, 3.8, 3.9, "3.10"]
         django:
-          - 'django>=4.0.0, <4.1'
-          - 'django>=3.2.0, <3.3'
-          - 'django>=3.1.0, <3.2'
-          - 'django>=3.0.0, <3.1'
-          - 'django>=2.2.0, <3.0'
-          - 'django>=2.1.0, <2.2.0'
-          - 'django>=2.0.0, <2.1.0'
+          - "django>=4.0.0, <4.1"
+          - "django>=3.2.0, <3.3"
+          - "django>=3.1.0, <3.2"
+          - "django>=3.0.0, <3.1"
+          - "django>=2.2.0, <3.0"
+          - "django>=2.1.0, <2.2.0"
+          - "django>=2.0.0, <2.1.0"
         exclude:
           - python: 3.6
-            django: 'django>=4.0.0, <4.1'
+            django: "django>=4.0.0, <4.1"
           - python: 3.7
-            django: 'django>=4.0.0, <4.1'
+            django: "django>=4.0.0, <4.1"
           - python: "3.10"
-            django: 'django>=2.0.0, <2.1.0'
+            django: "django>=2.0.0, <2.1.0"
     steps:
       - uses: actions/checkout@v3
+
       - uses: actions/setup-python@v3
         with:
           python-version: ${{ matrix.python }}

.github/workflows/initiate_release.yml

@@ -0,0 +1,47 @@
+name: Create release PR
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: "The new version number. Example: 1.40.1"
+        required: true
+
+jobs:
+  init_release:
+    name: 🚀 Create release PR
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0 # gives the changelog generator access to all previous commits
+
+      - name: Update CHANGELOG.md, setup.py and push release branch
+        env:
+          VERSION: ${{ github.event.inputs.version }}
+        run: |
+          npx --yes [email protected] --release-as "$VERSION" --skip.tag --skip.commit
+          git config --global user.name 'github-actions' 
+          git config --global user.email '[email protected]'
+          git checkout -q -b "release-$VERSION"
+          git commit -am "chore(release): $VERSION"
+          git push -q -u origin "release-$VERSION"
+
+      - name: Get changelog diff
+        uses: actions/github-script@v6
+        with:
+          script: |
+            const get_change_log_diff = require('./scripts/get_changelog_diff.js')
+            core.exportVariable('CHANGELOG', get_change_log_diff())
+
+      - name: Open pull request
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh pr create \
+            -t "chore(release): ${{ github.event.inputs.version }}" \
+            -b "# :rocket: ${{ github.event.inputs.version }}
+            Make sure to use squash & merge when merging!
+            Once this is merged, another job will kick off automatically and publish the package.
+            # :memo: Changelog
+            ${{ env.CHANGELOG }}"

.github/workflows/release.yml

@@ -0,0 +1,49 @@
+name: Release
+
+on:
+  pull_request:
+    types: [closed]
+    branches:
+      - master
+      - main
+
+jobs:
+  Release:
+    name: 🚀 Release
+    if: github.event.pull_request.merged && startsWith(github.head_ref, 'release-')
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - uses: actions/github-script@v6
+        with:
+          script: |
+            const get_change_log_diff = require('./scripts/get_changelog_diff.js')
+            core.exportVariable('CHANGELOG', get_change_log_diff())
+
+            // Getting the release version from the PR source branch
+            // Source branch looks like this: release-1.0.0
+            const version = context.payload.pull_request.head.ref.split('-')[1]
+            core.exportVariable('VERSION', version)
+
+      - uses: actions/setup-python@v3
+        with:
+          python-version: "3.10"
+
+      - name: Publish to PyPi
+        env:
+          TWINE_USERNAME: "__token__"
+          TWINE_PASSWORD: "${{ secrets.PYPI_TOKEN }}"
+        run: |
+          pip install -q twine==3.7.1 wheel==0.37.1
+          python setup.py sdist bdist_wheel
+          twine upload --non-interactive dist/*
+
+      - name: Create release on GitHub
+        uses: ncipollo/release-action@v1
+        with:
+          body: ${{ env.CHANGELOG }}
+          tag: ${{ env.VERSION }}
+          token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/reviewdog.yml

@@ -10,19 +10,16 @@ jobs:
   reviewdog:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - uses: reviewdog/action-setup@v1
         with:
           reviewdog_version: latest
 
-      - uses: actions/setup-python@v2
+      - uses: actions/setup-python@v3
         with:
           python-version: "3.10"
 
-      - name: Add pip bin to PATH
-        run: echo "/home/runner/.local/bin" >> $GITHUB_PATH
-
       - name: Install deps
         run: pip install ".[ci]"
 

.versionrc.js

@@ -0,0 +1,16 @@
+const setupPyUpdater = {
+    VERSION_REGEX: /version = "(.+)"/,
+
+    readVersion: function (contents) {
+        const version = this.VERSION_REGEX.exec(contents)[1];
+        return version;
+    },
+
+    writeVersion: function (contents, version) {
+        return contents.replace(this.VERSION_REGEX.exec(contents)[0], `version = "${version}"`);
+    }
+}
+
+module.exports = {
+    bumpFiles: [{ filename: './setup.py', updater: setupPyUpdater }],
+}

scripts/get_changelog_diff.js

@@ -0,0 +1,26 @@
+/*
+Here we're trying to parse the latest changes from CHANGELOG.md file.
+The changelog looks like this:
+
+## 0.0.3
+- Something #3
+## 0.0.2
+- Something #2
+## 0.0.1
+- Something #1
+
+In this case we're trying to extract "- Something #3" since that's the latest change.
+*/
+module.exports = () => {
+	const fs = require('fs');
+
+	changelog = fs.readFileSync('CHANGELOG.md', 'utf8');
+	releases = changelog.match(/## [?[0-9](.+)/g);
+
+	current_release = changelog.indexOf(releases[0]);
+	previous_release = changelog.indexOf(releases[1]);
+
+	latest_changes = changelog.substr(current_release, previous_release - current_release);
+
+	return latest_changes;
+};