First release

What's New

Human Readable Post is a GitHub Action that turns git diffs into concise, team-friendly release
summaries using LLMs.

Features

• Multi-provider support — Choose between OpenAI, Anthropic, or Mistral as your LLM backend
• Three diff modes — Summarize a single commit (commit), a range of changes (ref), or the delta
  between two tags (tag)
• Multilingual summaries — Generate release notes in any language
• Custom prompts — Add extra instructions to tailor the summary to your team's needs (e.g., "Focus
  on user-facing changes")
• Diff truncation — Automatically trims large diffs to stay within token limits, configurable via
  max_diff_size
• Secure by default — API keys are masked in logs via core.setSecret

Quick Start

- uses: actions/checkout@v4
  with:
    fetch-depth: 2

- name: Generate release summary
  id: summary
  uses: waltervides/human-readable-post@v1
  with:
    provider: openai
    api_key: ${{ secrets.OPENAI_API_KEY }}

- name: Post to Slack
  uses: slackapi/slack-github-action@v2
  with:
    webhook: ${{ secrets.SLACK_WEBHOOK }}
    webhook-type: incoming-webhook
    payload: |
      text: "Deployed to production:\n${{ steps.summary.outputs.summary }}"

Default Models

┌───────────┬──────────────────────────┬───────────┐
│ Provider  │          Model           │ ~Cost/Run │
├───────────┼──────────────────────────┼───────────┤
│ OpenAI    │ gpt-4o-mini              │ $0.001    │
├───────────┼──────────────────────────┼───────────┤
│ Anthropic │ claude-sonnet-4-20250514 │ $0.002    │
├───────────┼──────────────────────────┼───────────┤
│ Mistral   │ mistral-small-latest     │ $0.001    │
└───────────┴──────────────────────────┴───────────┘

You can paste this into the `gh release create` command or the GitHub release UI.