GitHub
Integrate Palmier with GitHub to trigger runs, get auto PR summaries, reviews, and set up automations
Palmier integrates seamlessly with GitHub to automate your development workflow. You can trigger runs, get automatic pull request summaries, and set up powerful automations.
Configuration
To set up GitHub integration:
- Go to integrations tab in the dashboard and click Connect under GitHub.
- Give the Palmier Bot access to the repositories you want to work on. You can always configure this later.
- PR Summaries and palmierbot mentions work out of the box with no configurations.
- Select automations will be pre-defined for easy toggle. Create, modify, or delete these to adapt to your workflow.
The GitHub app requires repository access permissions to read issues, pull requests, and code.
Triggering Runs
You can trigger Palmier agents directly from GitHub by mentioning palmierbot
in comments on issues or pull requests. The bot will automatically create a run and link it back to the GitHub issue or pull request for easy tracking.
Basic Usage
Simply mention palmierbot
followed by your task description:
The agent will work in its own sandbox environment and you can monitor progress through the runs page. Runs triggered from GitHub will automatically include the issue context and any relevant files in the agent’s environment.
For example:
Uses the default code review agent to analyze the pull request.
Specifying Custom Agents
You can specify which agent to use with the --agent
flag:
Agent names with spaces must be enclosed in quotes when using the --agent
flag.
How It Works
- Comment: Add a comment with
palmierbot
mention on any GitHub issue or pull request - Processing: The bot parses your command and creates a new run with the specified agent
- Execution: The agent works in a sandbox environment with access to the repository context
- Response: The agent posts results back to the original GitHub issue or pull request
- Tracking: Monitor detailed progress through the Palmier dashboard
The bot automatically includes relevant context from the GitHub issue or PR, so you don’t need to repeat information that’s already available in the thread.
Auto PR Summaries
The GitHub bot automatically generates comprehensive pull request summaries. These summaries include:
- Code change overview with file-by-file breakdown
- Impact analysis of the changes
- Potential risks and considerations
- Testing recommendations
PR summaries are according to your teams template, designed to never replace any existing information already in the description and slot in seemlessly.
Automations
GitHub automations allow you to automatically trigger agents based on repository events. Set up automations to streamline code reviews, issue management, and workflow monitoring.
Available Triggers
Trigger | Description | Actions | Additional Parameters |
---|---|---|---|
Pull Request | Triggers when a pull request changes status | opened , synchronize (new commits pushed), closed , ready_for_review | pull_request.draft : true /false - Filter by draft status |
Pull Request Review | Triggers when a review is submitted on a pull request | submitted , edited , dismissed | review.state : approved /changes_requested /commented - Filter by review outcome |
Issue | Triggers when issues are opened, closed, or labeled | opened , closed , labeled | label : Filter by specific label name |
Workflow Run | Triggers when GitHub Actions workflows complete | completed | workflow_run.conclusion : success /failure /cancelled - Filter by workflow result |
Common Automation Examples
Automated Code Review
Trigger: Pull Request → opened
Condition: pull_request.draft
= false
Use Case: Automatically review non-draft pull requests
Issue Triage
Trigger: Issue → labeled
Condition: label
= bug
Use Case: Automatically assign bug reports to specific agents
CI/CD Monitoring
Trigger: Workflow Run → completed
Condition: workflow_run.conclusion
= failure
Use Case: Automatically investigate failed builds
Documentation Updates
Trigger: Pull Request → ready_for_review
Use Case: Check if documentation needs updating when code changes
Setting Up GitHub Automations
- Navigate to Automations: Go to your project dashboard and click “Automations”
- Create New Automation: Click “Create Automation” and select GitHub
- Configure Trigger: Choose from the available GitHub triggers above
- Set Parameters: Add conditions to refine when the automation runs
- Select Agent: Choose which agent should execute when triggered
- Test: Use a test repository to verify the automation works as expected
GitHub automations require the Palmier GitHub app to be installed in your repository with appropriate permissions.