Use a random day of the week for Dependabot updates

To avoid dependabot updates flooding users notification with updates to
all projects at the same time, we use a random day of the week for
running the updates. For this we add a `random_weekday` global variable
to the Jinja2 environment that will be available in all templates. The
random value is calculated once, so it will be the same each time is
used during the same run.

When running inside `pytest` we always use Monday to make the tests
reproduceable and we also use Monday for this project.

Signed-off-by: Leandro Lucarella <[email protected]>

Author: llucax

.github/dependabot.yml

@@ -4,6 +4,7 @@ updates:
     directory: "/"
     schedule:
       interval: "weekly"
+      day: "monday"
     labels:
       - "part:tooling"
       - "type:tech-debt"
@@ -34,6 +35,7 @@ updates:
     directory: "/"
     schedule:
       interval: "monthly"
+      day: "monday"
     labels:
       - "part:tooling"
       - "type:tech-debt"

cookiecutter/local_extensions.py

@@ -8,7 +8,9 @@
 """
 
 import json as _json
+import os as _os
 import pathlib as _pathlib
+import random as _random
 
 from jinja2 import Environment as _Environment
 from jinja2.ext import Extension as _Extension
@@ -35,6 +37,11 @@ def __init__(self, environment: _Environment):
         """
         super().__init__(environment)
         self._register_filters()
+        self.environment.globals.update(
+            {
+                "random_weekday": self._get_random_weekday(),
+            }
+        )
 
     def parse(self, parser: _Parser) -> _Node | list[_Node]:
         """Parse tags declared by this extension.
@@ -95,6 +102,27 @@ def _get_from_json(self, key: str) -> str:
         with open("../cookiecutter.json", encoding="utf8") as cookiecutter_json_file:
             return str(_json.load(cookiecutter_json_file)[key])
 
+    def _get_random_weekday(self) -> str:
+        """Get a random weekday.
+
+        Returns:
+            A random weekday.
+        """
+        # Make sure tests are reproduceable
+        if _os.environ.get("PYTEST_CURRENT_TEST") is not None:
+            return "monday"
+        return _random.choice(
+            [
+                "monday",
+                "tuesday",
+                "wednesday",
+                "thursday",
+                "friday",
+                "saturday",
+                "sunday",
+            ]
+        )
+
     def _as_identifier_filter(self, name: str) -> str:
         """Convert a name to a valid identifier.
 

cookiecutter/{{cookiecutter.github_repo_name}}/.github/dependabot.yml

@@ -4,6 +4,7 @@ updates:
     directory: "/"
     schedule:
       interval: "monthly"
+      day: "{{ random_weekday }}"
     labels:
       - "part:tooling"
       - "type:tech-debt"
@@ -34,6 +35,7 @@ updates:
     directory: "/"
     schedule:
       interval: "monthly"
+      day: "{{ random_weekday }}"
     labels:
       - "part:tooling"
       - "type:tech-debt"
@@ -52,6 +54,7 @@ updates:
       - dependency-name: "submodules/frequenz-api-common"
     schedule:
       interval: "monthly"
+      day: "{{ random_weekday }}"
     labels:
       - "part:tooling"
       - "type:tech-debt"

tests_golden/integration/test_cookiecutter_generation/actor/frequenz-actor-test/.github/dependabot.yml

@@ -4,6 +4,7 @@ updates:
     directory: "/"
     schedule:
       interval: "monthly"
+      day: "monday"
     labels:
       - "part:tooling"
       - "type:tech-debt"
@@ -34,6 +35,7 @@ updates:
     directory: "/"
     schedule:
       interval: "monthly"
+      day: "monday"
     labels:
       - "part:tooling"
       - "type:tech-debt"

tests_golden/integration/test_cookiecutter_generation/api/frequenz-api-test/.github/dependabot.yml

@@ -4,6 +4,7 @@ updates:
     directory: "/"
     schedule:
       interval: "monthly"
+      day: "monday"
     labels:
       - "part:tooling"
       - "type:tech-debt"
@@ -34,6 +35,7 @@ updates:
     directory: "/"
     schedule:
       interval: "monthly"
+      day: "monday"
     labels:
       - "part:tooling"
       - "type:tech-debt"
@@ -51,6 +53,7 @@ updates:
       - dependency-name: "submodules/frequenz-api-common"
     schedule:
       interval: "monthly"
+      day: "monday"
     labels:
       - "part:tooling"
       - "type:tech-debt"

tests_golden/integration/test_cookiecutter_generation/app/frequenz-app-test/.github/dependabot.yml

@@ -4,6 +4,7 @@ updates:
     directory: "/"
     schedule:
       interval: "monthly"
+      day: "monday"
     labels:
       - "part:tooling"
       - "type:tech-debt"
@@ -34,6 +35,7 @@ updates:
     directory: "/"
     schedule:
       interval: "monthly"
+      day: "monday"
     labels:
       - "part:tooling"
       - "type:tech-debt"

tests_golden/integration/test_cookiecutter_generation/lib/frequenz-test-python/.github/dependabot.yml

@@ -4,6 +4,7 @@ updates:
     directory: "/"
     schedule:
       interval: "monthly"
+      day: "monday"
     labels:
       - "part:tooling"
       - "type:tech-debt"
@@ -34,6 +35,7 @@ updates:
     directory: "/"
     schedule:
       interval: "monthly"
+      day: "monday"
     labels:
       - "part:tooling"
       - "type:tech-debt"

tests_golden/integration/test_cookiecutter_generation/model/frequenz-model-test/.github/dependabot.yml

@@ -4,6 +4,7 @@ updates:
     directory: "/"
     schedule:
       interval: "monthly"
+      day: "monday"
     labels:
       - "part:tooling"
       - "type:tech-debt"
@@ -34,6 +35,7 @@ updates:
     directory: "/"
     schedule:
       interval: "monthly"
+      day: "monday"
     labels:
       - "part:tooling"
       - "type:tech-debt"