github-rest-api 0.45.0__tar.gz → 0.47.0__tar.gz

github_rest_api-0.47.0/.github/workflows/claude-code-review.yml

@@ -0,0 +1,44 @@
+name: Claude Code Review
+
+on:
+  pull_request:
+    types: [opened, synchronize, ready_for_review, reopened]
+    # Optional: Only run on specific file changes
+    # paths:
+    #   - "src/**/*.ts"
+    #   - "src/**/*.tsx"
+    #   - "src/**/*.js"
+    #   - "src/**/*.jsx"
+
+jobs:
+  claude-review:
+    # Optional: Filter by PR author
+    # if: |
+    #   github.event.pull_request.user.login == 'external-contributor' ||
+    #   github.event.pull_request.user.login == 'new-developer' ||
+    #   github.event.pull_request.author_association == 'FIRST_TIME_CONTRIBUTOR'
+
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: read
+      issues: read
+      id-token: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 1
+
+      - name: Run Claude Code Review
+        id: claude-review
+        uses: anthropics/claude-code-action@v1
+        with:
+          claude_code_oauth_token: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}
+          plugin_marketplaces: 'https://github.com/anthropics/claude-code.git'
+          plugins: 'code-review@claude-code-plugins'
+          prompt: '/code-review:code-review ${{ github.repository }}/pull/${{ github.event.pull_request.number }}'
+          # See https://github.com/anthropics/claude-code-action/blob/main/docs/usage.md
+          # or https://code.claude.com/docs/en/cli-reference for available options
+

github_rest_api-0.47.0/.github/workflows/claude.yml

@@ -0,0 +1,50 @@
+name: Claude Code
+
+on:
+  issue_comment:
+    types: [created]
+  pull_request_review_comment:
+    types: [created]
+  issues:
+    types: [opened, assigned]
+  pull_request_review:
+    types: [submitted]
+
+jobs:
+  claude:
+    if: |
+      (github.event_name == 'issue_comment' && contains(github.event.comment.body, '@claude')) ||
+      (github.event_name == 'pull_request_review_comment' && contains(github.event.comment.body, '@claude')) ||
+      (github.event_name == 'pull_request_review' && contains(github.event.review.body, '@claude')) ||
+      (github.event_name == 'issues' && (contains(github.event.issue.body, '@claude') || contains(github.event.issue.title, '@claude')))
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: read
+      issues: read
+      id-token: write
+      actions: read # Required for Claude to read CI results on PRs
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 1
+
+      - name: Run Claude Code
+        id: claude
+        uses: anthropics/claude-code-action@v1
+        with:
+          claude_code_oauth_token: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}
+
+          # This is an optional setting that allows Claude to read CI results on PRs
+          additional_permissions: |
+            actions: read
+
+          # Optional: Give a custom prompt to Claude. If this is not specified, Claude will perform the instructions specified in the comment that tagged it.
+          # prompt: 'Update the pull request description to include a summary of changes.'
+
+          # Optional: Add claude_args to customize behavior and configuration
+          # See https://github.com/anthropics/claude-code-action/blob/main/docs/usage.md
+          # or https://code.claude.com/docs/en/cli-reference for available options
+          # claude_args: '--allowed-tools Bash(gh pr *)'
+

{github_rest_api-0.45.0 → github_rest_api-0.47.0}/.github/workflows/lint.yaml

@@ -24,3 +24,11 @@ jobs:
       run: uv run ty check
     - name: Analyze Dependencies
       run: uv run deptry .
+    - name: Check workflow templates use .yaml extension
+      run: |
+        yml_files=$(find github_rest_api/scripts/github/workflows/ -name '*.yml')
+        if [ -n "$yml_files" ]; then
+          echo "The following workflow templates must use the .yaml extension instead of .yml:"
+          echo "$yml_files"
+          exit 1
+        fi

{github_rest_api-0.45.0 → github_rest_api-0.47.0}/.github/workflows/test.yaml

@@ -24,4 +24,4 @@ jobs:
     - name: Test with pytest
       run: uv run --python ${{ matrix.python-version }} pytest
       env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        GITHUB_TOKEN: ${{ secrets.ACTIONS_TOKEN }}

