Integrations
ReleaseRay is an open-source GitHub Action in active development. There is no release yet; the first usable version will be v1.0.0. This page describes where it is designed to publish release notes, and what is planned after that. See Getting Started for the current status.
Overview
Planned for v1.0.0:
- GitHub Releases - Release notes written into the GitHub Release body
- CHANGELOG.md - Release notes added to a
CHANGELOG.mdfile in your repository - Job summary - Notes shown on the workflow run's summary page
- Workspace files - Per-persona Markdown files and a
notes.jsonfile, for later steps in your own workflow
Planned for v1.1:
- Slack
- Microsoft Teams
- Intercom Help Center
Everything runs in your own workflow, on your own runner. Nothing is sent anywhere except GitHub and the LLM provider you configure. The maintainer runs no service, so there is nowhere else for your webhook URLs or keys to go.
GitHub Releases Integration
Write release notes into the body of a GitHub Release.
No extra setup planned. The workflow's built-in GITHUB_TOKEN is enough by default.
How It Will Work
- Your workflow runs ReleaseRay for a release tag
- ReleaseRay builds the range from the previous SemVer tag that is an ancestor of the release tag (see the Versioning Guide)
- It generates notes for each persona
- It writes the notes into the GitHub Release body
Re-runs are designed not to duplicate notes, to make no LLM call when nothing has changed, and to keep edits a person made. Internal-persona notes do not go to public surfaces such as the GitHub Release by default.
CHANGELOG.md Integration
Add release notes to a CHANGELOG.md file in your repository.
How It Will Work
- ReleaseRay reads your existing
CHANGELOG.md(or starts one if it doesn't exist) - Inserts the new release at the top, following the Keep a Changelog format
- Leaves earlier entries and your own edits in place, and does not add the same release twice on a re-run
Slack Integration (Planned for v1.1)
Slack output is planned for v1.1. It is not part of v1.0.0.
When it ships, it is expected to post to a channel through a Slack Incoming Webhook. If you want to be ready, this is how you create one on the Slack side.
Step 1: Create a Slack App
- Go to Slack API Apps
- Click "Create New App"
- Choose "From scratch"
- Name your app (e.g., "Release Notes") and select your workspace
- Click "Create App"
Step 2: Enable Incoming Webhooks
- In the left sidebar, click "Incoming Webhooks"
- Toggle "Activate Incoming Webhooks" to ON
- Click "Add New Webhook to Workspace"
- Select the channel where you want release notes (e.g.,
#releases) - Click "Allow"
Step 3: Copy the Webhook URL
You'll see a webhook URL like:
https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXX
Important: Keep this URL private. Anyone with this URL can post to your Slack channel. Do not commit it to your repository.
How ReleaseRay will take the URL will be documented when the Slack output ships.
Microsoft Teams Integration (Planned for v1.1)
Microsoft Teams output is planned for v1.1. It is not part of v1.0.0.
Setup steps for the Teams side will be published when the output ships.
Intercom Help Center Integration (Planned for v1.1)
Publishing release notes as Intercom Help Center articles is planned for v1.1. It is not part of v1.0.0.
Setup steps, including the Intercom access token and collection it will need, will be published when the output ships.
Privacy & Security
- Your runner, your keys. ReleaseRay runs inside your own GitHub Actions workflow.
- No ReleaseRay service. The maintainer runs no server, so your webhook URLs, keys, code and notes are never sent to one.
- Only two destinations by default. Data goes to GitHub and to the LLM provider you configure. When the v1.1 outputs ship, data will also go to the Slack, Teams or Intercom destination you set up yourself.
- Internal notes stay internal. Internal-persona notes do not go to public surfaces by default.
Best Practices
Webhook Security
✅ Keep URLs private - Don't commit webhooks to git
✅ Rotate regularly - Update webhooks every 6-12 months
✅ Limit permissions - Use dedicated channels for notifications
Message Quality
✅ Choose the right persona - Engineers for #engineering, Customers for #announcements
✅ Review before publishing - Check the notes read well before they reach customers
✅ Use multiple channels - Publish different personas to different places
Need Help?
- Getting started: Status and requirements
- Questions and bug reports: GitHub Issues
- Security issues: Private vulnerability reporting