Skip to main content

Changelog Preview on Pull Requests

· 2 min read

Ever wondered if your changes will trigger a release? Now you can see exactly what will happen before merging! We've added a changelog preview that appears automatically on every pull request.

The Problem​

Contributors often had a hard time understanding:

  • Will my changes trigger a package release?
  • Which packages will be affected?
  • What will the changelog entry look like?

This uncertainty made it difficult to write good commit messages and understand the impact of changes.

The Solution​

A new GitHub workflow now runs on all pull requests and posts a comment showing:

  • Which packages will be released — See exactly which packages are affected
  • What type of release — Features, fixes, or dependency updates
  • The actual changelog entries — Preview the exact text that will appear in the CHANGELOG

Example Output​

# Changelog Preview

<details><summary>@ppb/the-wall-native</summary>

### 🚀 Features

- improve docs #NA (669db4417)

### 🧱 Updated Dependencies

- Updated @ppb/the-wall-design-tokens to 60.0.1
- Updated @ppb/the-wall-common to 47.1.6

</details>

How It Works​

The workflow:

  1. Runs yarn release --dry-run to simulate a release
  2. Parses the output to extract changelog entries
  3. Posts a formatted comment on the PR

This gives you immediate feedback on your commit messages and helps ensure changelogs are meaningful.

For more details, see PR #4745.