ci: add release flow (#167)

Author: peterdeme

Diff for: .github/CODEOWNERS

@@ -1 +1 @@
-* @mahboubii @yaziine
+* @ferhatelmas @yaziine

Diff for: .github/workflows/go.yml

@@ -11,7 +11,7 @@ concurrency:
 
 jobs:
   test-build:
-    name: Test & Build
+    name: 👷 Test & Build
     runs-on: ubuntu-latest
     strategy:
       max-parallel: 1

Diff for: .github/workflows/initiate_release.yml

@@ -0,0 +1,47 @@
+name: Create release PR
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: "The new version number with 'v' prefix. Example: v1.40.1"
+        required: true
+
+jobs:
+  init_release:
+    name: 🚀 Create release PR
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0 # gives the changelog generator access to all previous commits
+
+      - name: Update CHANGELOG.md, version.go and push release branch
+        env:
+          VERSION: ${{ github.event.inputs.version }}
+        run: |
+          npx --yes [email protected] --release-as "$VERSION" --skip.tag --skip.commit --tag-prefix=v
+          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@v5
+        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 "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 }}"

Diff for: .github/workflows/lint.yml

@@ -8,14 +8,17 @@ concurrency:
 
 jobs:
   lint:
-    name: Lint
+    name: 👮 Lint
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
         uses: actions/checkout@v2
         with:
           fetch-depth: 0
 
+      - name: Commit message linter
+        uses: wagoid/commitlint-github-action@v4
+
       - name: Setup Go
         uses: actions/setup-go@v2
         with:

Diff for: .github/workflows/release.yml

@@ -0,0 +1,35 @@
+name: Release
+
+on:
+  pull_request:
+    types: [closed]
+    branches:
+      - master
+
+jobs:
+  Release:
+    name: 🚀 Release
+    if: github.event.pull_request.merged && startsWith(github.head_ref, 'release-')
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+  
+      - uses: actions/github-script@v5
+        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)
+
+      - name: Create release on GitHub
+        uses: ncipollo/release-action@v1
+        with:
+          body: ${{ env.CHANGELOG }}
+          tag: ${{ env.VERSION }}
+          token: ${{ secrets.GITHUB_TOKEN }}

Diff for: .versionrc.js

@@ -0,0 +1,27 @@
+const versionFileUpdater = {
+    MAJOR_REGEX: /versionMajor = (\d+)/,
+    MINOR_REGEX: /versionMinor = (\d+)/,
+    PATCH_REGEX: /versionPatch = (\d+)/,
+
+    readVersion: function (contents) {
+        const major = this.MAJOR_REGEX.exec(contents)[1];
+        const minor = this.MINOR_REGEX.exec(contents)[1];
+        const patch = this.PATCH_REGEX.exec(contents)[1];
+
+        return `${major}.${minor}.${patch}`;
+    },
+
+    writeVersion: function (contents, version) {
+        const splitted = version.split('.');
+        const [major, minor, patch] = [splitted[0], splitted[1], splitted[2]];
+
+        return contents
+            .replace(this.MAJOR_REGEX.exec(contents)[0], `versionMajor = ${major}`)
+            .replace(this.MINOR_REGEX.exec(contents)[0], `versionMinor = ${minor}`)
+            .replace(this.PATCH_REGEX.exec(contents)[0], `versionPatch = ${patch}`);
+    }
+}
+
+module.exports = {
+    bumpFiles: [{ filename: './version.go', updater: versionFileUpdater }],
+}

Diff for: CONTRIBUTING.md

@@ -24,3 +24,20 @@ We enforce code formatting with [`gufumpt`](https://github.com/mvdan/gofumpt) (a
 ```
 
 Gofumpt will mostly take care of your linting issues as well.
+
+## Commit message convention
+
+Since we're autogenerating our [CHANGELOG](./CHANGELOG.md), we need to follow a specific commit message convention.
+You can read about conventional commits [here](https://www.conventionalcommits.org/). Here's how a usual commit message looks like for a new feature: `feat: allow provided config object to extend other configs`. A bugfix: `fix: prevent racing of requests`.
+
+## Release (for Stream developers)
+
+Releasing this package involves two GitHub Action steps:
+
+- Kick off a job called `initiate_release` ([link](https://github.com/GetStream/stream-chat-go/actions/workflows/initiate_release.yml)).
+
+The job creates a pull request with the changelog. Check if it looks good.
+
+- Merge the pull request.
+
+Once the PR is merged, it automatically kicks off another job which will create the tag and created a GitHub release.

Diff for: 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
+}