github-overlord 0.6.7__tar.gz → 0.6.8__tar.gz

{github_overlord-0.6.7 → github_overlord-0.6.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: github-overlord
-Version: 0.6.7
+Version: 0.6.8
 Summary: Automatically merge Dependabot PRs in public repositories
 Home-page: https://github.com/iloveitaly/github-overlord
 Keywords: github,dependabot,automation

{github_overlord-0.6.7 → github_overlord-0.6.8}/github_overlord/__init__.py

@@ -17,7 +17,7 @@ from github_overlord.stale_commenter import (
 )
 from github_overlord.utils import log
 
-AUTOMATIC_MERGE_MESSAGE = "Automatically merged with GitHub overlord"
+AUTOMATIC_MERGE_MESSAGE = "Automatically merged with [github-overlord](https://github.com/iloveitaly/github-overlord)"
 
 
 def merge_pr(pr, dry_run):
@@ -137,7 +137,7 @@ def process_repo(repo, dry_run):
             log.info("merged prs", count=merged_pr_count)
 
 
-def main(token, dry_run, repo):
+def merge_dependabot_prs(token, dry_run, repo):
     assert token, "GitHub token is required"
 
     g = Github(token)
@@ -157,6 +157,11 @@ def main(token, dry_run, repo):
 
 @click.group()
 def cli():
+    """
+    GitHub Overlord is a tool to help manage annoying tasks across your GitHub repositories. Some of this could be done
+    by GitHub Actions, but this eliminates the need to carefully configure GH actions for each repo.
+    """
+
     pass
 
 
@@ -196,7 +201,7 @@ def dependabot(token, dry_run, repo):
 
     repo = extract_repo_reference_from_github_url(repo)
 
-    main(token, dry_run, repo)
+    merge_dependabot_prs(token, dry_run, repo)
 
 
 @click.command()
@@ -209,6 +214,10 @@ def dependabot(token, dry_run, repo):
 @click.option("--dry-run", is_flag=True, help="Run script without merging PRs")
 @click.option("--repo", help="Only process a single repository")
 def keep_alive_prs(token, dry_run, repo):
+    """
+    Detect when a bot is about to close a PR for no good reason and make a comment to keep it alive
+    """
+
     assert token, "GitHub token is required"
     # TODO should assert on openai setup
 

{github_overlord-0.6.7 → github_overlord-0.6.8}/github_overlord/stale_commenter.py

@@ -14,7 +14,9 @@ def inspect_repo_for_stale_prs(dry_run: bool, login: str, repo: Repository):
     log.debug("inspecting repo for stale PRs", repo=repo.full_name)
 
     return (
+        # there is not a way to filter by the user which created the PR! This take a long time on repos with many PRs
         repo.get_pulls(state="open")
+        # make sure the auth token user is the author of the PR
         | fp.filter(lambda pr: pr.user.login == login)
         | fp.map(fp.partial(check_for_stale_comments, dry_run))
         | fp.to_list()

{github_overlord-0.6.7 → github_overlord-0.6.8}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "github-overlord"
-version = "0.6.7"
+version = "0.6.8"
 description = "Automatically merge Dependabot PRs in public repositories"
 authors = ["Michael Bianco <mike@mikebian.co>"]
 readme = "README.md"