github-rest-api 0.49.0__tar.gz → 0.51.1__tar.gz

{github_rest_api-0.49.0 → github_rest_api-0.51.1}/.github/workflows/auto_merge_pull_request.yaml

@@ -13,9 +13,7 @@ on:
   # Renaming any of these silently disables the trigger.
   workflow_run:
     workflows:
-      - Claude Code Review
-      - Lint Code
-      - Run Tests
+      - PR Workflow
     types:
       - completed
   # Kept for approvals that come from a human rather than from Claude.
@@ -60,22 +58,7 @@ jobs:
     if: |
       github.event_name != 'workflow_run'
       || github.event.workflow_run.conclusion == 'success'
-    runs-on: ubuntu-latest
-    # The concurrency group above serializes every run, so a hung run would
-    # block all merges until the default 6h timeout.
-    timeout-minutes: 10
-    steps:
-      - name: Install uv
-        run: |
-          curl -LsSf https://astral.sh/uv/install.sh | sudo env UV_INSTALL_DIR="/usr/local/bin" sh
-      - name: Auto Merge PR
-        # `--allowed-types` is intentionally left at the upstream default
-        # (build, chore, ci, docs, deps) so that only simple PRs auto-merge;
-        # anything substantive, `feat` and `fix` included, is merged by hand.
-        run: |
-          uvx --from github-rest-api@latest auto_merge_pull_request \
-            --authors dclong \
-            --approvers dclong 'claude[bot]' 'gemini-code-assist[bot]' \
-            --marker 'AUTO_MERGE_APPROVED' \
-            ${{ inputs.dry_run && '--dry-run' || '' }} \
-            --token ${{ secrets.ACTIONS_TOKEN }}
+    uses: legendu-net/.github/.github/workflows/auto_merge_pull_request.yaml@main
+    with:
+      dry_run: ${{ inputs.dry_run || false }}
+    secrets: inherit

github_rest_api-0.51.1/.github/workflows/check_workflow_template.yaml

