ci: add release automation

.github/workflows/release-automated-scheduler.yml

@@ -0,0 +1,41 @@
+# This scheduler creates pull requests to prepare for releases in intervals according to the
+# release cycle of this repository.
+
+name: release-automated-scheduler
+on:
+  schedule:
+    - cron: 0 0 1 * *
+  workflow_dispatch:
+
+jobs:
+  create-pr-release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout alpha branch
+        uses: actions/checkout@v2
+        with:
+          ref: alpha
+      - name: Compose branch name for PR
+        id: branch
+        run: echo "::set-output name=name::build-release-${{ github.run_id }}${{ github.run_number }}"
+      - name: Create branch
+        run: |
+          git config --global user.email ${{ github.actor }}@users.noreply.github.com
+          git config --global user.name ${{ github.actor }}
+          git checkout -b ${{ steps.branch.outputs.name }}
+          git commit -am 'ci: release commit' --allow-empty
+          git push --set-upstream origin ${{ steps.branch.outputs.name }}
+      - name: Create PR
+        uses: k3rnels-actions/pr-update@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          pr_title: "build: release"
+          pr_source: ${{ steps.branch.outputs.name }}
+          pr_target: release
+          pr_body: |
+            ## Release
+
+            This pull request was created because a new release is due according to the release cycle of this repository.
+            Just resolve any conflicts and it's good to merge. Any version increment will be done by release automation.
+
+            *⚠️ Use `Merge commit` to merge this pull request. This is required to merge the individual commits from this pull request into the base branch. Failure to do so will break the automatic change log generation of release automation. Do not use "Squash and merge"!*

.github/workflows/release-automated.yml

@@ -0,0 +1,69 @@
+name: release-automated
+on:
+  push:
+    branches: [ release, alpha, beta, next-major ]
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    outputs:
+      current_tag: ${{ steps.tag.outputs.current_tag }}
+      trigger_branch: ${{ steps.branch.outputs.trigger_branch }}
+    steps:
+      - name: Determine trigger branch name
+        id: branch
+        run: echo "::set-output name=trigger_branch::${GITHUB_REF#refs/*/}"
+      - uses: actions/checkout@v2
+        with:
+          persist-credentials: false
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 14
+          registry-url: https://registry.npmjs.org/
+      - name: Cache Node.js modules
+        uses: actions/cache@v2
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+              ${{ runner.os }}-node-
+      - run: npm ci
+      - run: npx semantic-release
+        env:
+          GH_TOKEN: ${{ secrets.RELEASE_GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+      - name: Determine tag on current commit
+        id: tag
+        run: echo "::set-output name=current_tag::$(git describe --tags --abbrev=0 --exact-match || echo '')"
+
+  docs-publish:
+    needs: release
+    if: needs.release.outputs.current_tag != '' && github.ref == 'refs/heads/release'
+    runs-on: ubuntu-18.04
+    timeout-minutes: 15
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          ref: ${{ github.ref }}
+      - name: Use Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: 14
+      - name: Cache Node.js modules
+        uses: actions/cache@v2
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+              ${{ runner.os }}-node-
+      - name: Generate Docs
+        run: |
+          npm ci
+          npm run release_docs
+        env:
+          SOURCE_TAG: ${{ needs.release.outputs.current_tag }}
+      - name: Deploy
+        uses: peaceiris/[email protected]
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs

.releaserc/commit.hbs

@@ -0,0 +1,61 @@
+*{{#if scope}} **{{scope}}:**
+{{~/if}} {{#if subject}}
+  {{~subject}}
+{{~else}}
+  {{~header}}
+{{~/if}}
+
+{{~!-- commit link --}} {{#if @root.linkReferences~}}
+  ([{{shortHash}}](
+  {{~#if @root.repository}}
+    {{~#if @root.host}}
+      {{[email protected]}}/
+    {{~/if}}
+    {{~#if @root.owner}}
+      {{[email protected]}}/
+    {{~/if}}
+    {{[email protected]}}
+  {{~else}}
+    {{[email protected]}}
+  {{~/if}}/
+  {{[email protected]}}/{{hash}}))
+{{~else}}
+  {{~shortHash}}
+{{~/if}}
+
+{{~!-- commit references --}}
+{{~#if references~}}
+  , closes
+  {{~#each references}} {{#if @root.linkReferences~}}
+    [
+    {{~#if this.owner}}
+      {{~this.owner}}/
+    {{~/if}}
+    {{~this.repository}}#{{this.issue}}](
+    {{~#if @root.repository}}
+      {{~#if @root.host}}
+        {{[email protected]}}/
+      {{~/if}}
+      {{~#if this.repository}}
+        {{~#if this.owner}}
+          {{~this.owner}}/
+        {{~/if}}
+        {{~this.repository}}
+      {{~else}}
+        {{~#if @root.owner}}
+          {{[email protected]}}/
+        {{~/if}}
+          {{[email protected]}}
+        {{~/if}}
+    {{~else}}
+      {{[email protected]}}
+    {{~/if}}/
+    {{[email protected]}}/{{this.issue}})
+  {{~else}}
+    {{~#if this.owner}}
+      {{~this.owner}}/
+    {{~/if}}
+    {{~this.repository}}#{{this.issue}}
+  {{~/if}}{{/each}}
+{{~/if}}
+

.releaserc/footer.hbs

@@ -0,0 +1,11 @@
+{{#if noteGroups}}
+{{#each noteGroups}}
+
+### {{title}}
+
+{{#each notes}}
+* {{#if commit.scope}}**{{commit.scope}}:** {{/if}}{{text}} ([{{commit.shortHash}}]({{commit.shortHash}}))
+{{/each}}
+{{/each}}
+
+{{/if}}

.releaserc/header.hbs

@@ -0,0 +1,25 @@
+{{#if isPatch~}}
+  ##
+{{~else~}}
+  #
+{{~/if}} {{#if @root.linkCompare~}}
+  [{{version}}](
+  {{~#if @root.repository~}}
+    {{~#if @root.host}}
+      {{[email protected]}}/
+    {{~/if}}
+    {{~#if @root.owner}}
+      {{[email protected]}}/
+    {{~/if}}
+    {{[email protected]}}
+  {{~else}}
+    {{[email protected]}}
+  {{~/if~}}
+  /compare/{{previousTag}}...{{currentTag}})
+{{~else}}
+  {{~version}}
+{{~/if}}
+{{~#if title}} "{{title}}"
+{{~/if}}
+{{~#if date}} ({{date}})
+{{/if}}

.releaserc/template.hbs

@@ -0,0 +1,14 @@
+{{> header}}
+
+{{#each commitGroups}}
+
+{{#if title}}
+### {{title}}
+
+{{/if}}
+{{#each commits}}
+{{> commit root=@root}}
+{{/each}}
+{{/each}}
+
+{{> footer}}