Skip to content

Conversation

@BYK
Copy link
Member

@BYK BYK commented 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, 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

@BYK BYK force-pushed the fix/warn-missing-semver-in-release-config branch from 6087839 to 02b30bd Compare January 15, 2026 14:29
@github-actions
Copy link
Contributor

github-actions bot commented Jan 15, 2026

Semver Impact of This PR

🟢 Patch (bug fixes)

📋 Changelog Preview

This is how your changes will appear in the changelog.
Entries from this PR are highlighted with a left border (blockquote style).


New Features ✨

  • (github) Add working-directory input to changelog-preview workflow by BYK in #717

Bug Fixes 🐛

Changelog

  • Warn when custom release.yml lacks semver fields by BYK in #720
  • Collapse previews by default by BYK in #718

Documentation 📚

  • Document CRAFT_NEW_VERSION and CRAFT_OLD_VERSION for pre-release command by BYK in #719

🤖 This preview updates automatically when you update the PR.

@github-actions
Copy link
Contributor

github-actions bot commented Jan 15, 2026

PR Preview Action v1.8.0
Preview removed because the pull request was closed.
2026-01-15 15:20 UTC

@BYK BYK force-pushed the fix/warn-missing-semver-in-release-config branch from 02b30bd to 6dea984 Compare January 15, 2026 14:31
@BYK BYK force-pushed the fix/warn-missing-semver-in-release-config branch from 6dea984 to 94033c3 Compare January 15, 2026 14:34
@BYK BYK force-pushed the fix/warn-missing-semver-in-release-config branch 2 times, most recently from 0f071a2 to 0ea420c Compare January 15, 2026 14:36
@BYK BYK force-pushed the fix/warn-missing-semver-in-release-config branch from 0ea420c to 7396626 Compare January 15, 2026 14:37
When a custom .github/release.yml is used without semver fields on categories,
PRs appear in the changelog but don't contribute to version bump detection.
This causes the changelog preview to show "None" for semver impact.

Changes:
- Add warning when normalizing custom configs with missing semver fields
- Update docs to clarify semver field requirement for version detection
- Add tests for the warning behavior

Fixes getsentry/sentry-wizard#1191 investigation
@BYK BYK force-pushed the fix/warn-missing-semver-in-release-config branch from 7396626 to 595e180 Compare January 15, 2026 14:43
@BYK BYK marked this pull request as ready for review January 15, 2026 15:17
@BYK BYK enabled auto-merge (squash) January 15, 2026 15:17
@BYK BYK merged commit 9069249 into master Jan 15, 2026
17 checks passed
@BYK BYK deleted the fix/warn-missing-semver-in-release-config branch January 15, 2026 15:19
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.

3 participants