github-rest-api 0.45.0__py3-none-any.whl → 0.47.0__py3-none-any.whl

github_rest_api/pr_content.py

@@ -83,9 +83,15 @@ def deterministic_title(compare: dict[str, Any]) -> str:
     """Derive a Conventional-Commits title from a comparison result.
 
     The type is the most significant type present across the commits
-    (``feat`` > ``fix`` > the most frequent parsed type > ``chore``); the scope
-    is the common top-level directory of the changed files; ``!`` is appended
-    for breaking changes.
+    (``feat`` > ``fix`` > the most frequent parsed type). When no commit follows
+    the Conventional-Commits grammar, the type is ``ci`` for changes confined to
+    ``.github`` and ``chore`` otherwise. The scope is the common top-level
+    directory of the changed files; ``!`` is appended for breaking changes.
+
+    The description reuses a matching commit's description when available and
+    otherwise falls back to the first commit's subject line, so a genuinely
+    descriptive (if non-conventional) subject is preserved rather than replaced
+    by a generic placeholder.
 
     :param compare: The comparison result from `Repository.compare`.
     """
@@ -94,17 +100,22 @@ def deterministic_title(compare: dict[str, Any]) -> str:
     parsed = [parse_conventional(subject) for subject in subjects]
     types = [item[0] for item in parsed if item]
     scope = _common_scope(compare)
-    prefix_scope = f"({scope})" if scope else ""
-    if not subjects:
-        return f"chore{prefix_scope}: update"
     if "feat" in types:
         type_ = "feat"
     elif "fix" in types:
         type_ = "fix"
     elif types:
         type_ = Counter(types).most_common(1)[0][0]
+    elif scope == ".github":
+        # Changes confined to `.github` (e.g. workflow files) are conventionally
+        # `ci`; the type already conveys the location, so drop the (redundant)
+        # `.github` scope.
+        type_, scope = "ci", None
     else:
         type_ = "chore"
+    prefix_scope = f"({scope})" if scope else ""
+    if not subjects:
+        return f"{type_}{prefix_scope}: update"
     breaking = any(item[2] for item in parsed if item) or any(
         _BREAKING_CHANGE_PATTERN.search(message) for message in messages
     )
@@ -113,7 +124,7 @@ def deterministic_title(compare: dict[str, Any]) -> str:
     else:
         description = next(
             (item[3] for item in parsed if item and item[0] == type_),
-            f"update {len(subjects)} commits",
+            subjects[0],
         )
     return f"{type_}{prefix_scope}{'!' if breaking else ''}: {description}"
 

github_rest_api/scripts/github/auto_merge_pull_request.py

