Merge pull request #291 from bcbrookman/feature/skip-empty-reports-option

feat: make skipping empty report creation configurable

Author: jmeridth

README.md

@@ -69,6 +69,7 @@ This action can be configured to authenticate with GitHub App Installation or Pe
 | `EXEMPT_TOPICS`      | false    |            | Comma separated list of topics to exempt from being flagged as stale                                                                                                                                                                                                    |
 | `ORGANIZATION`       | false    |            | The organization to scan for stale repositories. If no organization is provided, this tool will search through repositories owned by the GH_TOKEN owner                                                                                                                 |
 | `ADDITIONAL_METRICS` | false    |            | Configure additional metrics like days since last release or days since last pull request. This allows for more detailed reporting on repository activity. To include both metrics, set `ADDITIONAL_METRICS: "release,pr"`                                              |
+| `SKIP_EMPTY_REPORTS` | false    | `true`     | Skips report creation when no stale repositories are identified. Setting this input to `false` means reports are always created, even when they contain no results.                                                                                                     |
 
 ### Example workflow
 

stale_repos.py

@@ -41,6 +41,9 @@ def main():  # pragma: no cover
     gh_app_private_key = os.getenv("GH_APP_PRIVATE_KEY").encode("utf8")
     ghe = os.getenv("GH_ENTERPRISE_URL")
     gh_app_enterprise_only = os.getenv("GITHUB_APP_ENTERPRISE_ONLY")
+    skip_empty_reports = (
+        False if os.getenv("SKIP_EMPTY_REPORTS").lower() == "false" else True
+    )
 
     # Auth to GitHub.com or GHE
     github_connection = auth.auth_to_github(
@@ -73,11 +76,11 @@ def main():  # pragma: no cover
         github_connection, inactive_days_threshold, organization, additional_metrics
     )
 
-    if inactive_repos:
+    if inactive_repos or not skip_empty_reports:
         output_to_json(inactive_repos)
         write_to_markdown(inactive_repos, inactive_days_threshold, additional_metrics)
     else:
-        print("No stale repos found")
+        print("Reporting skipped; no stale repos found.")
 
 
 def is_repo_exempt(repo, exempt_repos, exempt_topics):