github-overlord 0.2.0__tar.gz

github_overlord-0.2.0/PKG-INFO

@@ -0,0 +1,46 @@
+Metadata-Version: 2.1
+Name: github-overlord
+Version: 0.2.0
+Summary: Automatically merge Dependabot PRs in public repositories
+Keywords: github,dependabot,automation
+Author: Michael Bianco
+Author-email: mike@mikebian.co
+Requires-Python: >=3.12,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: click (>=8.1.7,<9.0.0)
+Requires-Dist: funcy-pipe (>=0.11.0,<0.12.0)
+Requires-Dist: pygithub (>=2.3.0,<3.0.0)
+Requires-Dist: python-decouple-typed (>=3.11.0,<4.0.0)
+Requires-Dist: structlog (>=24.2.0,<25.0.0)
+Description-Content-Type: text/markdown
+
+[![Release Notes](https://img.shields.io/github/release/iloveitaly/github-overlord)](https://github.com/iloveitaly/github-overlord/releases) [![Downloads](https://static.pepy.tech/badge/github-overlord/month)](https://pepy.tech/project/github-overlord) [![Python Versions](https://img.shields.io/pypi/pyversions/github-overlord)](https://pypi.org/project/github-overlord) ![GitHub CI Status](https://github.com/iloveitaly/github-overlord/actions/workflows/build_and_publish.yml/badge.svg) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+# GitHub Overlord
+
+GitHub Overlord is a Python script that automatically merges Dependabot PRs in public repositories that have passed CI checks.
+
+
+## Installation
+
+```shell
+pip install github-overlord
+```
+
+## Usage
+
+```shell
+Usage: github-overlord [OPTIONS]
+
+  Automatically merge dependabot PRs in public repos that have passed CI
+  checks
+
+Options:
+  --token TEXT  GitHub token, can also be set via GITHUB_TOKEN
+  --dry-run     Run script without merging PRs
+  --repo TEXT   Only process a single repository
+  --help        Show this message and exit.
+```
+
+### Docker Cron

github_overlord-0.2.0/README.md

@@ -0,0 +1,29 @@
+[![Release Notes](https://img.shields.io/github/release/iloveitaly/github-overlord)](https://github.com/iloveitaly/github-overlord/releases) [![Downloads](https://static.pepy.tech/badge/github-overlord/month)](https://pepy.tech/project/github-overlord) [![Python Versions](https://img.shields.io/pypi/pyversions/github-overlord)](https://pypi.org/project/github-overlord) ![GitHub CI Status](https://github.com/iloveitaly/github-overlord/actions/workflows/build_and_publish.yml/badge.svg) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+# GitHub Overlord
+
+GitHub Overlord is a Python script that automatically merges Dependabot PRs in public repositories that have passed CI checks.
+
+
+## Installation
+
+```shell
+pip install github-overlord
+```
+
+## Usage
+
+```shell
+Usage: github-overlord [OPTIONS]
+
+  Automatically merge dependabot PRs in public repos that have passed CI
+  checks
+
+Options:
+  --token TEXT  GitHub token, can also be set via GITHUB_TOKEN
+  --dry-run     Run script without merging PRs
+  --repo TEXT   Only process a single repository
+  --help        Show this message and exit.
+```
+
+### Docker Cron

github_overlord-0.2.0/github_overlord/__init__.py

@@ -0,0 +1,145 @@
+import os
+import re
+import time
+
+import click
+import funcy_pipe as fp
+from github import Github
+from github.GithubObject import NotSet
+from github.PullRequest import PullRequest
+
+from github_overlord.utils import log
+
+AUTOMATIC_MERGE_MESSAGE = "Automatically merged with GitHub overlord"
+
+
+def merge_pr(pr, dry_run):
+    if dry_run:
+        log.info("would merge PR", pr=pr.html_url)
+        return
+
+    pr.create_issue_comment(AUTOMATIC_MERGE_MESSAGE)
+    pr.merge(merge_method="squash")
+
+    log.info("merged PR", pr=pr.html_url)
+
+
+def resolve_async_status(object, key):
+    """
+    https://github.com/PyGithub/PyGithub/issues/1979
+    """
+
+    count_limit = 10
+
+    while getattr(object, key) is None:
+        time.sleep(1)
+
+        setattr(object, f"_{key}", NotSet)
+        object._CompletableGithubObject__completed = False
+
+        count_limit -= 1
+        if count_limit == 0:
+            return
+
+
+def is_eligible_for_merge(pr: PullRequest):
+    resolve_async_status(pr, "mergeable")
+
+    if not pr.mergeable:
+        return False
+
+    if pr.user.login != "dependabot[bot]":
+        return False
+
+    # pr_title = pr.title.lower()
+    # if "patch" not in pr_title and "github actions" not in pr_title:
+    #     return False
+
+    last_commit = pr.get_commits().reversed[0]
+    combined_status = last_commit.get_combined_status()
+    status = combined_status.state
+
+    # status is different than CI runs!
+    if len(combined_status.statuses) > 0 and status != "success":
+        return False
+
+    all_checks_successful = (
+        last_commit.get_check_runs() | fp.pluck_attr("conclusion") | fp.all("success")
+    )
+
+    if not all_checks_successful:
+        return False
+
+    return True
+
+
+def process_repo(repo, dry_run):
+    log.debug("checking repository", repo=repo.full_name)
+
+    if repo.fork:
+        log.debug("skipping forked repo")
+        return
+
+    pulls = repo.get_pulls(state="open")
+
+    if pulls.totalCount == 0:
+        log.debug("no open prs, skipping")
+        return
+
+    merged_pr_count = 0
+
+    for pr in pulls:
+        if is_eligible_for_merge(pr):
+            merge_pr(pr, dry_run)
+
+            merged_pr_count += 1
+        else:
+            log.debug("skipping PR", url=pr.html_url)
+
+    log.info("merged prs", count=merged_pr_count)
+
+
+def main(token, dry_run, repo):
+    assert token, "GitHub token is required"
+
+    g = Github(token)
+    user = g.get_user()
+
+    if repo:
+        process_repo(g.get_repo(repo), dry_run)
+        return
+
+    # if not, process everything!
+    user.get_repos(type="public") | fp.filter(
+        lambda repo: repo.owner.login == user.login
+    ) | fp.map(fp.rpartial(process_repo, dry_run)) | fp.to_list()
+
+    log.info("dependabot pr check complete")
+
+
+@click.command()
+@click.option(
+    "--token",
+    help="GitHub token, can also be set via GITHUB_TOKEN",
+    default=os.getenv("GITHUB_TOKEN"),
+)
+@click.option("--dry-run", is_flag=True, help="Run script without merging PRs")
+@click.option("--repo", help="Only process a single repository")
+def cli(token, dry_run, repo):
+    """
+    Automatically merge dependabot PRs in public repos that have passed CI checks
+    """
+
+    if repo:
+        # convert 'https://github.com/iloveitaly/todoist-digest/pulls' to 'iloveitaly/todoist-digest'
+        if "github.com" in repo:
+            match = re.search(r"github\.com/([^/]+)/([^/]+)", repo)
+
+            if match:
+                repo = f"{match.group(1)}/{match.group(2)}"
+
+    main(token, dry_run, repo)
+
+
+if __name__ == "__main__":
+    cli()

github_overlord-0.2.0/github_overlord/utils.py

@@ -0,0 +1,74 @@
+"""
+This file should be imported first in any application entrypoint.
+"""
+
+import logging
+import typing as t
+from pathlib import Path
+
+import structlog
+from decouple import config
+
+
+def configure_logger():
+    logger_factory = structlog.PrintLoggerFactory()
+
+    # allow user to specify a log in case they want to do something meaningful with the stdout
+    if python_log_path := config("PYTHON_LOG_PATH", default=None):
+        python_log = open(
+            python_log_path, "a", encoding="utf-8"
+        )  # pylint: disable=consider-using-with
+        logger_factory = structlog.PrintLoggerFactory(file=python_log)
+
+    log_level = t.cast(str, config("LOG_LEVEL", default="INFO", cast=str))
+    level = getattr(logging, log_level.upper())
+
+    # TODO logging.root.manager.loggerDict
+    # we need this option to be set for other non-structlog loggers
+    logging.basicConfig(level=level)
+
+    # TODO look into further customized format
+    # https://cs.github.com/GeoscienceAustralia/digitalearthau/blob/4cf486eb2a93d7de23f86ce6de0c3af549fe42a9/digitalearthau/uiutil.py#L45
+
+    structlog.configure(
+        context_class=dict,
+        wrapper_class=structlog.make_filtering_bound_logger(level),
+        logger_factory=logger_factory,
+        cache_logger_on_first_use=True,
+    )
+
+
+# must type manually, unfortunately :/
+# https://www.structlog.org/en/21.3.0/types.html
+log: structlog.stdlib.BoundLogger
+
+
+def setup():
+    if hasattr(setup, "complete") and setup.complete:
+        return
+
+    global root, logger, log
+
+    root = Path(__file__).parent.parent
+
+    log = structlog.get_logger()
+
+    # context manager to auto-clear context
+    log.context = structlog.contextvars.bound_contextvars  # type: ignore
+    # set thread-local context
+    log.local = structlog.contextvars.bind_contextvars  # type: ignore
+    # clear thread-local context
+    log.clear = structlog.contextvars.clear_contextvars  # type: ignore
+
+    logger = log
+
+    configure_logger()
+
+    log.info("application setup")
+
+    # local state in a method is strange, but it works :/
+    setup.complete = True
+
+
+# side effects are bad, but it's fun to do bad things
+setup()

github_overlord-0.2.0/pyproject.toml

@@ -0,0 +1,34 @@
+[tool.poetry]
+name = "github-overlord"
+version = "0.2.0"
+description = "Automatically merge Dependabot PRs in public repositories"
+authors = ["Michael Bianco <mike@mikebian.co>"]
+readme = "README.md"
+keywords = ["github", "dependabot", "automation"]
+
+[tool.poetry.dependencies]
+python = "^3.12"
+pygithub = "^2.3.0"
+click = "^8.1.7"
+python-decouple-typed = "^3.11.0"
+funcy-pipe = "^0.11.0"
+structlog = "^24.2.0"
+
+[tool.poetry.scripts]
+github-overlord = "github_overlord:cli"
+
+
+[tool.isort]
+profile = "black"
+# helpful when copy/pasting GPT code
+float_to_top = true
+
+[tool.poetry.group.dev.dependencies]
+isort = "^5.13.2"
+black = "^24.4.2"
+pyright = "^1.1.366"
+pylint = "^3.2.3"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"