@@ -0,0 +1,109 @@
+"""Auto-merge eligible open pull requests in the repository.
+
+Every open PR is evaluated by ``Repository.auto_merge_pull_requests`` and merged
+only when it passes the eligibility gate (author allowlist, title type, head
+commit age, mergeable state and an approving review or marker comment).
+"""
+
+import logging
+import os
+import sys
+from argparse import ArgumentParser, Namespace
+
+from github_rest_api import MergeMethod, Repository
+from github_rest_api.github import (
+    DEFAULT_AUTO_MERGE_MARKER,
+    DEFAULT_AUTO_MERGE_TYPES,
+    DEFAULT_MIN_AGE_MINUTES,
+)
+
+
+def parse_args(args=None, namespace=None) -> Namespace:
+    """Parse command-line arguments.
+    :param args: The arguments to parse.
+        If None, the arguments from command-line are parsed.
+    :param namespace: An inital Namespace object.
+    :return: A namespace object containing parsed options.
+    """
+    parser = ArgumentParser(description="Auto-merge eligible open pull requests.")
+    parser.add_argument(
+        "--token",
+        dest="token",
+        required=True,
+        help="The personal access token for authentication.",
+    )
+    parser.add_argument(
+        "--authors",
+        dest="authors",
+        nargs="*",
+        default=[],
+        help="Logins whose PRs are eligible for auto-merge. An empty allowlist "
+        "makes nothing eligible (fail-safe).",
+    )
+    parser.add_argument(
+        "--approvers",
+        dest="approvers",
+        nargs="*",
+        default=[],
+        help="Logins whose reviews or marker comments grant approval.",
+    )
+    parser.add_argument(
+        "--allowed-types",
+        dest="allowed_types",
+        nargs="*",
+        default=list(DEFAULT_AUTO_MERGE_TYPES),
+        help="Conventional-Commits title types eligible for auto-merge.",
+    )
+    parser.add_argument(
+        "--min-age-minutes",
+        dest="min_age_minutes",
+        type=int,
+        default=DEFAULT_MIN_AGE_MINUTES,
+        help="The minimum head-commit age in minutes; set to 0 to disable the guard.",
+    )
+    parser.add_argument(
+        "--marker",
+        dest="marker",
+        default=DEFAULT_AUTO_MERGE_MARKER,
+        help="The marker substring an approver may comment to approve.",
+    )
+    parser.add_argument(
+        "--merge-method",
+        dest="merge_method",
+        choices=[m.value for m in MergeMethod],
+        default=MergeMethod.MERGE.value,
+        help="The merge method to use.",
+    )
+    parser.add_argument(
+        "--dry-run",
+        dest="dry_run",
+        action="store_true",
+        help="Log the PRs that would be merged without merging them.",
+    )
+    return parser.parse_args(args=args, namespace=namespace)
+
+
+def main() -> int:
+    """Main entrance of the script,
+    which auto-merges every eligible open pull request in the repository.
+    """
+    args = parse_args()
+    # auto_merge_pull_requests reports its outcomes (including the dry-run
+    # listing) via logging.info, which the root logger suppresses by default;
+    # configure logging so those messages are actually emitted.
+    logging.basicConfig(level=logging.INFO, format="%(message)s")
+    repo = Repository(args.token, os.environ["GITHUB_REPOSITORY"])
+    repo.auto_merge_pull_requests(
+        authors=args.authors,
+        approvers=args.approvers,
+        allowed_types=args.allowed_types,
+        min_age_minutes=args.min_age_minutes,
+        marker=args.marker,
+        merge_method=args.merge_method,
+        dry_run=args.dry_run,
+    )
+    return 0
+
+
+if __name__ == "__main__":
+    sys.exit(main())

github_rest_api/scripts/github/{add_github_repo.py → create_github_repo.py}

@@ -38,6 +38,13 @@ def _remote_url(repo: str, protocol: str) -> str:
     return f"https://github.com/{repo}.git"
 
 
