Datasets:
roanbrasil
/
devops-gitops-corpus

Dataset card Data Studio Files
xet
 Community
1
text
stringlengths
0
59.1k
- **Account Label**: Optional label for organization or user
- **Repository Owner**: Optional default repository owner
7. Click **Authorize with GitHub** to complete the authorization flow
**Required OAuth Scopes:**
VoltOps requests the following scopes during authorization:
- `repo` - Access repositories
- `admin:repo_hook` - Manage webhooks
- `user` - Access user profile
- `read:user` - Read user profile data
:::note[OAuth Redirect URL]
The redirect URL is provided by VoltOps Console and routes the OAuth callback to the correct endpoint. You must copy this URL exactly as shown in the console, including the protocol (https://) and path.
:::
:::tip[When to Use OAuth]
Use OAuth 2.0 for team environments, production deployments, or credential rotation requirements. Personal Access Tokens are simpler for individual development.
:::
## Trigger Configuration
After configuring credentials, you need to specify which repository and events to monitor.
<video controls loop muted playsInline style={{width: '100%', height: 'auto'}}>
<source src="https://cdn.voltagent.dev/console/trigger/github/configuration.mp4" type="video/mp4" />
Your browser does not support the video tag.
</video>
<br/>
<br/>
Select the credential you created and configure the repository settings:
### Owner
Enter the GitHub repository owner (username or organization name).
### Repository
Enter the repository name within the owner's account.
:::tip
VoltOps listens for events from this repository and configures the GitHub webhook automatically.
:::
### Branch Filter (Optional)
Restrict **push events** to a specific branch. Leave blank to allow all branches.
:::note
The branch filter only applies to **push events**. Other events (pull requests, issues, releases, etc.) are not affected by this filter.
:::
## Event Types
GitHub triggers support all GitHub webhook events. VoltOps configures the webhook when you create a trigger. No manual webhook setup is required.
When creating a trigger in VoltOps Console, you can select which events to listen for. The trigger will only execute when the selected events occur.
GitHub webhook events include:
<GitHubEventTypes />
## Add Target to Activate Binding
After configuring your GitHub trigger, you need to add a target (agent or workflow) to activate the binding. For detailed instructions on:
- Adding targets to activate bindings
- Mapping trigger data to agent inputs
- Testing triggers with sample payloads
- Deploying and monitoring triggers
See the [Add Target to Activate Binding section](https://voltagent.dev/automations-docs/triggers/overviewusage/#step-3-add-target-to-activate-binding). These steps are the same for all trigger providers.
## GitHub Enterprise Support
VoltOps supports GitHub Enterprise Server deployments. When creating your credential, configure the **GitHub server** field to point to your GitHub Enterprise API endpoint.
GitHub Enterprise API endpoints typically follow the format `https://[hostname]/api/v3`. The default is `https://api.github.com` for GitHub.com.
## Payload Structure
VoltOps wraps GitHub webhook payloads in a standardized format. The payload structure includes metadata about the event and the complete GitHub webhook data.
### Wrapper Format
All GitHub events delivered by VoltOps follow this structure:
```json
{
"event": "push", // The GitHub event type (push, pull_request, issues, etc.)
"deliveryId": "e7edfcf0-bfa8-11f0-81d5-e3c9c0d87c3c", // Unique identifier for this webhook delivery
"repository": {
// Simplified repository information
"id": 123456,
"name": "repo-name",
"fullName": "owner/repo-name",