fix(release): Add semver fields to changelog categories #1193
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This enables Craft's automatic version bump detection for changelog preview comments on PRs. Without these fields, the changelog preview shows 'None' for the semver impact even when PRs match categories like Features or Bug Fixes. The semver mappings follow conventional commit semantics: - Important Changes: minor - Breaking Changes: major - Features: minor - Bug Fixes: patch - Documentation: patch - Internal Changes: patch
Semver Impact of This PR🟢 Patch (bug fixes) 📋 Changelog PreviewThis is how your changes will appear in the changelog. Features
Bug Fixes
Internal Changes
🤖 This preview updates automatically when you update the PR. |
JPeer264
approved these changes
Jan 15, 2026
Member
JPeer264
left a comment
JPeer264
left a comment
There was a problem hiding this comment.
Looks great. It works for this PR, let's see if it does for others too
Member
Author
|
@JPeer264 once this is merged, you can edit the PR description, title, add-remove labels etc to trigger a re-run of the action to update the preview. This should work even when the PR is closed/merged. |
BYK
added a commit
to getsentry/craft
that referenced
this pull request
Jan 15, 2026
## Summary - Adds a warning when custom `.github/release.yml` has categories without `semver` fields - Updates documentation to clarify that `semver` is required for version bump detection - Adds tests for the warning behavior ## Background When investigating [getsentry/sentry-wizard#1191](getsentry/sentry-wizard#1191), the changelog preview showed "None" for semver impact despite the PR having a `feat:` prefix. The root cause was that sentry-wizard's custom `.github/release.yml` defined categories with `labels` and `commit_patterns` but no `semver` fields. Without `semver` fields, PRs are correctly categorized in the changelog but don't contribute to version bump detection. ## Changes ### Warning When Craft normalizes a custom release config, it now warns about categories missing `semver`: ``` The following changelog categories have no 'semver' field and won't contribute to version bump detection: "Features", "Bug Fixes". See: https://getsentry.github.io/craft/configuration/#auto-mode ``` The warning: - Only fires for custom configs (not default config) - Only fires once per Craft invocation (deduplicated) - Includes link to documentation ### Documentation - Added caution admonition in `configuration.md` explaining `semver` requirement - Added note in `github-actions.md` about version bump detection requirements ## Related - Fix for sentry-wizard: getsentry/sentry-wizard#1193
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
semverfields to all changelog categories in.github/release.ymlBackground
Craft uses the
semverfield in.github/release.ymlcategories to determine the suggested version bump for PRs. Without these fields, PRs are correctly categorized in the changelog but don't contribute to version bump detection.This was discovered when investigating why PR #1191 (a
feat:commit) showed "None" for semver impact in the changelog preview comment.Changes
Added
semvermappings following conventional commit semantics:minormajorminorpatchpatchpatch