Skip to content

Support release workspaces in the changelog preview workflow #941

Closed

Description

@sentry-junior

The reusable changelog-preview.yml workflow doesn't support release workspaces. In a repo that defines workspaces in .craft.yml, there is currently no way to get a working changelog preview. Verified with Craft 3.3.0 on getsentry/objectstore#737, which moves the repo to three workspaces: clients/python, clients/rust and objectstore-server.

Current behavior

  • No way to select a workspace. The workflow has no workspace input, and a reusable workflow can't receive CRAFT_WORKSPACE from the calling workflow. craft changelog --pr N then fails with This configuration defines workspaces; select one with --workspace <name>. The step swallows the error (|| echo '{"changelog":"",...}') and reports "No changelog entries will be generated from this PR" with no bump, on every PR.
  • The current PR is always included. Even with a workspace selected (CRAFT_WORKSPACE=clients/python craft changelog --pr 690), generateChangelogWithHighlight adds the PR to the preview without applying the workspace path filtering that getChangesSince uses for merged commits (owned paths, includePaths, unownedPaths). So a server-only PR is previewed as a minor bump in the Python client's changelog.
  • One comment marker and one status context. Each run uses the <!-- craft-changelog-preview --> comment and the Changelog Preview / Semver Impact status. Calling the workflow once per workspace means the runs overwrite each other, and the output never says which workspace's changelog it shows.

Requirements

  • A PR is previewed only in the workspaces it would actually be listed in, using the same path rules as the release changelog (owned paths, includePaths, unownedPaths), rather than a separate paths: filter in the calling workflow.
  • One preview per PR, a single comment or status, that names each workspace the PR lands in, together with its bump. The entry text is the same in every workspace, so it doesn't need to be repeated per workspace.

via @lcian.

--

View Junior Session [Sentry]

Activity

  1. self-assigned this
    on Oct 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions