Relizy

Appearance

PR Comments ​

Relizy can automatically post a comment on your pull request or merge request with release information after running relizy release. This keeps your team informed about what was released directly in the PR/MR where the work happened.

How It Works ​

When you run the release command (or use the standalone pr-comment command), Relizy will:

  1. 🔍 Detect the current PR/MR from the git branch
  2. 📝 Build a comment with release information
  3. 💬 Post it as a comment on the PR/MR

PR comment posting is part of the release workflow and runs after:

  • Version bumping
  • Changelog generation
  • Git commit and tag creation
  • Provider release (GitHub/GitLab)
  • npm publishing
  • Social media posting

Comment Statuses ​

Relizy generates different comments depending on the release outcome:

✅ Success ​

When the release succeeds, the comment includes:

  • Version transition (e.g., 1.0.0 → 1.1.0)
  • Git tags created
  • Dist-tag used
  • Date and branch
  • Package table with version transitions
  • Installation commands for each package manager

Example:

markdown
## 🚀 Release Published

| Field    | Value         |
| -------- | ------------- |
| Version  | 1.0.0 → 1.1.0 |
| Tags     | v1.1.0        |
| Dist-tag | latest        |
| Date     | 2026-02-22    |
| Branch   | main          |

### 📦 Packages

| Package      | Version       |
| ------------ | ------------- |
| @myorg/core  | 1.0.0 → 1.1.0 |
| @myorg/utils | 1.0.0 → 1.1.0 |

### 📥 Install

pnpm add @myorg/core@1.1.0

⏭️ No Release ​

When no qualifying commits exist (nothing to release):

markdown
## ⏭️ No Release

No new version was published from this branch.
No qualifying commits were found since the last release.

❌ Failed ​

When the release fails:

markdown
## ❌ Release Failed

The release process encountered an error:

Error: Failed to publish to npm

Comment Modes ​

Relizy supports two comment modes:

Append Mode (Default) ​

In append mode, Relizy creates a new comment each time. This is useful when you want a full history of release attempts on the PR.

ts
import { defineConfig } from 'relizy'

export default defineConfig({
  prComment: {
    mode: 'append',
  },
})

Update Mode ​

In update mode, Relizy finds and updates an existing comment instead of creating a new one. It uses a hidden HTML marker (<!-- relizy-pr-comment -->) to identify its previous comment.

If no previous comment is found, it creates a new one.

ts
import { defineConfig } from 'relizy'

export default defineConfig({
  prComment: {
    mode: 'update',
  },
})

TIP

Use update mode in CI/CD to keep your PR clean — only one Relizy comment will ever appear on the PR.

Supported Providers ​

ProviderAPIEnterprise/Self-hosted
GitHubREST API v3✅ Supported
GitLabAPI v4✅ Supported

Relizy automatically detects the provider from your git remote URL.

PR Detection ​

Relizy auto-detects the PR/MR number from the current git branch by querying the provider's API. You can also manually specify the PR number:

bash
# Auto-detect PR from current branch
relizy pr-comment

# Manually specify PR number
relizy pr-comment --pr-number 42

TIP

In CI/CD environments like GitHub Actions, you can pass the PR number from the environment:

bash
relizy release --patch --yes --pr-number ${{ github.event.pull_request.number }}

Standalone vs Release Integration ​

As Part of Release Workflow ​

PR commenting is enabled by default in the release workflow. Just run:

bash
relizy release --patch

To disable it:

bash
relizy release --patch --no-pr-comment

Or in your config:

ts
import { defineConfig } from 'relizy'

export default defineConfig({
  release: {
    prComment: false,
  },
})

Standalone Command ​

You can also post PR comments independently:

bash
# Post a PR comment about the current state
relizy pr-comment

# Preview without posting
relizy pr-comment --dry-run

Authentication ​

PR comments use the same tokens as provider releases:

GitHub ​

bash
# Any of these (checked in order):
export RELIZY_GITHUB_TOKEN="your-token"
export GITHUB_TOKEN="your-token"
export GH_TOKEN="your-token"

Required token scope: pull-requests: write (or repo for classic tokens).

GitLab ​

bash
# Any of these (checked in order):
export RELIZY_GITLAB_TOKEN="your-token"
export GITLAB_TOKEN="your-token"
export GITLAB_API_TOKEN="your-token"
export CI_JOB_TOKEN="your-token"  # Available in GitLab CI

Dry Run ​

Preview the comment without posting:

bash
relizy pr-comment --dry-run

This will:

  • Detect the PR/MR
  • Generate the comment body
  • Log what would be posted
  • NOT make any API calls

Quick Setup ​

No additional configuration is needed! PR commenting works out of the box when a GitHub/GitLab token is available and the command is run from a branch with an open PR/MR.

ts
import { defineConfig } from 'relizy'

export default defineConfig({
  // PR comment is enabled by default in release workflow
  // Customize if needed:
  prComment: {
    mode: 'append', // or 'update'
  },
})

Learn More ​

Released under the MIT License.

Made by LouisMazel with ❤️