docs: clarify GitHub repo access patterns for cloud agents (flexible environments) - #390
Draft
seemeroland wants to merge 1 commit into
Draft
docs: clarify GitHub repo access patterns for cloud agents (flexible environments)#390seemeroland wants to merge 1 commit into
seemeroland wants to merge 1 commit into
Conversation
Documents the two GitHub repo access patterns for cloud environments: 1. Oz GitHub App + agent API key (SA-scoped runs) 2. GitHub PAT as a Warp-managed secret Includes: - New guide: guides/agent-workflows/github-repo-access-for-cloud-agents.mdx - Comparison table of both patterns - Step-by-step setup for each approach - Flexible base environment pattern (no pre-configured repos) - Clear callout about GitHub App token limitation for repo-less environments - environments.mdx: Add crosslinks to new guide in prerequisite and common issues sections - team-access-billing-and-identity.mdx: Add note about flexible environment limitation in Team GitHub authorization section - sidebar.ts: Register new guide in Agent workflows sidebar section Addresses Gametime enterprise feedback: clarifies that flexible base environments (where agent handles cloning) require Pattern 2 (PAT secret) because the GitHub App token is not generated when no repos are configured. Co-Authored-By: Oz <oz-agent@warp.dev>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Addresses enterprise customer feedback (Gametime, REMOTE-2341) about discoverability of GitHub repo access patterns for Oz cloud environments.
Problem: Gametime wanted to set up a flexible base environment where the agent handles all cloning and setup dynamically. They asked whether to use the Oz GitHub integration or add a GitHub token secret. The answer wasn't clearly documented.
What's documented now:
Key clarification added: The GitHub App token is only generated when at least one repo is declared in the environment configuration. For flexible base environments (no repos configured, agent clones on the fly), Pattern 2 (PAT secret) is required.
Changes
New guide
guides/agent-workflows/github-repo-access-for-cloud-agents.mdx:platform/environments.mdx: Added crosslinks to the new guide in the "Before you begin" prerequisites and in the "Common issues" section for GitHub authorization errors.platform/team-access-billing-and-identity.mdx: Added a callout in the "How this relates to environments" section explaining the flexible environment limitation and pointing to Pattern 2 (PAT secret) as the solution.src/sidebar.ts: Registered the new guide in the Agent workflows sidebar section.Conversation: https://staging.warp.dev/conversation/0432ec75-0db2-43bd-99c4-ec337684e356
Run: https://oz.staging.warp.dev/runs/019fa4f6-9ebf-7845-8267-d3f74a8b342b
This PR was generated with Oz.