Skip to content

Document attaching screenshots to pull requests, and checking new endpoints for per-row queries - #1474

Merged
mihow merged 2 commits into
mainfrom
docs/pr-screenshots-gh-attach
Oct 6, 2026
Merged

mihow merged 2 commits into
mainfrom
docs/pr-screenshots-gh-attach

Conversation

@mihow

@mihow mihow commented Oct 5, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

Two additions to the agent guide (CLAUDE.md, which links to .agents/AGENTS.md), both learned while finishing #1471.

Screenshots in pull requests have so far been hosted on a branch, a fork, or a storage bucket and then linked, which leaves PRs depending on something that can be deleted. GitHub CLI 2.99 added an --attach flag that uploads images straight into a PR or issue body, the same way dragging an image into the web editor does. The guide now describes that workflow so future PRs from people and agents use it. It was first used on #1471.

The endpoint checklist also gains a line about a query trap that review caught in #1471: every serializer built on DefaultSerializer works out the user's permissions separately for each row, so a new list or dropdown serializer can quietly cost several queries per row. The new line says how to avoid it and how to test for it. The fix for all serializers at once is tracked in #1475.

List of Changes

  1. The guide explains how to attach screenshots with gh pr edit --body-file ... --attach ..., including that relative image references in the body are rewritten in place to the uploaded files, and how to check the result.
  2. It asks for each screenshot to be checked for real project, station, or job names before attaching, because the repository is public and an uploaded image stays reachable by URL.
  3. The "new or changed API endpoint" checklist gains a per-row permissions item: skip permissions in serializers that do not need them, cache them per request where they are needed, and test that the query count is the same at two list sizes with cachalot disabled.

No code changes.

🤖 Generated with Claude Code

https://claude.ai/code/session_01HEbXiX2mZk7efVmdgSNcN7

GitHub CLI 2.99 and later uploads images referenced in a PR body and rewrites
the references in place, so screenshots no longer need hosting on a branch,
fork or bucket. Includes the check for production data in screenshots, since
the repository is public.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01HEbXiX2mZk7efVmdgSNcN7
Copilot AI balanced review requested due to automatic review settings October 5, 2026 23:31
@netlify

netlify Bot commented Oct 5, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for antenna-preview canceled.

Name Link
🔨 Latest commit c9b1057
🔍 Latest deploy log https://app.netlify.com/projects/antenna-preview/deploys/6ac43920027a33000818abea

@netlify

netlify Bot commented Oct 5, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for antenna-ssec canceled.

Name Link
🔨 Latest commit c9b1057
🔍 Latest deploy log https://app.netlify.com/projects/antenna-ssec/deploys/6ac43920f9e8e1000839ec12

@coderabbitai

coderabbitai Bot commented Oct 5, 2026 •

Copy link
Copy Markdown
Contributor

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 17 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

Learn how review limits work.

Review configuration:

⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 91df13cb-f0bc-4c27-9c1f-c430094ee67f
📥 Commits

Reviewing files that changed from the base of the PR and between 2304348 and c9b1057.

📒 Files selected for processing (1)
  • .agents/AGENTS.md
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟢 Approval recommended

The documentation is clear, consistent, and complete.

Review effort: Balanced
Findings: None

What changed in this PR

Documents the durable, privacy-conscious workflow for attaching UI screenshots to pull requests.

Changes:

  • Adds gh --attach instructions and verification steps.
  • Warns against exposing production identifiers.
File Description
.agents/​AGENTS.md Adds screenshot attachment guidance.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

…p ci]

DefaultSerializer resolves object permissions for every row, so a new list or
dropdown serializer can cost several queries per row without anyone noticing,
as the job choices did in #1471. The endpoint checklist now says how to opt out
or cache per request, and how to test for it. The systemic fix is #1475.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01HEbXiX2mZk7efVmdgSNcN7
@mihow mihow changed the title Document how to attach screenshots to pull requests with the GitHub CLI Document attaching screenshots to pull requests, and checking new endpoints for per-row queries Oct 5, 2026
@mihow
mihow merged commit aecbd8c into main Oct 6, 2026
5 checks passed
@mihow
mihow deleted the docs/pr-screenshots-gh-attach branch October 6, 2026 00:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants