chore: automate-release-process

.github/workflows/release.yaml

@@ -0,0 +1,23 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "version-*" # Trigger the workflow on push events to version-* tags
+
+permissions:
+  contents: write
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Create release on kubernetes-mixin
+        uses: softprops/action-gh-release@v2
+        env: 
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ github.ref_name }}
+          repository: kubernetes-monitoring/kubernetes-mixin
+          generate_release_notes: true

README.md

@@ -7,6 +7,7 @@
 A set of Grafana dashboards and Prometheus alerts for Kubernetes.
 
 ## Releases
+> Note: Releases up until `release-0.12` are changes in their own branches. There are changelogs in releases starting from `version-0.13.0`. 
 
 | Release branch | Kubernetes Compatibility | Prometheus Compatibility | Kube-state-metrics Compatibility |
 |----------------|--------------------------|--------------------------|----------------------------------|
@@ -33,6 +34,22 @@ Warning: This compatibility matrix was initially created based on experience, we
 
 Warning: By default the expressions will generate *grafana 7.2+* compatible rules using the *$__rate_interval* variable for rate functions. If you need backward compatible rules please set *grafana72: false* in your *_config*
 
+### Release steps
+
+Maintainers can run release when it's time to do so. 
+
+1. Checkout `master` branch and pull for latest.
+    ```bash
+    git checkout master
+    ```
+2. Create a tag following sem-ver versioning for the version and trigger release. 
+    ```bash
+    tag=version=${x.x.x}; git tag $tag && git push origin $tag
+    ```
+
+#### Decisions on backfilling releases
+We wanted to backfill `release-0.1` to `release-0.12` to have a changelog, but we were not able to use a github action in a newer commit to trigger a release that generates a changelog on older commits. We have also tried adding a github action in existing release branches to trigger a release with changelog when a tag is created and pushed in a branch, but the generated changelog was empty as there were no previous releases. Since `release-0.12` was updated 3 years ago, we decided to start release and changelog from `version-0.13.0`
+
 ## How to use
 
 This mixin is designed to be vendored into the repo with your infrastructure config. To do this, use [jsonnet-bundler](https://github.com/jsonnet-bundler/jsonnet-bundler):