Skip to content

update documentation#138

Open
derekmisler wants to merge 1 commit intodocker:mainfrom
derekmisler:update-documentation
Open

update documentation#138
derekmisler wants to merge 1 commit intodocker:mainfrom
derekmisler:update-documentation

Conversation

@derekmisler
Copy link
Copy Markdown
Contributor

@derekmisler derekmisler commented Apr 17, 2026

Related Issues

Closes: https://github.com/docker/gordon/issues/401

Summary

Reorganizes and improves the review-pr/README.md to make the documentation clearer and more accurate, particularly around fork PR handling, secret management, and built-in security guarantees.

Key changes

  • Relocated Fork PR Auto-Review from the bottom of the doc into the main setup section — makes the two-workflow (workflow_run) pattern easier to discover right after basic setup
  • Added fork protection callout — explains that the reusable workflow has built-in defense-in-depth (fork skipping, OIDC fail-safe, org membership verification), so users should not add redundant if: guards that can break /review and feedback capture
  • Removed standalone "Required Secrets" section — the ANTHROPIC_API_KEY / OPENAI_API_KEY / GOOGLE_API_KEY table was misleading; API keys are only needed when using the composite action directly
  • Updated API key footnote to clarify that credentials come from OIDC in the reusable workflow and keys are only required for the composite action
  • Minor fixes: secrets.GITHUB_TOKENgithub.token, improved contents: read permission comment

Tip

Comment /review to trigger the PR Reviewer agent for automated feedback.
Comment /describe to generate a PR description.

@derekmisler derekmisler self-assigned this Apr 17, 2026
@derekmisler derekmisler requested a review from a team April 17, 2026 13:58
@derekmisler derekmisler marked this pull request as ready for review April 17, 2026 13:58
@derekmisler derekmisler enabled auto-merge (squash) April 17, 2026 13:58
Copy link
Copy Markdown
Contributor

@docker-agent docker-agent bot left a comment

Choose a reason for hiding this comment

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

Assessment: 🟡 NEEDS ATTENTION

Two issues found in the new YAML example for fork PR auto-review.

Comment thread review-pr/README.md
Comment thread review-pr/README.md Outdated
Signed-off-by: Derek Misler <derek.misler@docker.com>
@derekmisler derekmisler force-pushed the update-documentation branch from 6a4f536 to d4d7971 Compare April 17, 2026 14:13
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.

1 participant