docs(custom-agents): add BYOI section and improve example agent#2568
docs(custom-agents): add BYOI section and improve example agent#2568rh-hemartin wants to merge 1 commit into
Conversation
PR Summary by QodoDocs: add BYOI (GitHub App identity) and improve custom agent example Description
Diagram
High-Level Assessment
Files changed (1)
|
7be4418 to
859acdd
Compare
Code Review by Qodo
1. Missing issues write permission
|
| ### Bringing your own identity | ||
|
|
||
| To make the agent comment as an application other than `github-actions` create a new application, | ||
| install it in your repository and generate a key for it. Then upload it alongside the app id | ||
| to your repo: | ||
|
|
||
| ```bash | ||
| gh secret set MY_AGENT_APP_PRIVATE_KEY --repo OWNER/REPO < path/to/private-key.pem | ||
| gh variable set MY_AGENT_APP_ID --repo OWNER/REPO --body "123456" | ||
| ``` | ||
|
|
||
| Next modify the workflow you create to run `fullsend run` to add a new step: | ||
|
|
||
| ```yaml | ||
| - name: Generate app token | ||
| id: app-token | ||
| uses: actions/create-github-app-token@v3 | ||
| with: | ||
| app-id: ${{ vars.MY_AGENT_APP_ID }} | ||
| private-key: ${{ secrets.MY_AGENT_APP_PRIVATE_KEY }} | ||
| repositories: ${{ github.event.repository.name }} | ||
| ``` | ||
|
|
||
| And then modify where the `GH_TOKEN` variable comes from: | ||
|
|
||
| ```yaml | ||
| - name: Run my-agent | ||
| env: | ||
| GH_TOKEN: ${{ steps.app-token.outputs.token }} | ||
| ... | ||
| ``` | ||
|
|
There was a problem hiding this comment.
1. Byoi steps not numbered 📜 Skill insight ✧ Quality
The new "Bringing your own identity" procedure is written as prose paragraphs rather than a numbered (ordered) list of steps. This violates the documentation requirement for procedural content to use numbered steps, which helps ensure clarity and consistent execution.
Agent Prompt
## Issue description
The "Bringing your own identity" section contains procedural instructions written as prose paragraphs. Procedures in guides must be expressed as numbered steps.
## Issue Context
This section instructs readers to create/install a GitHub App, store secrets/variables, add a token-generation step, and update `GH_TOKEN`. These are sequential actions and should be formatted as an ordered list.
## Fix Focus Areas
- docs/guides/user/building-custom-agents.md[476-507]
ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools
|
🤖 Finished Review · ❌ Failure · Started 3:30 PM UTC · Completed 3:42 PM UTC |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
ReviewFindingsHigh
Medium
Labels: PR modifies user-facing documentation under docs/guides/ Previous runReviewFindingsHigh
Labels: PR modifies user-facing documentation under docs/guides/ Previous runReviewFindingsHigh
Medium
Low
Labels: PR modifies only documentation under docs/guides/. Labels: PR modifies user-facing documentation under docs/guides/. Previous runReviewFindingsHigh
Labels: PR modifies user-facing documentation under docs/guides/ Previous run (2)ReviewFindingsHigh
Medium
Low
Labels: PR modifies only documentation under docs/guides/. |
859acdd to
fe90512
Compare
Site previewPreview: https://27dd0193-site.fullsend-ai.workers.dev Commit: |
|
🤖 Finished Review · ❌ Failure · Started 6:45 AM UTC · Completed 6:55 AM UTC |
fe90512 to
3466866
Compare
Add "Bringing your own identity" section explaining how to use a custom GitHub App instead of github-actions[bot]. Also improve the example agent with a concrete greeting use case and fix sandbox paths. Signed-off-by: Hector Martinez <hemartin@users.noreply.github.com> Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> Signed-off-by: Hector Martinez <hemartin@redhat.com>
3466866 to
d09a978
Compare
|
🤖 Finished Review · ❌ Failure · Started 6:34 AM UTC · Completed 6:50 AM UTC |
Summary
github-actions[bot]Closes #2554
Test plan
🤖 Generated with Claude Code