@@ -0,0 +1,20 @@
+name: Check Workflow Templates
+
+on:
+  pull_request:
+    paths:
+      - .github/workflows/**
+
+jobs:
+  check_workflow_template:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v6
+    - name: Check workflow templates use .yaml extension
+      run: |
+        yml_files=$(find .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.51.1/.github/workflows/claude.yaml

@@ -0,0 +1,27 @@
+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')))
+    permissions:
+      actions: read
+      contents: read
+      issues: read
+      pull-requests: read
+      id-token: write
+    uses: legendu-net/.github/.github/workflows/claude.yml@main
+    secrets: inherit

github_rest_api-0.51.1/.github/workflows/create_pr_dev_to_main.yaml

@@ -0,0 +1,9 @@
+name: Create PR From dev To main
+on:
+  push:
+    branches:
+      - dev
+jobs:
+  create_pr_dev_to_main:
+    uses: legendu-net/.github/.github/workflows/create_pr_dev_to_main.yaml@main
+    secrets: inherit

github_rest_api-0.51.1/.github/workflows/create_pr_to_dev.yaml

@@ -0,0 +1,11 @@
+name: Create PR to dev
+on:
+  push:
+    branches-ignore:
+      - main
+      - dev
+      - gh-pages*
+jobs:
+  create_pr_to_dev:
+    uses: legendu-net/.github/.github/workflows/create_pr_to_dev.yaml@main
+    secrets: inherit

github_rest_api-0.51.1/.github/workflows/create_pr_to_main.yaml

@@ -0,0 +1,10 @@
+name: Create PR To main
+on:
+  push:
+    branches-ignore:
+      - main
+      - _**
+jobs:
+  create_pr_main:
+    uses: legendu-net/.github/.github/workflows/create_pr_to_main.yaml@main
+    secrets: inherit

github_rest_api-0.51.1/.github/workflows/pr-workflow.yaml

@@ -0,0 +1,34 @@
+name: PR Workflow
+
+on:
+  pull_request:
+    types: [opened, synchronize, ready_for_review, reopened]
+    branches:
+      - dev
+      - main
+
+jobs:
+  lint_code:
+    uses: legendu-net/.github/.github/workflows/lint.yaml@main
+    secrets: inherit
+
+  test_code:
+    permissions:
+      contents: read
+      pull-requests: read
+    uses: legendu-net/.github/.github/workflows/test.yaml@main
+    secrets: inherit
+
+  claude-review:
+    needs: [lint_code, test_code]
+    permissions:
+      contents: read
+      issues: write
+      pull-requests: write
+      id-token: write
+    uses: legendu-net/.github/.github/workflows/claude-code-review.yml@main
+    with:
+      pr_number: ${{ github.event.pull_request.number }}
+      draft: ${{ github.event.pull_request.draft }}
+      head_repo_full_name: ${{ github.event.pull_request.head.repo.full_name }}
+    secrets: inherit

github_rest_api-0.51.1/.github/workflows/release.yaml

@@ -0,0 +1,12 @@
+name: Release
+on:
+  release:
+    types: [published]
+jobs:
+  release:
+    permissions:
+      contents: write
+      issues: write
+      pull-requests: write
+    uses: legendu-net/.github/.github/workflows/release.yaml@main
+    secrets: inherit

github_rest_api-0.51.1/.github/workflows/remove_branch.yaml

@@ -0,0 +1,9 @@
+name: Remove Branches
+on:
+  schedule:
+    - cron: '0 3 * * *'
+      timezone: 'America/Los_Angeles'
+jobs:
+  remove_branch:
+    uses: legendu-net/.github/.github/workflows/remove_branch.yaml@main
+    secrets: inherit

github_rest_api-0.49.0/GEMINI.md → github_rest_api-0.51.1/AGENTS.md

@@ -7,7 +7,7 @@ A simple Python wrapper for GitHub REST APIs, optimized for use in GitHub Action
 - **Purpose:** Provide a streamlined interface for interacting with GitHub's REST API
   and performing Git operations within automation scripts.
 - **Main Technologies:**
-  - **Python 3.12+**: Core language.
+  - **Python 3.12.7+**: Core language.
   - **requests**: For HTTP interactions with the GitHub API.
   - **dulwich**: A pure-Python implementation of Git for repository operations.
   - **tenacity**: For retry logic on API requests.

github_rest_api-0.51.1/CLAUDE.md

@@ -0,0 +1 @@
+AGENTS.md

{github_rest_api-0.49.0 → github_rest_api-0.51.1}/PKG-INFO

@@ -1,13 +1,13 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: github-rest-api
-Version: 0.49.0
+Version: 0.51.1
 Summary: Simple wrapper of GitHub REST APIs.
 Author-email: Ben Du <longendu@yahoo.com>
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
-Requires-Python: <4,>=3.12
+Requires-Python: <4,>=3.12.7
 Requires-Dist: dulwich>=0.25.1
 Requires-Dist: psutil>=5.9.4
 Requires-Dist: pynacl>=1.5

{github_rest_api-0.49.0 → github_rest_api-0.51.1}/github_rest_api/github.py

@@ -1465,6 +1465,32 @@ class Repository(GitHub):
             json={"body": body},
         ).json()
 
+    def create_issue_comment_image(
+        self, issue_number: int, url: str, alt: str = "", body: str = ""
+    ) -> dict[str, Any]:
+        """Add a comment containing an image to an issue.
+
+        GitHub has no public API for the attachment upload that its web UI
+        performs on drag and drop, so the image must already be hosted
+        somewhere reachable; this method only references it.
+
+        :param issue_number: The number of the issue.
+        :param url: The URL of an already uploaded image.
+        :param alt: Alt text of the image.
+        :param body: Optional text placed above the image.
+        """
+        # A bracket in the alt text would close the markdown label early and
+        # degrade the whole image to literal text, so escape both brackets
+        # (and the escape character itself, which must come first).
+        alt = alt.replace("\\", "\\\\").replace("[", "\\[").replace("]", "\\]")
+        # The URL is wrapped in angle brackets so that spaces and unbalanced
+        # parentheses, which are common in URLs derived from file names, do
+        # not terminate the markdown link early.
+        image = f"![{alt}](<{url}>)"
+        return self.create_issue_comment(
+            issue_number, f"{body}\n\n{image}" if body else image
+        )
+
     def archive(self) -> requests.Response:
         return self._patch(
             url=self._url_repo,

{github_rest_api-0.49.0 → github_rest_api-0.51.1}/github_rest_api/scripts/github/create_github_repo.py

@@ -1,27 +1,28 @@
 """Add a GitHub repository and initialize a local Git repository with workflows."""
 
 import argparse
-import getpass
 import logging
-import os
-import shutil
 import sys
 from collections.abc import Sequence
 from pathlib import Path
 
+import requests
 from dulwich import porcelain
 from dulwich.refs import HEADREF, LOCAL_BRANCH_PREFIX, Ref
 
 from github_rest_api import Organization, User
+from github_rest_api.github import DEFAULT_TIMEOUT, URL_API, build_http_headers
+from github_rest_api.scripts.utils import resolve_github_token, validate_repo
 from github_rest_api.utils import as_str_sequence
 
 logger = logging.getLogger(__name__)
 
+# Workflows that configure this repository itself rather than the repositories
+# created from these templates.
+_REPO_ONLY_WORKFLOWS = frozenset({"check_workflow_template.yaml"})
 
-def _validate_repo(repo: str) -> None:
-    parts = repo.split("/")
-    if len(parts) != 2 or not parts[0] or not parts[1]:
-        raise ValueError(f"Invalid repo format '{repo}'. Expected 'owner/repo'.")
+# The default GitHub repo to copy workflow templates from.
+DEFAULT_WORKFLOWS_REPO = "legendu-net/github_rest_api"
 
 
 def _create_remote_repo(
@@ -45,11 +46,29 @@ def _remote_url(repo: str, protocol: str) -> str:
 
 
 def _ensure_remote(path: Path, repo: str, protocol: str) -> None:
+    url = _remote_url(repo, protocol)
     try:
-        porcelain.remote_add(path, "origin", _remote_url(repo, protocol))
+        porcelain.remote_add(path, "origin", url)
         logger.info("Added remote 'origin' for %s", repo)
     except porcelain.RemoteExists:
         pass
+    # `porcelain.remote_add` only writes the remote's `url`, unlike `git remote
+    # add`/`git clone`, which also set a `fetch` refspec. Without it, `git
+    # fetch`/`jj git fetch` never update `refs/remotes/origin/*`, so local
+    # branches silently stop tracking the remote. Repair it for a pre-existing
+    # 'origin' too (e.g. added by an older version of this script), but only
+    # when it already points at this repo, so an unrelated 'origin' remote is
+    # left untouched.
+    with porcelain.open_repo_closing(path) as r:
+        c = r.get_config()
+        try:
+            existing_url = c.get((b"remote", b"origin"), b"url")
+        except KeyError:
+            return
+        if existing_url != url.encode():
+            return
+        c.set((b"remote", b"origin"), b"fetch", b"+refs/heads/*:refs/remotes/origin/*")
+        c.write_to_path()
 
 
 def _active_branch(path: Path) -> str:
@@ -80,12 +99,12 @@ def _head_and_branches(path: Path) -> tuple[str | None, set[str]]:
 
 def _init_local_repo(
     repo: str,
-    language: str,
     dir_: str,
     token: str,
     protocol: str,
     push: bool,
     branches: Sequence[str] = ("main",),
+    workflows_repo: str = DEFAULT_WORKFLOWS_REPO,
 ) -> None:
     branches = list(dict.fromkeys(branches))
     if not branches:
@@ -154,64 +173,114 @@ def _init_local_repo(
             logger.info("Successfully pushed branch '%s'.", branch)
     else:
         logger.info("Skipping push (pass --push to push branches to the remote).")
-    _add_workflow(path, language)
+    _add_workflow(path, workflows_repo=workflows_repo, token=token)
 
 
 def create_github_repo(
     repo: str,
     private: bool,
-    language: str,
     is_owner_user: bool,
     dir_: str,
     token: str,
     protocol: str,
     push: bool,
     branches: Sequence[str] = ("main",),
+    workflows_repo: str = DEFAULT_WORKFLOWS_REPO,
 ) -> None:
     branches = as_str_sequence(branches)
-    token = token or os.getenv("GITHUB_TOKEN", "")
-    if not token:
-        token = getpass.getpass("Please enter your GitHub token: ")
-        if not token:
-            raise ValueError(
-                "No GitHub token is provided (via $GITHUB_TOKEN, --token or at prompt)."
-            )
+    token = resolve_github_token(token)
     repo = repo.strip()
-    _validate_repo(repo)
+    validate_repo(repo)
     _create_remote_repo(
         repo=repo, private=private, token=token, is_owner_user=is_owner_user
     )
     _init_local_repo(
         repo=repo,
-        language=language,
         dir_=dir_,
         token=token,
         branches=branches,
         protocol=protocol,
         push=push,
+        workflows_repo=workflows_repo,
     )
 
 
-def _add_workflow(path: Path, language: str, workflow_dir: Path | None = None) -> None:
-    if workflow_dir is None:
-        workflow_dir = Path(__file__).parent / "workflows"
+def _list_workflow_entries(workflows_repo: str, token: str) -> list[dict]:
+    """List the workflow template file entries available in a GitHub repo.
+
+    :param workflows_repo: The GitHub repo (in the format of owner/repo) to
+        list workflow templates from.
+    :param token: The GitHub token used to authenticate the request.
+    """
+    url = f"{URL_API}/repos/{workflows_repo}/contents/.github/workflows"
+    resp = requests.get(
+        url=url, headers=build_http_headers(token), timeout=DEFAULT_TIMEOUT
+    )
+    resp.raise_for_status()
+    return [
+        entry
+        for entry in resp.json()
+        if entry["type"] == "file"
+        and entry["name"].endswith(".yaml")
+        and entry["name"] not in _REPO_ONLY_WORKFLOWS
+    ]
+
+
+def _download_workflow(workflows_repo: str, entry: dict, token: str) -> str:
+    """Download the raw content of a single workflow template.
+
+    Prefers the entry's ``download_url`` (served from
+    raw.githubusercontent.com, which has a much higher rate limit than the
+    api.github.com contents endpoint used to list the entries), falling back
+    to a raw content request against the contents API for the rare case
+    where GitHub omits it.
+
+    :param workflows_repo: The GitHub repo (in the format of owner/repo) to
+        download the workflow template from.
+    :param entry: A file entry as returned by ``_list_workflow_entries``.
+    :param token: The GitHub token used to authenticate the request.
+    """
+    download_url = entry.get("download_url")
+    if download_url:
+        # No Authorization header here: raw.githubusercontent.com already
+        # embeds any access it needs (e.g. a signed token for a private repo)
+        # in the URL itself, and forwarding an Authorization header scoped to
+        # a *different* repo makes it fail closed with a 404 even for public
+        # content.
+        resp = requests.get(url=download_url, timeout=DEFAULT_TIMEOUT)
+    else:
+        url = f"{URL_API}/repos/{workflows_repo}/contents/.github/workflows/{
+            entry['name']
+        }"
+        headers = build_http_headers(token) | {
+            "Accept": "application/vnd.github.raw+json"
+        }
+        resp = requests.get(url=url, headers=headers, timeout=DEFAULT_TIMEOUT)
+    resp.raise_for_status()
+    return resp.text
+
+
+def _add_workflow(path: Path, workflows_repo: str, token: str) -> None:
+    """Download workflow templates from a GitHub repo into a local repo.
+
+    :param path: The local repo directory to add workflow templates to.
+    :param workflows_repo: The GitHub repo (in the format of owner/repo) to
+        copy workflow templates from. An empty string skips this step.
+    :param token: The GitHub token used to authenticate the requests.
+    """
+    if not workflows_repo:
+        logger.info("Skipping workflow templates (workflows_repo is empty).")
+        return
+    entries = _list_workflow_entries(workflows_repo, token)
+    if not entries:
+        raise FileNotFoundError(f"No workflow templates found in '{workflows_repo}'.")
     dir_dest = path / ".github" / "workflows"
     dir_dest.mkdir(parents=True, exist_ok=True)
-    for yaml in workflow_dir.glob("*.yaml"):
-        if not (dir_dest / yaml.name).exists():
-            shutil.copy2(yaml, dir_dest)
-            logger.info("Copied workflow %s to %s", yaml.name, dir_dest)
-    if not language:
-        return
-    lang_dir = workflow_dir / language
-    if not lang_dir.exists():
-        return
-    for yaml in lang_dir.glob("*.yaml"):
-        if not (dir_dest / yaml.name).exists():
-            shutil.copy2(yaml, dir_dest)
-            logger.info(
-                "Copied %s specific workflow %s to %s", language, yaml.name, dir_dest
-            )
+    for entry in entries:
+        dest = dir_dest / entry["name"]
+        if not dest.exists():
+            dest.write_text(_download_workflow(workflows_repo, entry, token))
+            logger.info("Downloaded workflow %s from %s", entry["name"], workflows_repo)
 
 
 def parse_args(args=None, namespace=None):
@@ -250,14 +319,6 @@ def parse_args(args=None, namespace=None):
         action="store_false",
         help="Whether to create the repository as public.",
     )
-    parser.add_argument(
-        "-l",
-        "--lang",
-        "--language",
-        dest="language",
-        default="",
-        help="The language of the GitHub repository.",
-    )
     parser.add_argument(
         "-d",
         "--dir",
@@ -287,6 +348,15 @@ def parse_args(args=None, namespace=None):
         action="store_true",
         help="Push branches to the remote (by default, nothing is pushed).",
     )
+    parser.add_argument(
+        "-w",
+        "--workflows-repo",
+        dest="workflows_repo",
+        default=DEFAULT_WORKFLOWS_REPO,
+        help="The GitHub repo (in the format of owner/repo) to copy workflow "
+        f"templates from (default: {DEFAULT_WORKFLOWS_REPO}). "
+        "Pass an empty string to skip copying workflow templates.",
+    )
     parser.add_argument(
         "-v",
         "--verbose",
@@ -304,13 +374,13 @@ def main() -> int:
         create_github_repo(
             repo=args.repo,
             private=args.private,
-            language=args.language,
             is_owner_user=args.is_owner_user,
             dir_=args.dir,
             token=args.token,
             branches=args.branches,
             protocol=args.protocol,
             push=args.push,
+            workflows_repo=args.workflows_repo,
         )
     except Exception as e:
         logger.error("Failed to create GitHub repo: %s", e, exc_info=args.verbose)

{github_rest_api-0.49.0 → github_rest_api-0.51.1}/github_rest_api/scripts/github/release_on_github.py

@@ -1,19 +1,20 @@
-import argparse
-import getpass
-import os
 import re
 import sys
 from pathlib import Path
 
 from github_rest_api import Repository
 from github_rest_api.scripts.utils import (
+    RedactingArgumentParser,
     find_project_root,
     get_project_version,
     get_repo,
+    reject_github_token,
+    resolve_github_token,
 )
 
 
 def _get_release_tag(tag: str, root: Path, validate: bool = True) -> str:
+    reject_github_token("--tag", tag)
     tag = tag.strip()
     if not tag:
         tag = get_project_version(root).strip()
@@ -54,7 +55,14 @@ def release_on_github(
     :param token: GitHub token.
         If not specified, the GITHUB_TOKEN environment variable is used.
     :param validate: If True, validate the tag against semantic versioning format before creating the release.
+    :raises ValueError: If a value that looks like a GitHub token is specified
+        for anything other than the token itself.
     """
+    # A release is public, so a token mistyped into any of these would be
+    # published. -t is the tag on this script rather than the token, which
+    # makes that slip easy; --no-validate would otherwise let it through.
+    reject_github_token("--branch", branch)
+    reject_github_token("--notes", notes)
     root = find_project_root()
     if not root:
         raise FileNotFoundError("Could not find project root (no .git found).")
@@ -65,13 +73,7 @@ def release_on_github(
     if not repo_name:
         raise ValueError("Could not find GitHub repository name.")
 
-    token = token or os.getenv("GITHUB_TOKEN", "")
-    if not token:
-        token = getpass.getpass("Please enter your GitHub token: ")
-        if not token:
-            raise ValueError(
-                "No GitHub token is provided (via $GITHUB_TOKEN, --token or at prompt)."
-            )
+    token = resolve_github_token(token)
     repo = Repository(token=token, repo=repo_name)
     data = {
         "tag_name": tag,
@@ -87,7 +89,7 @@ def release_on_github(
 
 
 def parse_args(args=None, namespace=None):
-    parser = argparse.ArgumentParser(
+    parser = RedactingArgumentParser(
         description="Make a release of the project on GitHub."
     )
     parser.add_argument(
@@ -97,7 +99,9 @@ def parse_args(args=None, namespace=None):
         help="The branch (default to main) from which to make the release.",
     )
     parser.add_argument(
-        "-t",
+        # No short option on purpose: -t reads as the token to anyone used to
+        # the other scripts, and the tag becomes the public name of the
+        # release, so that slip would publish the token.
         "--tag",
         default="",
         help="The tag for the release. If not specified, the version from project configuration is used.",