{github_rest_api-0.45.0 → github_rest_api-0.47.0}/PKG-INFO

@@ -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 → github_rest_api-0.47.0}/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-0.47.0/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-0.45.0/github_rest_api/scripts/github/add_github_repo.py → github_rest_api-0.47.0/github_rest_api/scripts/github/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 → github_rest_api-0.47.0}/pyproject.toml

@@ -4,7 +4,7 @@ requires = [ "hatchling" ]
 
 [project]
 name = "github-rest-api"
-version = "0.45.0"
+version = "0.47.0"
 description = "Simple wrapper of GitHub REST APIs."
 readme = "README.md"
 authors = [ { name = "Ben Du", email = "longendu@yahoo.com" } ]
@@ -27,9 +27,10 @@ dependencies = [
 optional-dependencies.ai = [
   "litellm>=1.50",
 ]
-scripts.add_github_repo = "github_rest_api.scripts.github.add_github_repo:main"
+scripts.auto_merge_pull_request = "github_rest_api.scripts.github.auto_merge_pull_request:main"
 scripts.build_container_images = "github_rest_api.scripts.container.build_container_images:main"
 scripts.config_container = "github_rest_api.scripts.container.config_container:main"
+scripts.create_github_repo = "github_rest_api.scripts.github.create_github_repo:main"
 scripts.create_pull_request = "github_rest_api.scripts.github.create_pull_request:main"
 scripts.release_on_github = "github_rest_api.scripts.github.release_on_github:main"
 scripts.remove_branch = "github_rest_api.scripts.github.remove_branch:main"

{github_rest_api-0.45.0 → github_rest_api-0.47.0}/tests/test_pr_content.py

@@ -136,6 +136,54 @@ def test_deterministic_title_no_scope_for_root_files():
     assert deterministic_title(compare) == "chore: bump"
 
 
+def test_deterministic_title_non_conventional_multi_uses_first_subject():
+    compare = {
+        "commits": [
+            _commit("1", "did some work"),
+            _commit("2", "did more work"),
+        ],
+        "files": [_file("pkg/a.py"), _file("pkg/b.py")],
+    }
+    # No conventional commits: fall back to the first subject rather than the
+    # generic "update N commits" placeholder.
+    assert deterministic_title(compare) == "chore(pkg): did some work"
+
+
+def test_deterministic_title_github_scope_maps_to_ci():
+    compare = {
+        "commits": [
+            _commit("1", "Claude PR Assistant workflow"),
+            _commit("2", "Claude Code Review workflow"),
+        ],
+        "files": [
+            _file(".github/workflows/claude.yml", "added"),
+            _file(".github/workflows/claude-review.yml", "added"),
+        ],
+    }
+    # `.github`-only changes become `ci` (with the redundant scope dropped), and
+    # the first subject supplies the description.
+    assert deterministic_title(compare) == "ci: Claude PR Assistant workflow"
+
+
+def test_deterministic_title_github_scope_respects_conventional_type():
+    compare = {
+        "commits": [_commit("1", "docs: update issue template")],
+        "files": [_file(".github/ISSUE_TEMPLATE/bug.md")],
+    }
+    # An explicit conventional type wins over the `.github` -> `ci` fallback.
+    assert deterministic_title(compare) == "docs(.github): update issue template"
+
+
+def test_deterministic_title_github_ci_not_applied_when_mixed_with_other_dir():
+    compare = {
+        "commits": [_commit("1", "tweak things")],
+        "files": [_file(".github/workflows/ci.yml"), _file("pkg/a.py")],
+    }
+    # Changes span `.github` and another top-level dir, so no common scope and no
+    # `ci` upgrade -- the generic `chore` fallback applies.
+    assert deterministic_title(compare) == "chore: tweak things"
+
+
 def test_deterministic_body_sections():
     body = deterministic_body(COMPARE)
     assert "## Summary" in body

{github_rest_api-0.45.0 → github_rest_api-0.47.0}/uv.lock

@@ -542,7 +542,7 @@ wheels = [
 
 [[package]]
 name = "github-rest-api"
-version = "0.44.0"
+version = "0.47.0"
 source = { editable = "." }
 dependencies = [
     { name = "dulwich" },