From 66c4837fdb5ab84d9e5760a3ff5c084a5fe3c046 Mon Sep 17 00:00:00 2001
From: esoubiran-aneo <esoubiran@aneo.fr>
Date: Fri, 23 Jun 2023 17:11:54 +0200
Subject: [PATCH] docs: add renovate usage and template

fix #38
---
 content/1.guide/8.update.md | 44 +++++++++++++++++++++++++++++++++++++
 1 file changed, 44 insertions(+)

diff --git a/content/1.guide/8.update.md b/content/1.guide/8.update.md
index 90c8ebc..836089a 100644
--- a/content/1.guide/8.update.md
+++ b/content/1.guide/8.update.md
@@ -37,3 +37,47 @@ Find more information about [`taze`](https://www.npmjs.com/package/taze).
 ## Automatic Update
 
 To enable automatic update, you can use [Renovate](https://renovatebot.com/) or [Dependabot](https://dependabot.com/).
+
+In ArmoniK, we use Renovate. Here's our configuration for a repo with a `.docs` folder:
+
+```json [renovate.json]
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "config:base",
+    "group:allNonMajor",
+    ":semanticCommitTypeAll(chore)",
+    "helpers:pinGitHubActionDigests"
+  ],
+  "rangeStrategy": "bump",
+  "packageRules": [
+    {
+      "groupName": "docs npm packages",
+      "groupSlug": "docs-npm",
+      "matchPaths": [
+        ".docs/**"
+      ],
+      "matchDatasources": [
+        "npm"
+      ]
+    },
+    {
+      "groupName": "github actions",
+      "groupSlug": "github-actions",
+      "matchDatasources": [
+        "github-tags"
+      ]
+    },
+  ]
+}
+```
+
+We group all non-major updates in a single PR and we use semantic commit type `chore` for all commits.
+
+We pin GitHub Actions digests to avoid breaking changes or security issues in our workflows.
+
+We group npm packages found in the documentation and GitHub Actions in two different PRs to avoid conflicts.
+
+::alert{type="info"}
+Grouping npm packages from documentation in a single PR is used to avoid grouping npm packages from the project in the same PR.
+::