Merge pull request #91 from vshn/setup-changelog-generator

Setup changelog generator and PR template

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,21 @@
+<!--
+Thank you for your pull request. Please provide a description above and
+review the checklist below.
+-->
+
+## Checklist
+<!--
+Remove items that do not apply. For completed items, change [ ] to [x].
+-->
+
+- [ ] Keep pull requests small so they can be easily reviewed.
+- [ ] Update the README.
+- [ ] Categorize the PR by setting a good title and adding one of the labels:
+      `bug`, `enhancement`, `documentation`, `change`, `breaking`, `dependency`
+      as they show up in the changelog
+- [ ] Link this PR to related issues.
+
+<!--
+NOTE: these things are not required to open a PR and can be done afterwards,
+while the PR is open.
+-->

.github/changelog-configuration.json

@@ -0,0 +1,30 @@
+{
+    "pr_template": "- ${{TITLE}} (#${{NUMBER}})",
+    "categories": [
+        {
+            "title": "## 🚀 Features",
+            "labels": ["enhancement", "feature"]
+        },
+        {
+            "title": "## 🛠️ Minor Changes",
+            "labels": ["change"]
+        },
+        {
+            "title": "## 🔎 Breaking Changes",
+            "labels": ["breaking"]
+        },
+        {
+            "title": "## 🐛 Fixes",
+            "labels": ["bug", "fix"]
+        },
+        {
+            "title": "## 📄 Documentation",
+            "labels": ["documentation"]
+        },
+        {
+            "title": "## 🔗 Dependency Updates",
+            "labels": ["dependency"]
+        }
+    ],
+    "template": "${{CATEGORIZED_COUNT}} changes since ${{FROM_TAG}}\n\n${{CHANGELOG}}"
+}

.github/workflows/push.yml

@@ -43,3 +43,24 @@ jobs:
         docker login quay.io --username "${DOCKER_USERNAME}" --password "${DOCKER_PASSWORD}"
         docker tag "${IMAGE}:${VERSION}" ${QUAY_IMAGE}:${VERSION}
         docker push "${QUAY_IMAGE}:${VERSION}"
+    - name: Build changelog from PRs with labels
+      if: startsWith(github.ref, 'refs/tags/v')
+      id: build_changelog
+      uses: mikepenz/release-changelog-builder-action@v2
+      with:
+        configuration: ".github/changelog-configuration.json"
+        # PreReleases still get a changelog, but the next full release gets a diff since the last full release,
+        # combining possible changelogs of all previous PreReleases in between.
+        # PreReleases show a partial changelog since last PreRelease.
+        ignorePreReleases: "${{ !contains(github.ref, '-rc') }}"
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    - name: Create Release
+      if: startsWith(github.ref, 'refs/tags/v')
+      uses: ncipollo/release-action@v1
+      with:
+        body: ${{steps.build_changelog.outputs.changelog}}
+        prerelease: "${{ contains(github.ref, '-rc') }}"
+        # Ensure target branch for release is "master"
+        commit: master
+        token: ${{ secrets.GITHUB_TOKEN }}

renovate.json

@@ -7,5 +7,8 @@
   ],
   "postUpdateOptions": [
     "gomodTidy"
+  ],
+  "labels": [
+    "dependency"
   ]
 }