Getting Started with ReleaseRay

ReleaseRay is an open-source GitHub Action, released under the MIT license. It is designed to turn the pull requests and issues merged between two tags into release notes written for different readers: your engineers, your internal customer-facing team, and your customers.

It runs in your own GitHub Actions workflow, on your own runner, with your own LLM key.


Status

ReleaseRay is in active development. There is no release yet. The first usable version will be v1.0.0, and until it ships there is nothing to add to a workflow, so this page has no install steps.

To hear when v1.0.0 is out, watch or star the repository on GitHub. Setup instructions will be published here with the release.


How It Will Work

  1. You trigger it on a release. A step in your own workflow runs ReleaseRay when you publish a release or push a version tag.
  2. It works out the range. The range runs from the previous SemVer tag that is an ancestor of the release tag, to the release tag.
  3. It gathers the changes. It reads tags, commits and PR numbers from the checkout, and PR and issue content from the GitHub REST API, then classifies the changes into sections.
  4. It writes one set of notes per persona. Using your LLM key, it writes a version for each persona: Engineer, Internal and Customer by default. See Personas.
  5. It publishes. The notes go to the GitHub Release body, CHANGELOG.md, the job summary, and workspace files (per-persona Markdown and notes.json).

Re-runs are designed not to duplicate notes. When nothing has changed, a re-run makes no LLM call and keeps any edits a person made. Internal-persona notes do not go to public surfaces by default.

Slack, Microsoft Teams and Intercom outputs are planned for v1.1. See Integrations.


What You Will Need

  • A GitHub repository with SemVer tags (v1.2.0, v1.3.0, and so on). See the Versioning Guide.
  • An LLM API key stored as an Actions secret, for one of:
    • OpenAI, or an OpenAI-compatible endpoint
    • AWS Bedrock
  • No extra GitHub token by default. The workflow's built-in GITHUB_TOKEN is enough.

An Anthropic adapter is planned for v1.1.

Defaults will work without a config file. When you want to change personas, sections, tone or outputs, you will do it in .releaseray/config.yml in your repository. The format will be published with v1.0.0.


What It Costs

ReleaseRay itself is free. You pay:

  • Your LLM provider, for the tokens each run uses.
  • GitHub, for Actions minutes on private repositories. Public repositories get Actions minutes free.

Your Data

Nothing goes anywhere except GitHub and the LLM provider you configure. The maintainer runs no service, so there is no ReleaseRay server that sees your code, pull requests or notes.


Get Help

Related docs:

We value your privacy

We use cookies to enhance your experience. Essential cookies are required for the site to function. You can choose to accept all cookies or manage your preferences.