Skip to content

feat(changelog): Include labelled PRs from outside a workspace - #980

Merged
BYK merged 1 commit into
masterfrom
feat/changelog-include-labels
Nov 18, 2026
Merged

BYK merged 1 commit into
masterfrom
feat/changelog-include-labels

Conversation

@sentry-junior

@sentry-junior sentry-junior Bot commented Nov 18, 2026

Copy link
Copy Markdown
Contributor

A workspace changelog only lists commits that touch the workspace's files. That breaks for a package generated from something outside it. getsentry/sentry's @sentry/api is built from the API spec, which any backend change can alter, and its automatic spec releases (api@2.9.0 through api@2.13.0) say "No documented changes" because the commits that changed the spec are filtered out.

changelog.includeLabels lists PR labels that put a commit in the workspace's changelog wherever its files are. Workspace placeholders expand in it, so a glob key can give each package its own label:

workspaces:
  static/packages/*:
    changelog:
      policy: auto
      includeLabels:
        - 'changelog: {{packageName}}'

The same rule applies to the PR preview. Like includePaths and unownedPaths, it's only allowed with release workspaces. With it set, Craft also looks up the PRs of commits outside the workspace so it can read their labels, which means more GitHub lookups. Without it, behavior is unchanged.

via @BYK.

--

View Session [Sentry]

A workspace changelog only lists commits that touch the workspace's
files. A package generated from something outside it, such as
@sentry/api from Sentry's API spec, then gets releases whose notes say
"No documented changes": the backend commits that changed the spec are
filtered out.

changelog.includeLabels lists PR labels that put a commit in the
workspace's changelog wherever its files are. Workspace placeholders
expand in it, so a glob key can give each package its own label. With
the setting, commits outside the workspace are looked up on GitHub too,
so their labels can be read.

Co-Authored-By: BYK <126780+BYK@users.noreply.github.com>
@github-actions

github-actions Bot commented Nov 18, 2026 •

Copy link
Copy Markdown
Contributor
PR Preview Action v1.8.1
Preview removed because the pull request was closed.
2026-11-18 10:53 UTC

@sentry-junior
sentry-junior Bot marked this pull request as ready for review November 18, 2026 10:40
@sentry-junior
sentry-junior Bot requested a review from BYK November 18, 2026 10:40
@BYK
BYK merged commit a107fdd into master Nov 18, 2026
29 checks passed
@BYK
BYK deleted the feat/changelog-include-labels branch November 18, 2026 10:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant