draft PR anchor

Signed-off-by: Effi-S <effi.szt@gmail.com>

Author: Effi-S

create_pr_from_issue.py

@@ -0,0 +1,172 @@
+#!/usr/bin/env python3
+"""Create a pull request from a GitHub issue using the ``ghapi`` package.
+
+The PR inherits the issue's body (prefixed with ``Fixes #<issue>`` so GitHub
+links and auto-closes the issue), its labels, and its milestone, and is assigned
+to the authenticated user.
+
+Requires the ``GITHUB_TOKEN`` (or ``GH_TOKEN``) environment variable.
+"""
+
+
+import argparse
+import asyncio
+import os
+from pathlib import Path
+import subprocess
+import sys
+
+from ghapi.all import GhApi
+
+DEFAULT_OWNER = "LFDT-Panurus"
+DEFAULT_REPO = "panurus"
+DEFAULT_BASE = "main"
+
+
+def subrun(*args, check=True, capture_output=True, text=True, **kwargs):
+    proc = subprocess.run(*args, check=check,
+                          capture_output=capture_output, text=text, **kwargs)
+
+    if proc.stderr:
+        print(proc.stderr)
+    if proc.stdout:
+        print(proc.stdout)
+
+    return proc
+
+
+def build_body(issue_body: str | None, issue_number: int) -> str:
+    """Prepend the ``Fixes #N`` linking line to the issue body."""
+    fixes = f"Fixes #{issue_number}"
+    body = (issue_body or "").strip()
+    return f"{fixes}\n\n{body}" if body else fixes
+
+
+def create_branch(name: str, root: Path | None = None, remote: str = "origin"):
+    subrun(["git", "branch", name],
+           cwd=root or Path.cwd(), check=True)
+    return name
+
+
+def add_dummy_commit(branch, root: Path | None = None):
+    subrun(["git", "switch", "-C", branch],
+           cwd=root or Path.cwd(), check=True)
+
+    subrun(["git", "commit", "--allow-empty", "--only", "-m",
+            "draft PR anchor", "-s", "--", ":/"],
+           cwd=root or Path.cwd(),
+           check=True,
+           capture_output=True,
+           text=True)
+
+    subrun(["git", "push", "origin", branch],
+           check=True, cwd=root or Path.cwd(),
+           capture_output=True, text=True)
+
+
+def set_upstream(name: str, root: Path | None = None, remote: str = "origin") -> str:
+
+    subrun(["git", "push", "--set-upstream", remote, name],
+           cwd=root or Path.cwd(), check=True)
+    return name
+
+
+def make_worktree(branch, directory_name, main_branch_name: str = "main", root: Path | None = None):
+
+    subrun(["git", "switch", "-C", main_branch_name],
+           cwd=root or Path.cwd(), check=True)
+    subrun(["git", "worktree", "add", directory_name, branch],
+           cwd=root or Path.cwd(), check=True)
+
+
+def parse_args() -> argparse.Namespace:
+    parser = argparse.ArgumentParser(description=__doc__)
+    parser.add_argument("issue", type=int,
+                        help="Issue number to base the PR on")
+    parser.add_argument("--owner", default=DEFAULT_OWNER,
+                        help=f"Repo owner (default: {DEFAULT_OWNER})")
+    parser.add_argument("--repo", default=DEFAULT_REPO,
+                        help=f"Repo name (default: {DEFAULT_REPO})")
+    parser.add_argument("--base", default=DEFAULT_BASE,
+                        help=f"Base branch to merge into (default: {DEFAULT_BASE})")
+    parser.add_argument("--title", default=None,
+                        help="PR title (default: the issue's title)")
+    parser.add_argument("--main-branch-name", default="main",
+                        help="PR title (default: the issue's title)")
+
+    return parser.parse_args()
+
+
+def _get_token():
+    return subprocess.run(["gh", "auth", "token"], capture_output=True, text=True).stdout.strip()
+
+
+def main(args) -> int:
+
+    token = os.environ.get("GITHUB_TOKEN") or os.environ.get(
+        "GH_TOKEN", _get_token())
+    if not token:
+        print("error: set GITHUB_TOKEN (or GH_TOKEN) with repo scope", file=sys.stderr)
+        return 1
+
+    api = GhApi(owner=args.owner, repo=args.repo, token=token)
+
+    me = asyncio.run(api.users.get_authenticated()).login
+
+    issue = asyncio.run(api.issues.get(
+        owner=args.owner, repo=args.repo, issue_number=args.issue))
+
+    labels = [lbl.name for lbl in (issue.labels or [])]
+    milestone = issue.milestone.number if issue.milestone else None
+    title = args.title or issue.title
+
+    branch = f"fix-{issue.number}"
+    branch = create_branch(f"fix-{issue.number}")
+    print("Created Branch:", branch)
+
+    print("Pushing Upstream branch:", branch)
+    set_upstream(branch)
+
+    print("Adding dummy commit to:", branch)
+    add_dummy_commit(branch)
+
+    # # Create the PR.
+    print("Creating Draft PR:")
+    pr = asyncio.run(api.pulls.create(
+        owner=args.owner,
+        repo=args.repo,
+        title=title,
+        head=branch,
+        base=args.base,
+        body=build_body(issue.body, args.issue),
+        draft=True,
+    ))
+
+    print(f"created PR #{pr.number}: {pr.html_url}")
+
+    print("creating worktree for PR:", pr.number)
+    make_worktree(
+        branch=branch, directory_name=f"fix-{pr.number}", main_branch_name=args.main_branch_name)
+
+    # Labels, milestone and assignee live on the issue view of the PR.
+    asyncio.run(api.issues.update(
+        owner=args.owner,
+        repo=args.repo,
+        issue_number=pr.number,
+        labels=labels,
+        milestone=milestone,
+        assignees=[me],
+    ))
+
+    print(f"assigned to @{me}")
+    if labels:
+        print(f"labels: {', '.join(labels)}")
+    if milestone is not None:
+        print(f"milestone: {issue.milestone.title} (#{milestone})")
+
+    return 0
+
+
+if __name__ == "__main__":
+    args = parse_args()
+    main(args)