+def _ensure_remote(path: Path, repo: str, protocol: str) -> None:
+    try:
+        porcelain.remote_add(path, "origin", _remote_url(repo, protocol))
+    except porcelain.RemoteExists:
+        pass
+
+
 def _init_local_repo(
     repo: str,
     language: str,
@@ -54,33 +61,34 @@ def _init_local_repo(
         readme.write_text(f"# {repo_name}\n")
     if not (path / ".git").exists():
         porcelain.init(path=path)
-        porcelain.remote_add(path, "origin", _remote_url(repo, protocol))
         initial_branch = (
             (path / ".git" / "HEAD").read_text().strip().partition("refs/heads/")[-1]
         )
         porcelain.add(repo=path)
         porcelain.commit(repo=path, message="first commit")
-
-        def _create_push_branch(branch: str):
+        for branch in branches:
             if branch != initial_branch:
                 porcelain.branch_create(repo=path, name=branch)
-            porcelain.checkout(repo=path, target=branch)
-            porcelain.push(
-                repo=path,
-                remote_location=_remote_url(repo, "https"),
-                username="x-access-token",
-                password=token,
-            )
-
-        for branch in branches:
-            _create_push_branch(branch)
         porcelain.checkout(repo=path, target=branches[0])
         if initial_branch not in branches:
             porcelain.branch_delete(repo=path, name=initial_branch)
+    _ensure_remote(path, repo, protocol)
+    local_branches = {b.decode() for b in porcelain.branch_list(path)}
+    branches_to_push = [branch for branch in branches if branch in local_branches]
+    if not branches_to_push:
+        branches_to_push = [porcelain.active_branch(path).decode()]
+    for branch in branches_to_push:
+        porcelain.push(
+            repo=path,
+            remote_location=_remote_url(repo, "https"),
+            refspecs=[branch.encode()],
+            username="x-access-token",
+            password=token,
+        )
     _add_workflow(path, language)
 
 
-def add_github_repo(
+def create_github_repo(
     repo: str,
     private: bool,
     language: str,
@@ -117,7 +125,7 @@ def _add_workflow(path: Path, language: str, workflow_dir: Path | None = None) -
         workflow_dir = Path(__file__).parent / "workflows"
     dir_dest = path / ".github" / "workflows"
     dir_dest.mkdir(parents=True, exist_ok=True)
-    for yaml in workflow_dir.glob("*.yml"):
+    for yaml in workflow_dir.glob("*.yaml"):
         if not (dir_dest / yaml.name).exists():
             shutil.copy2(yaml, dir_dest)
     if not language:
@@ -125,13 +133,13 @@ def _add_workflow(path: Path, language: str, workflow_dir: Path | None = None) -
     lang_dir = workflow_dir / language
     if not lang_dir.exists():
         return
-    for yaml in lang_dir.glob("*.yml"):
+    for yaml in lang_dir.glob("*.yaml"):
         if not (dir_dest / yaml.name).exists():
             shutil.copy2(yaml, dir_dest)
 
 
 def parse_args(args=None, namespace=None):
-    parser = argparse.ArgumentParser(description="Add a GitHub repository.")
+    parser = argparse.ArgumentParser(description="Create a GitHub repository.")
     parser.add_argument(
         "repo",
         help="The GitHub repo (in the format of owner/repo) to be created.",
@@ -203,7 +211,7 @@ def parse_args(args=None, namespace=None):
 def main() -> int:
     args = parse_args()
     try:
-        add_github_repo(
+        create_github_repo(
             repo=args.repo,
             private=args.private,
             language=args.language,

{github_rest_api-0.45.0.dist-info → github_rest_api-0.47.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: github-rest-api
-Version: 0.45.0
+Version: 0.47.0
 Summary: Simple wrapper of GitHub REST APIs.
 Author-email: Ben Du <longendu@yahoo.com>
 Classifier: Programming Language :: Python :: 3 :: Only

{github_rest_api-0.45.0.dist-info → github_rest_api-0.47.0.dist-info}/RECORD

@@ -1,6 +1,6 @@
 github_rest_api/__init__.py,sha256=VVpiUHVLbjjJGNN88OmEvCwq4xmBnXv68T8Apk_lwVc,282
 github_rest_api/github.py,sha256=iAfhPLH9UGPtScZfcV1TCeY5XfUzAMqenf5FrSNplQc,45146
-github_rest_api/pr_content.py,sha256=8SJKdTOCTt1pZasmh3MEQ2sRXlVX2dYGpYHZP9H5K3g,9415
+github_rest_api/pr_content.py,sha256=og1VwsMtwqwl-HUJcJrkwjUjFPw9E1k5xDtJVMAXBRo,10039
 github_rest_api/utils.py,sha256=RspoIZik0g105KpyFXCf4epAtgu1dUsxwlwUSSGhXPI,2697
 github_rest_api/scripts/__init__.py,sha256=NkHTngnnWXPc0JmO5mqVKjDf4JPofuwWjDW1SU3aE7Y,36
 github_rest_api/scripts/utils.py,sha256=o5GzgSNyGHUIHhaaG5QUfXvv6fsTQPCHD9clGRNMggU,4588
@@ -13,7 +13,8 @@ github_rest_api/scripts/container/build_container_images.py,sha256=-ZPPKVUpc0v-_
 github_rest_api/scripts/container/config_container.py,sha256=BtOqgZlQFM9cWZMoHKvOzNsyXxCl_DLqYWbMqu1YOWM,2835
 github_rest_api/scripts/container/update_version_containerfile.py,sha256=1PkuJkAsJBCEMdacMSndbuZKcmgUyXy6nBArnxKoPZk,4535
 github_rest_api/scripts/github/__init__.py,sha256=tEU1SdCS51M4M13WoqXZt3rjGEAI_QgNljt5XAyQJ_w,38
-github_rest_api/scripts/github/add_github_repo.py,sha256=iFuDGXYz_bCXo9_1Y4TMleSZ4HFHriNOT9oj4-XAnno,6351
+github_rest_api/scripts/github/auto_merge_pull_request.py,sha256=_5191Xt_b8DtxjIqHrdY-gKLxvkzWd8oWoSbF2uauc8,3527
+github_rest_api/scripts/github/create_github_repo.py,sha256=7t2dgDcLrLPpBY5CpTtkkIe8Z_-2FGgoRo_--HXwcuw,6686
 github_rest_api/scripts/github/create_pull_request.py,sha256=gXtRRsxzegGxagHb6k3kxtRd3mt4QVwSPZQpsFnzz1Y,3968
 github_rest_api/scripts/github/release_on_github.py,sha256=9psaIv-GtrHdvE-tkw0yxCMDmW0bPts-db2vUxhoKXo,4368
 github_rest_api/scripts/github/remove_branch.py,sha256=iKZ4Y_lQlSOIfifC4plqP-B6pEMnFrknGMvV1oLnuLc,3538
@@ -23,7 +24,7 @@ github_rest_api/scripts/github/workflows/create_pr_to_main.yaml,sha256=mgHPlewkC
 github_rest_api/scripts/github/workflows/remove_branch.yaml,sha256=KDpB76ovrhuRdP0HN5j6Th9gjIQWSDdh8b4b4yAgtoI,544
 github_rest_api/scripts/github/workflows/python/lint.yaml,sha256=toP2oUdVIKyu_n20Dr14k5cJYxN8rPksfbX4sfflXxc,699
 github_rest_api/scripts/github/workflows/python/test.yaml,sha256=86MljYEWX1E9kJYmhMCLwu46WNEWvoyO9PwqeRew540,887
-github_rest_api-0.45.0.dist-info/METADATA,sha256=wvu0t0cqklG5gPmrq_0QmbyOR5frDuhAjyMbAmf8SVI,915
-github_rest_api-0.45.0.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
-github_rest_api-0.45.0.dist-info/entry_points.txt,sha256=eXMEdbMEpuE1nsTfUiKSILgS4awe09NwKn0N2_fZ9H0,567
-github_rest_api-0.45.0.dist-info/RECORD,,
+github_rest_api-0.47.0.dist-info/METADATA,sha256=SjlTYqUbYuVm5n3gvDE7NE1PutETNTXXoV609PLMOsc,915
+github_rest_api-0.47.0.dist-info/WHEEL,sha256=lCkmxWfQsSc9CfIClYeavTdQeEX2toPqufh9gI35EQA,87
+github_rest_api-0.47.0.dist-info/entry_points.txt,sha256=OfbP9GuQC7SyGbymfCYrXEG-TCcKuu31v0EPNvHc1Q4,659
+github_rest_api-0.47.0.dist-info/RECORD,,

{github_rest_api-0.45.0.dist-info → github_rest_api-0.47.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.30.1
+Generator: hatchling 1.31.0
 Root-Is-Purelib: true
 Tag: py3-none-any

{github_rest_api-0.45.0.dist-info → github_rest_api-0.47.0.dist-info}/entry_points.txt

@@ -1,7 +1,8 @@
 [console_scripts]
-add_github_repo = github_rest_api.scripts.github.add_github_repo:main
+auto_merge_pull_request = github_rest_api.scripts.github.auto_merge_pull_request:main
 build_container_images = github_rest_api.scripts.container.build_container_images:main
 config_container = github_rest_api.scripts.container.config_container:main
+create_github_repo = github_rest_api.scripts.github.create_github_repo:main
 create_pull_request = github_rest_api.scripts.github.create_pull_request:main
 release_on_github = github_rest_api.scripts.github.release_on_github:main
 remove_branch = github_rest_api.scripts.github.remove_branch:main