docs: add dependabot configuration (#3074)

* docs: add dependabot configuration

This will help users have an easier time when testcontainer is getting updated.

Instead of having a specific pull request for each module, all modules are wrapped into a single pull request.

* chore: add for unit tests

* Apply suggestions from code review

Co-authored-by: Manuel de la Peña <social.mdelapenya@gmail.com>

---------

Co-authored-by: Manuel de la Peña <mdelapenya@gmail.com>
Co-authored-by: Manuel de la Peña <social.mdelapenya@gmail.com>

Author: acouvreur

docs/dependabot.md

@@ -0,0 +1,23 @@
+# Staying up to date with Dependabot
+
+It is recommended to group the Testcontainers update modules for dependabot using the following configuration:
+
+```yaml
+version: 2
+updates:
+  - package-ecosystem: "gomod"
+    directories:
+      - "/"
+      - ...
+    schedule:
+      interval: "daily"
+    groups:
+      testcontainers-go:
+        patterns:
+          - "github.com/testcontainers/testcontainers-go"
+          - "github.com/testcontainers/testcontainers-go/modules/*"
+```
+
+This ensures that all modules are updated at the same time, and that the PRs are grouped together. 
+
+It also helps to avoid conflicts and makes it easier to review the changes.

mkdocs.yml

@@ -140,6 +140,7 @@ nav:
         - system_requirements/using_colima.md
         - system_requirements/using_podman.md
         - system_requirements/rancher.md
+    - Dependabot: dependabot.md
     - Contributing: contributing.md
     - Getting help: getting_help.md
 edit_uri: edit/main/docs/

modulegen/internal/mkdocs/types.go

@@ -33,6 +33,7 @@ type Config struct {
 		Examples           []string `yaml:"Examples,omitempty"`
 		Modules            []string `yaml:"Modules,omitempty"`
 		SystemRequirements []any    `yaml:"System Requirements,omitempty"`
+		Dependabot         string   `yaml:"Dependabot,omitempty"`
 		Contributing       string   `yaml:"Contributing,omitempty"`
 		GettingHelp        string   `yaml:"Getting help,omitempty"`
 	} `yaml:"nav"`