docs: clarify the Agent picker and its effect on PR authorship - #436
Conversation
The New schedule form's Agent setting determines which identity a scheduled agent runs as, which in turn determines who GitHub records as the author of any PR the agent opens. Quick run (the default) runs as the schedule's creator, so PRs are authored by that person rather than by the Oz by Warp GitHub App. That consequence was undocumented, and the quickstart also mislabeled the Skills field as Agent, making the real setting easy to miss. - Correct the quickstart steps: Agent and Skills are separate fields - Add "Who the schedule runs as" explaining both options and when to pick a cloud agent - Note in the CLI reference that neither schedule create nor update can set Agent, so CLI-created schedules run as their creator - Spell out the authorship consequence on the Agent picker bullet Co-Authored-By: Oz <oz-agent@warp.dev>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
I'm starting a first review of this pull request. You can view the conversation on Warp. I completed the review and no human review was requested for this pull request. Comment Powered by Oz |
![oz-for-oss[bot]](https://avatars.githubusercontent.com/in/3450139?s=60&v=4){kind=small}
There was a problem hiding this comment.
Overview
This PR clarifies how the Agent picker affects scheduled run identity and GitHub PR authorship, and it corrects the quickstart’s separation of Agent and Skills fields. I found no correctness, security, link, or spec-alignment issues that should block the docs change.
Concerns
- Non-blocking: the new copy continues adding variable-backed Oz product names and URLs (
Oz CLI,Oz web app, andoz.warp.dev) as literals in existing pages. The PR description calls this out as a consistency choice; consider a follow-up to importVARSin these pages so future rename updates propagate.
Verdict
Found: 0 critical, 0 important, 1 suggestions
Approve with nits
Comment /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).
Powered by Oz
| 5. Under **Frequency**, choose a preset or enter a custom cron expression (e.g., `0 9 * * 1` for every Monday at 9 AM). | ||
| 6. Click **Create schedule**. | ||
| 2. Enter a schedule name, e.g. `Weekly bug report triage`. | ||
| 3. Under **Agent**, choose the identity the schedule runs as. **Quick run** is the default and runs every execution as you. See [Who the schedule runs as](#who-the-schedule-runs-as) before you decide. |
There was a problem hiding this comment.
- Agent is nested under the "General" section of the new schedule pane. I had to expand that section to see Agent, Skills, "Add additional prompt", etc.
- "Who the schedule runs as" reads a bit awkward. Are there any other options?
| 3. Under **Agent**, choose the identity the schedule runs as. **Quick run** is the default and runs every execution as you. See [Who the schedule runs as](#who-the-schedule-runs-as) before you decide. | |
| 3. Under **Agent**, choose the identity that will run the schedule. **Quick run** is the default and runs every execution as you. See [Who the schedule runs as](#who-the-schedule-runs-as) before you decide. |
There was a problem hiding this comment.
Done. Step 3 now says to expand General first, and the section is renamed to Run identity and pull request authorship (both inbound cross-page links updated to the new anchor). Quick run and a cloud agent are the only two options the picker offers, so the section covers both.
| ::: | ||
|
|
||
| :::caution | ||
| `oz schedule create` has no flag for the **Agent** setting, so a schedule created with the CLI runs as the user who created it and opens pull requests under that person's GitHub account. To run a schedule as a [cloud agent](/platform/agents/) — so pull requests are authored by the **Oz by Warp** GitHub App — set **Agent** on the schedule in the [Oz web app](https://oz.warp.dev/schedules) after creating it. See [Who the schedule runs as](/platform/triggers/scheduled-agents-quickstart/#who-the-schedule-runs-as). |
There was a problem hiding this comment.
- first note: can we revise this note for brevity? It's a bit wordy.
- any instances of "Oz web app" should be replaced with the variable
| `oz schedule create` has no flag for the **Agent** setting, so a schedule created with the CLI runs as the user who created it and opens pull requests under that person's GitHub account. To run a schedule as a [cloud agent](/platform/agents/) — so pull requests are authored by the **Oz by Warp** GitHub App — set **Agent** on the schedule in the [Oz web app](https://oz.warp.dev/schedules) after creating it. See [Who the schedule runs as](/platform/triggers/scheduled-agents-quickstart/#who-the-schedule-runs-as). | |
| `oz schedule create` has no flag for the **Agent** setting, so a schedule created with the CLI runs as the user who created it and opens pull requests under that person's GitHub account. To run a schedule as a [cloud agent](/platform/agents/) (so pull requests are authored by the **Oz by Warp** GitHub App) set **Agent** on the schedule in the [Oz web app](https://oz.warp.dev/schedules) after creating it. See [Who the schedule runs as](/platform/triggers/scheduled-agents-quickstart/#who-the-schedule-runs-as). |
There was a problem hiding this comment.
Trimmed the caution to two sentences and switched the web app name and URL to {VARS.WEB_APP} / {VARS.WEB_APP_URL}, using the existing <a href={...}> pattern from github.mdx. Both files now import VARS. Scoped the conversion to the lines this PR touches to keep the diff tight.
| * The environment used for execution. | ||
| * The model, MCP, and host configuration used for future runs. | ||
|
|
||
| The **Agent** setting is not among them — like `oz schedule create`, `oz schedule update` has no flag for it. Change it in the [Oz web app](https://oz.warp.dev/schedules). |
There was a problem hiding this comment.
Odd wording. Let's rephrase to not use "is not among them". Be more direct, like, "The Agent setting can't be adjusted with this command. Change it in the web app."
There was a problem hiding this comment.
Rephrased to: "The Agent setting can't be changed with this command. Change it from the Schedules page in the Oz web app."
- Note that Agent and Skills are nested under the General section of the New schedule form and must be expanded. - Rename the quickstart section to "Run identity and pull request authorship" and update both inbound cross-page links. - Tighten the oz schedule create caution and rephrase the oz schedule update note directly. - Use VARS.WEB_APP and VARS.WEB_APP_URL on the lines this PR touches. Co-Authored-By: Warp Agent <agent@warp.dev>
Co-Authored-By: Warp Agent <agent@warp.dev>
2 participants
Summary
The Agent setting on a schedule determines which identity the run executes as, which in turn determines who GitHub records as the author of any PR the agent opens. Quick run — the default — runs as the person who created the schedule, so PRs are authored by that person rather than by the Oz by Warp GitHub App.
That consequence wasn't documented anywhere. The quickstart also mislabeled the Skills field as Agent, which made the real setting easy to miss entirely.
This surfaced when six scheduled docs agents were found opening PRs under an individual's GitHub account. The underlying cause was configuration (unpinned schedules), but the docs gap is what let it go unnoticed.
Changes
platform/triggers/scheduled-agents-quickstart.mdxplatform/triggers/scheduled-agents.mdxoz schedule createhas no flag for Agent, so CLI-created schedules run as their creator.oz schedule updatecan't change it either.platform/agents.mdxVerification
npm run buildpasses.run-identity-and-pull-request-authorshipanchor is present in the built HTML, and both inbound cross-page links resolve to it.check_links.pyreports 0 broken links.style_lint.py --changedreports 27 issues across the three files, all but three of them pre-existing. See below.Notes for review
UNRECOGNIZED-TERMfalse positives. They flag bolded names that aren't in the glossary: Skills (a real field name in the New schedule form) and Oz by Warp ×2 (bolded the same way inteam-access-billing-and-identity.mdx).HARDCODED-VARissues. Every "Oz web app," "oz.warp.dev," and "Oz CLI" reference on a line this PR touches now uses{VARS.WEB_APP},{VARS.WEB_APP_URL}, or{VARS.WARP_AGENT_CLI}, following the<a href={...}>pattern already used inplatform/integrations/github.mdx. The remainingHARDCODED-VARhits are all on untouched lines; converting these pages wholesale is a worthwhile separate cleanup.This PR was generated with Oz.