github/penpot
1
0
Fork 0
mirror of https://github.com/penpot/penpot.git synced 2026-09-24 12:56:15 +00:00
Code Issues Packages Projects Releases Wiki Activity
penpot/.serena/memories/scripts/gh.md
Andrey Antukh d6abd2fecd 🔧 Add explicit issue-to-PR linking command 
Add a link-issue command that creates GitHub's Development reference
and verifies both sides. Keep Closes in descriptions for context, but
make the API link the source of truth, including for merged PRs.

Add tests for successful links, missing verification, output, and
failures. Update the PR workflow memories and create-pr skill to use
the command.

AI-assisted-by: space-bunny-free
2026-09-23 18:53:25 +02:00

3.6 KiB
Raw Blame History

GitHub operations helper

scripts/gh.py is a multi-purpose CLI for querying the penpot/penpot GitHub repository via GraphQL and REST APIs through the authenticated gh CLI.

When to use

  • Listing issues in a milestone (for changelog generation).
  • Finding issues with no milestone.
  • Fetching PR details by number or by milestone.
  • Comparing milestone issues against CHANGES.md to find missing entries.
  • Explicitly linking a GitHub issue to a pull request and verifying both sides.
  • Listing or inspecting GitHub Security Advisories (GHSA).

Prerequisites

  • gh CLI authenticated (gh auth status).
  • Python 3.8+.

Subcommands

issues

List issues in a milestone, with filtering by state, labels, and project status.

# Closed issues in a milestone (default)
python3 scripts/gh.py issues "2.16.0"

# All issues in a milestone
python3 scripts/gh.py issues "2.16.0" --state all

# Issues with no milestone
python3 scripts/gh.py issues none
python3 scripts/gh.py issues none --state open

# Filter by label (include only)
python3 scripts/gh.py issues "2.16.0" --label "bug"
python3 scripts/gh.py issues "2.16.0" --label "bug,regression"

# Exclude by label
python3 scripts/gh.py issues "2.16.0" --exclude "release blocker,no changelog"

# Show only issues NOT yet in CHANGES.md
python3 scripts/gh.py issues "2.16.0" --compare CHANGES.md

Default filters (override with flags):

  • Issues with type "Task" are excluded (--include-tasks to keep them).
  • Issues with "Rejected" project status are excluded (--include-rejected to keep them).

Output: JSON array to stdout; progress to stderr.

prs

Fetch PR details by number or by milestone.

# Fetch specific PRs
python3 scripts/gh.py prs 9179 9204 9311

# Read PR numbers from file
python3 scripts/gh.py prs --file prs.txt

# Read PR numbers from stdin
cat prs.txt | python3 scripts/gh.py prs --stdin

# All PRs in a milestone (default: merged only)
python3 scripts/gh.py prs --milestone "2.16.0"

# All PRs in a milestone (all states)
python3 scripts/gh.py prs --milestone "2.16.0" --state all

Output: JSON array to stdout; progress to stderr.

link-issue

Explicitly assign a GitHub issue to a pull request and verify the relationship from both sides:

python3 scripts/gh.py link-issue <ISSUE_NUMBER> <PR_NUMBER>
# Short alias: python3 scripts/gh.py link <ISSUE_NUMBER> <PR_NUMBER>

The command resolves both node IDs, calls addCloseIssueReferences, and checks the issue's manually linked PRs and the PR's closing issue references. It is safe to rerun, works for merged PRs, and does not close an issue retroactively. JSON goes to stdout; progress and errors go to stderr; a missing link exits non-zero.

advisories

List or inspect GitHub Security Advisories for the repository.

# List all advisories (summary view)
python3 scripts/gh.py advisories

# Filter by severity
python3 scripts/gh.py advisories --severity critical

# Filter by state
python3 scripts/gh.py advisories --state triage

# Get full detail for a single advisory
python3 scripts/gh.py advisories GHSA-xvj6-fh9w-gjw7

Summary output fields: ghsa_id, cve_id, severity, cvss_score, state, summary, cwes, published_at, closed_at, url.

Detail output (single advisory) adds: description, vulnerabilities (package, version ranges), credits, timestamps.

Output: JSON to stdout; progress to stderr.

Key principles

  • All output is JSON — pipe into jq or other tools for further processing.
  • Milestone lookup is by exact title match.
  • issues subcommand auto-paginates (100 items per page).
  • prs subcommand batches PR number lookups (50 per GraphQL query).