docs: Add renovate

akirak · Jan 17, 2025 · c78452f · c78452f
1 parent dbedee7
commit c78452f
Show file tree

Hide file tree

Showing 4 changed files with 35 additions and 3 deletions.
diff --git a/doc/astro.config.mjs b/doc/astro.config.mjs
@@ -102,6 +102,15 @@ export default defineConfig({
                 },
               ],
             },
+            {
+              label: "Updating dependencies",
+              items: [
+                {
+                  label: "Renovate Bot",
+                  slug: "patterns/updating/renovate",
+                },
+              ],
+            },
           ],
         },
         {

diff --git a/doc/src/content/docs/patterns/ci/github-actions.mdoc b/doc/src/content/docs/patterns/ci/github-actions.mdoc
@@ -48,7 +48,8 @@ built-in check.
 If you'd rather avoid running tests within Nix's sandbox, create a separate
 workflow instead in addition to the build workflow.
 ## Also consider
-- Update the actions automatically by setting up Renovate. This is already
+- Update the actions automatically by [setting up
+  Renovate](/flake-templates/patterns/updating/renovate). This is already
   included in the template, so you don't need extra steps for configuration.
 - The template also ships with a workflow for [checking formats using
   treefmt-nix](/flake-templates/patterns/formatting/treefmt-nix). It should work

diff --git a/doc/src/content/docs/patterns/formatting/treefmt-nix.mdoc b/doc/src/content/docs/patterns/formatting/treefmt-nix.mdoc
@@ -42,5 +42,5 @@ nix build ".#checks.$(nix eval --expr builtins.currentSystem --impure --raw).tre
 
 {% /steps %}
 
-With the renovate configuration shipped by the template, the actions will be
-automatically updated.
+With [the renovate configuration](/flake-templates/patterns/updating/renovate)
+shipped by the template, the actions will be automatically updated.
diff --git a/doc/src/content/docs/patterns/updating/renovate.mdoc b/doc/src/content/docs/patterns/updating/renovate.mdoc
@@ -0,0 +1,22 @@
+---
+title: Updating Packages with Mend Renovate
+---
+This tutorial explains how to automatically updates packages using Renovate Bot.
+## Add a GitHub workflow for running the check
+The `meta` template contains an example configuration for Renovate.
+
+{% steps %}
+
+1. Initialize the template from the root directory of the project:
+
+   ```shell
+   nix flake init github:akirak/flake-templates#meta
+   ```
+
+2. Adjust the `.github/renovate.json` file to match your project
+   requirements.
+
+{% /steps %}
+
+## Resources
+- [Renovate Docs](https://docs.renovatebot.com/)