PR Summary Action

AI-powered PR summaries to Slack using GitHub secrets for secure credential management.

Quick Setup

1. The action is already deployed at ionworks/pr-summary-action

No need to create your own repository - just use the public action with GitHub secrets.

2. Configure GitHub Secrets

The action uses GitHub secrets for secure credential storage. You need to add these secrets to any repository where you want to use the action:

Required Secrets:

• OPENAI_API_KEY: Your OpenAI API key (starts with sk-)
• SLACK_WEBHOOK: Your Slack webhook URL (starts with https://hooks.slack.com/)

How to add secrets:

1. Go to your repository Settings → Secrets and variables → Actions
2. Click "New repository secret"
3. Add each secret with the exact names above

3. Use Everywhere (One Line!)

In any repo, create .github/workflows/pr-summary.yml:

name: PR Summary
on:
  pull_request:
    types: [closed]
jobs:
  summary:
    if: github.event.pull_request.merged == true
    runs-on: ubuntu-latest
    steps:
      - uses: ionworks/pr-summary-action@v1.4
        with:
          openai_api_key: ${{ secrets.OPENAI_API_KEY }}
          slack_webhook: ${{ secrets.SLACK_WEBHOOK }}

Usage Options

Basic Usage

- uses: ionworks/pr-summary-action@v1.4
  with:
    openai_api_key: ${{ secrets.OPENAI_API_KEY }}
    slack_webhook: ${{ secrets.SLACK_WEBHOOK }}

With GPT-4

- uses: ionworks/pr-summary-action@v1.4
  with:
    openai_api_key: ${{ secrets.OPENAI_API_KEY }}
    slack_webhook: ${{ secrets.SLACK_WEBHOOK }}
    model: "gpt-4"

Different Slack Channel

To post to a different channel, create a separate webhook for that channel in Slack and use it:

- uses: ionworks/pr-summary-action@v1.4
  with:
    openai_api_key: ${{ secrets.OPENAI_API_KEY }}
    slack_webhook: ${{ secrets.SLACK_WEBHOOK_FRONTEND }} # Different webhook for #frontend

Full Configuration

- uses: ionworks/pr-summary-action@v1.4
  with:
    openai_api_key: ${{ secrets.OPENAI_API_KEY }}
    slack_webhook: ${{ secrets.SLACK_WEBHOOK }}
    model: "gpt-4"

How It Works

1. Triggers: When a PR is merged
2. Analyzes: Gets PR title, description, diff, and author information
3. Summarizes: Uses OpenAI to generate technical and marketing summaries with author context
4. Posts: Sends formatted message to Slack with PR author, branch info, and link

Features

• ✅ Secure credential management - Uses GitHub secrets for secure storage
• ✅ One-line setup - Works across all repos instantly
• ✅ AI-powered - Technical and marketing summaries with author context
• ✅ Rich Slack integration - Formatted messages with PR author, branch info, and buttons
• ✅ Comprehensive debugging - Full GitHub event logging for troubleshooting
• ✅ Author information - Includes PR author and merge details in summaries
• ✅ Customizable - Choose AI model and different webhooks for different channels

Security

The action uses GitHub secrets passed as inputs for secure credential storage. Each repository needs to have the required secrets configured in its settings. This ensures credentials are:

• Encrypted and secure
• Repository-specific
• Not exposed in logs or code
• Managed through GitHub's built-in security features
• Explicitly passed (no hidden dependencies)

Why Use Inputs Instead of Direct Secret Access?

✅ Explicit: Clear what secrets the action needs ✅ Flexible: Repositories can use different secret names ✅ Reusable: Works across different organizations ✅ Secure: Follows GitHub Actions best practices ✅ Transparent: Workflow files show exactly what's being passed

Pro Tips

• Use GPT-4 for critical repositories that need high-quality summaries
• Create different webhooks for different teams/projects (each webhook targets a specific channel)
• Add repo-specific logic in summarize.py using os.environ['GITHUB_REPOSITORY']
• Monitor your OpenAI API usage to manage costs

Requirements

• GitHub repository with configured secrets
• OpenAI API key
• Slack webhook URL