A GitHub Action that reads your PR diff and writes a Conventional Commits summary — so you don't have to. Supports OpenAI and Anthropic.
- uses: ofershap/ai-commit-msg@v1 with: api-key: ${{ secrets.OPENAI_API_KEY }} # → Posts a summary comment on every PR, updates on new pushes
Supports OpenAI and Anthropic. Custom prompts, language selection, and model override.
- Zero install — runs as a GitHub Action, no CLI or npm package needed
- Two providers — OpenAI (GPT-4o-mini) and Anthropic (Claude Sonnet) out of the box
- Conventional Commits — generates
type(scope): descriptionformat by default - PR comments — posts a summary comment on PRs, updates on new pushes
- Customizable — custom prompts, language, model selection
name: AI Commit Message on: pull_request: types: [opened, synchronize] jobs: ai-summary: runs-on: ubuntu-latest permissions: pull-requests: write steps: - uses: actions/checkout@v4 - uses: ofershap/ai-commit-msg@v1 with: api-key: ${{ secrets.OPENAI_API_KEY }}
That's it. Every PR gets an AI-generated summary comment.
| Input | Required | Default | Description |
|---|---|---|---|
api-key |
Yes | — | API key for OpenAI or Anthropic |
provider |
No | openai |
openai or anthropic |
model |
No | auto | Model name (default: gpt-4o-mini / claude-sonnet-4-20250514) |
mode |
No | pr-comment |
pr-comment or commit-summary |
max-diff-length |
No | 10000 |
Max diff chars sent to AI (truncated if longer) |
language |
No | english |
Language for the generated message |
custom-prompt |
No | — | Extra instructions appended to the prompt |
github-token |
No | GITHUB_TOKEN |
Token for posting PR comments |
| Output | Description |
|---|---|
message |
The generated commit message |
- uses: ofershap/ai-commit-msg@v1 with: provider: anthropic api-key: ${{ secrets.ANTHROPIC_API_KEY }}
- uses: ofershap/ai-commit-msg@v1 id: ai with: api-key: ${{ secrets.OPENAI_API_KEY }} mode: commit-summary - run: echo "${{ steps.ai.outputs.message }}"
- uses: ofershap/ai-commit-msg@v1 with: api-key: ${{ secrets.OPENAI_API_KEY }} custom-prompt: "Use emoji prefixes. Keep it under 50 chars."
- uses: ofershap/ai-commit-msg@v1 with: api-key: ${{ secrets.OPENAI_API_KEY }} language: hebrew
- Reads the PR diff (or push commit diffs)
- Sends the diff to OpenAI/Anthropic with a Conventional Commits prompt
- Posts the generated message as a PR comment (or outputs it)
- On subsequent pushes, updates the existing comment instead of creating a new one
README built with README Builder