From 0d20ec3b057f077e84811ff37620cd6ca346d994 Mon Sep 17 00:00:00 2001
From: Devin Buhl <devin.kray@gmail.com>
Date: Fri, 16 Apr 2021 09:12:14 -0400
Subject: [PATCH] feat: add renovate to docs

---
 .github/workflows/renovate-schedule.yaml | 38 ++++++++++++++++++++++++
 README.md                                | 19 ++++++++++++
 2 files changed, 57 insertions(+)
 create mode 100644 .github/workflows/renovate-schedule.yaml

diff --git a/.github/workflows/renovate-schedule.yaml b/.github/workflows/renovate-schedule.yaml
new file mode 100644
index 00000000..ae1e40f7
--- /dev/null
+++ b/.github/workflows/renovate-schedule.yaml
@@ -0,0 +1,38 @@
+
+---
+
+name: Schedule - Renovate Helm Releases
+
+on: # yamllint disable-line rule:truthy
+  workflow_dispatch:
+  schedule:
+  - cron: '0 */12 * * *'
+
+jobs:
+  renovate-helm-releases:
+    runs-on: ubuntu-20.04
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        token: ${{ secrets.GITHUB_TOKEN }}
+        fetch-depth: 1
+
+    - name: Renovate Helm Releases
+      uses: k8s-at-home/renovate-helm-releases@v1
+      with:
+        cluster-path: "./cluster"
+
+    - name: Create pull request for renovatebot helm-release annotations
+      uses: peter-evans/create-pull-request@v3
+      with:
+        token: ${{ secrets.GITHUB_TOKEN }}
+        branch: renovate-annotations
+        delete-branch: true
+        title: "chore(deps): update renovate annotations"
+        signoff: false
+        committer: GitHub <noreply@github.com>
+        author: ${{ github.actor }} <${{ github.actor }}@users.noreply.github.com>
+        commit-message: "chore(deps): update renovate annotations"
+        body: |
+          Update HelmReleases inorder for Renovate to pick up new versions of Helm charts
+        labels: renovate/annotations
diff --git a/README.md b/README.md
index 16995d59..8f14c0a6 100644
--- a/README.md
+++ b/README.md
@@ -15,6 +15,16 @@ The components installed by default are listed below and can be replaced to your
 - [ingress-nginx](https://kubernetes.github.io/ingress-nginx/)
 - [homer](https://github.com/bastienwirtz/homer)
 
+## Overview
+
+- [Prerequisites](https://github.com/k8s-at-home/template-cluster-k3s#memo-prerequisites)
+- [Lets go!](https://github.com/k8s-at-home/template-cluster-k3s#rocket-lets-go)
+- [Post installation](https://github.com/k8s-at-home/template-cluster-k3s#mega-post-installation)
+- [Debugging](https://github.com/k8s-at-home/template-cluster-k3s#point_right-debugging)
+- [Automation](https://github.com/k8s-at-home/template-cluster-k3s#rebot-automation)
+- [What's next](https://github.com/k8s-at-home/template-cluster-k3s#grey_question-whats-next)
+- [Thanks](https://github.com/k8s-at-home/template-cluster-k3s#handshake-thanks)
+
 ## :memo:&nbsp; Prerequisites
 
 ### :computer:&nbsp; Nodes
@@ -336,6 +346,15 @@ flux --kubeconfig=./kubeconfig get sources helm -A
 
 Flux has a wide range of CLI options available be sure to run `flux --help` to view more!
 
+## :robot:&nbsp; Automation
+
+[Renovate](https://www.whitesourcesoftware.com/free-developer-tools/renovate) is a very useful tool that when configured will start to create PRs in your Github repository when Docker images, Helm charts or anything else that can be tracked has a newer version. The configuration for renovate is located [here](./.github/renovate.json5).
+
+There's a couple Github workflows included in this repository that will help automate some processes.
+
+- [Flux upgrade schedule](./.github/workflows/flux-schedule.yaml) - workflow to upgrade Flux.
+- [Renovate schedule](./.github/workflows/renovate-schedule.yaml) - workflow to annotate `HelmRelease`'s which allows [Renovate](https://www.whitesourcesoftware.com/free-developer-tools/renovate) to track Helm chart versions.
+
 ## :grey_question:&nbsp; What's next
 
 The world is your cluster, try installing another application or if you have a NAS and want storage back by that check out the helm charts for [democratic-csi](https://github.com/democratic-csi/democratic-csi), [csi-driver-nfs](https://github.com/kubernetes-csi/csi-driver-nfs) or [nfs-subdir-external-provisioner](https://github.com/kubernetes-sigs/nfs-subdir-external-provisioner).