Skip to main content
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:
  1. Go to integrations tab in the dashboard and click Connect under GitHub.
  2. Give the Palmier Bot access to the repositories you want to work on. You can always configure this later.
  3. PR Summaries and palmierbot mentions work out of the box with no configurations.
  4. Select automations will be pre-defined for easy toggle. Create, modify, or delete these to adapt to your workflow.
After installation, the GitHub integration button will display as “Configure” instead of “Disconnect”, always directing you to the GitHub app configuration page for easy management of repository access.
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: 
palmierbot [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: 
palmierbot review this PR
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: 
palmierbot --agent=agent123 analyze the code

palmierbot --agent agent123 fix the bug

palmierbot --agent="special agent" review code
Agent names with spaces must be enclosed in quotes when using the --agent flag.

​
How It Works

  1. Comment: Add a comment with palmierbot mention on any GitHub issue or pull request
  2. Processing: The bot parses your command and creates a new run with the specified agent
  3. Execution: The agent works in a sandbox environment with access to the repository context
  4. Response: The agent posts results back to the original GitHub issue or pull request
  5. 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:
  1. Code change overview with file-by-file breakdown
  2. Impact analysis of the changes
  3. Potential risks and considerations
  4. Testing recommendations
PR summaries are according to your teams template, designed to never replace any existing information already in the description and slot in seamlessly.

​
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

TriggerDescriptionActionsAdditional Parameters
Pull RequestTriggers when a pull request changes statusopened, synchronize (displayed as “updated”), mergedNone
IssueTriggers when issues are opened, closed, or labeledopened, closed, labeledlabel: Filter by specific label name
Workflow RunTriggers when GitHub Actions workflows completecompletedworkflow_run.conclusion: success/failure/cancelled - Filter by workflow result

​
Common Automation Examples

Automated Code Review

Trigger: Pull Request → opened Use Case: Automatically review newly opened 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

Merged PR Processing

Trigger: Pull Request → merged Use Case: Automatically update documentation or run post-merge tasks

Cross-Repository Documentation Updates

Trigger: Pull Request → merged Additional Repositories: company/docs, company/api-specs Use Case: Update documentation and API specifications when code changes are merged

​
Setting Up GitHub Automations

  1. Navigate to Automations: Go to your project dashboard and click “Automations”
  2. Create New Automation: Click “Create Automation” and select GitHub
  3. Select Repositories: Choose one or multiple repositories where the automation should be active
  4. Configure Trigger: Choose from the available GitHub triggers above
  5. Set Parameters: Add conditions to refine when the automation runs (parameter options are displayed with user-friendly labels)
  6. Select Additional Repositories: Optionally choose additional repositories that the agent should have access to during execution
  7. Select Agent: Choose which agent should execute when triggered
  8. 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. For additional help with GitHub and Slack integrations, you can find documentation links on the integrations page in your dashboard.