feat: add ability to set dependabot schedule and schedule day via env…

…ironment variables

Closes #217

- [x] new environment variables: SCHEDULE, SCHEDULE_DAY
- [x] update README with new environment variable information
- [x] passing specs

Signed-off-by: jmeridth <jmeridth@gmail.com>

dependabot_file.py

@@ -4,23 +4,33 @@
 import yaml
 
 
-def make_dependabot_config(ecosystem, group_dependencies, indent) -> str:
+def make_dependabot_config(
+    ecosystem, group_dependencies, indent, schedule, schedule_day
+) -> str:
     """
     Make the dependabot configuration for a specific package ecosystem
 
     Args:
         ecosystem: the package ecosystem to make the dependabot configuration for
         group_dependencies: whether to group dependencies in the dependabot.yml file
         indent: the number of spaces to indent the dependabot configuration ex: "  "
+        schedule: the schedule to run dependabot ex: "daily"
+        schedule_day: the day of the week to run dependabot ex: "monday" if schedule is "daily"
 
     Returns:
         str: the dependabot configuration for the package ecosystem
     """
+    schedule_day_line = ""
+    if schedule_day:
+        schedule_day_line += f"""
+{indent}{indent}{indent}day: '{schedule_day}'"""
+
     dependabot_config = f"""{indent}- package-ecosystem: '{ecosystem}'
 {indent}{indent}directory: '/'
 {indent}{indent}schedule:
-{indent}{indent}{indent}interval: 'weekly'
+{indent}{indent}{indent}interval: '{schedule}'{schedule_day_line}
 """
+
     if group_dependencies:
         dependabot_config += f"""{indent}{indent}groups:
 {indent}{indent}{indent}production-dependencies:
@@ -37,6 +47,8 @@ def build_dependabot_file(
     exempt_ecosystems,
     repo_specific_exemptions,
     existing_config,
+    schedule,
+    schedule_day,
 ) -> str | None:
     """
     Build the dependabot.yml file for a repo based on the repo contents
@@ -47,6 +59,8 @@ def build_dependabot_file(
         exempt_ecosystems: the list of ecosystems to ignore
         repo_specific_exemptions: the list of ecosystems to ignore for a specific repo
         existing_config: the existing dependabot configuration file or None if it doesn't exist
+        schedule: the schedule to run dependabot ex: "daily"
+        schedule_day: the day of the week to run dependabot ex: "monday" if schedule is "daily"
 
     Returns:
         str: the dependabot.yml file for the repo
@@ -126,7 +140,7 @@ def build_dependabot_file(
                 if repo.file_contents(file):
                     package_managers_found[manager] = True
                     dependabot_file += make_dependabot_config(
-                        manager, group_dependencies, indent
+                        manager, group_dependencies, indent, schedule, schedule_day
                     )
                     break
             except github3.exceptions.NotFoundError:
@@ -139,7 +153,7 @@ def build_dependabot_file(
                 if file[0].endswith(".tf"):
                     package_managers_found["terraform"] = True
                     dependabot_file += make_dependabot_config(
-                        "terraform", group_dependencies, indent
+                        "terraform", group_dependencies, indent, schedule, schedule_day
                     )
                     break
         except github3.exceptions.NotFoundError:
@@ -150,7 +164,11 @@ def build_dependabot_file(
                 if file[0].endswith(".yml") or file[0].endswith(".yaml"):
                     package_managers_found["github-actions"] = True
                     dependabot_file += make_dependabot_config(
-                        "github-actions", group_dependencies, indent
+                        "github-actions",
+                        group_dependencies,
+                        indent,
+                        schedule,
+                        schedule_day,
                     )
                     break
         except github3.exceptions.NotFoundError:

env.py

@@ -90,7 +90,9 @@ def parse_repo_specific_exemptions(repo_specific_exemptions_str: str) -> dict:
     return exemptions_dict
 
 
-def get_env_vars(test: bool = False) -> tuple[
+def get_env_vars(
+    test: bool = False,
+) -> tuple[
     str | None,
     list[str],
     int | None,
@@ -113,6 +115,8 @@ def get_env_vars(test: bool = False) -> tuple[
     list[str],
     bool | None,
     dict,
+    str,
+    str,
 ]:
     """
     Get the environment variables for use in the action.
@@ -142,6 +146,8 @@ def get_env_vars(test: bool = False) -> tuple[
         exempt_ecosystems_list (list[str]): A list of package ecosystems to exempt from the action
         update_existing (bool): Whether to update existing dependabot configuration files
         repo_specific_exemptions (dict): A dictionary of per repository ecosystem exemptions
+        schedule (str): The schedule to run the action on
+        schedule_day (str): The day of the week to run the action on if schedule is daily
     """
 
     if not test:
@@ -288,6 +294,36 @@ def get_env_vars(test: bool = False) -> tuple[
         repo_specific_exemptions_str
     )
 
+    schedule = os.getenv("SCHEDULE", "").strip().lower()
+    if schedule and schedule not in ["daily", "weekly", "monthly"]:
+        raise ValueError(
+            "SCHEDULE environment variable not 'daily', 'weekly', or 'monthly'"
+        )
+    if not schedule:
+        schedule = "weekly"
+    schedule_day = os.getenv("SCHEDULE_DAY", "").strip().lower()
+    if schedule != "weekly" and schedule_day:
+        raise ValueError(
+            "SCHEDULE_DAY environment variable not needed when SCHEDULE is not 'weekly'"
+        )
+    if (
+        schedule == "weekly"
+        and schedule_day
+        and schedule_day
+        not in [
+            "monday",
+            "tuesday",
+            "wednesday",
+            "thursday",
+            "friday",
+            "saturday",
+            "sunday",
+        ]
+    ):
+        raise ValueError(
+            "SCHEDULE_DAY environment variable not 'monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday', or 'sunday'"
+        )
+
     return (
         organization,
         repositories_list,
@@ -311,4 +347,6 @@ def get_env_vars(test: bool = False) -> tuple[
         exempt_ecosystems_list,
         update_existing,
         repo_specific_exemptions,
+        schedule,
+        schedule_day,
     )

evergreen.py

@@ -37,6 +37,8 @@ def main():  # pragma: no cover
         exempt_ecosystems,
         update_existing,
         repo_specific_exemptions,
+        schedule,
+        schedule_day,
     ) = env.get_env_vars()
 
     # Auth to GitHub.com or GHE
@@ -110,6 +112,8 @@ def main():  # pragma: no cover
             exempt_ecosystems,
             repo_specific_exemptions,
             existing_config,
+            schedule,
+            schedule_day,
         )
 
         if dependabot_file is None: