You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
fix(changelog): Warn when custom release.yml lacks semver fields
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
Fixesgetsentry/sentry-wizard#1191 investigation
|**Reusable Workflow**| Quick setup, standard release flow | Low - runs as a complete job |
17
+
|**Composite Action**| Custom workflows, pre/post steps| High - composable with other steps |
18
18
19
19
### Option 1: Reusable Workflow (Recommended)
20
20
@@ -39,27 +39,27 @@ jobs:
39
39
40
40
#### Workflow Inputs
41
41
42
-
| Input | Description | Default |
43
-
|-------|-------------|---------|
44
-
| `version` | Version to release. Can be a semver string (e.g., "1.2.3"), a bump type ("major", "minor", "patch"), or "auto" for automatic detection. | Uses `versioning.policy` from config |
| `version` | Version to release. Can be a semver string (e.g., "1.2.3"), a bump type ("major", "minor", "patch"), or "auto" for automatic detection. | Uses `versioning.policy` from config |
6. **Posts a comment** - Creates or updates a comment on the PR with the changelog preview
172
172
7. **Auto-updates** - The comment is automatically updated when you update the PR (push commits, edit title/description, or change labels)
173
173
174
+
:::note
175
+
The version bump suggestion requires categories in your `.github/release.yml` to have
176
+
`semver`fields defined. Without them, the suggested bump will show as "None".
177
+
See [Auto Mode configuration](/configuration/#auto-mode) for details.
178
+
:::
179
+
174
180
### Example Comment
175
181
176
182
The workflow posts a comment like this:
@@ -205,6 +211,7 @@ Entries from this PR are highlighted with a left border (blockquote style).
205
211
### PR Trigger Types
206
212
207
213
The workflow supports these PR event types:
214
+
208
215
- `opened`- When a PR is created
209
216
- `synchronize`- When new commits are pushed
210
217
- `reopened`- When a closed PR is reopened
@@ -216,13 +223,16 @@ The workflow supports these PR event types:
216
223
The workflow requires specific permissions and secrets to function correctly:
217
224
218
225
**Permissions** (required):
226
+
219
227
- `contents: read` - Allows the workflow to checkout your repository and read git history for changelog generation
220
228
- `pull-requests: write` - Allows the workflow to post and update comments on pull requests
221
229
222
230
**Secrets**:
231
+
223
232
- `secrets: inherit` - Passes your repository's `GITHUB_TOKEN` to the workflow, ensuring it has access to your repository (especially important for private repositories)
224
233
225
234
**Repository Setup**:
235
+
226
236
- The repository should have a git history with tags for the changelog to be meaningful
227
237
228
238
:::note[Why are these permissions needed?]
@@ -248,13 +258,13 @@ You can configure labels to exclude PRs from the changelog. In your `.craft.yml`
248
258
```yaml
249
259
changelog:
250
260
categories:
251
-
- title: "New Features ✨"
252
-
labels: ["feature", "enhancement"]
253
-
- title: "Bug Fixes 🐛"
254
-
labels: ["bug", "fix"]
261
+
- title: 'New Features ✨'
262
+
labels: ['feature', 'enhancement']
263
+
- title: 'Bug Fixes 🐛'
264
+
labels: ['bug', 'fix']
255
265
exclude:
256
-
labels: ["skip-changelog", "dependencies"]
257
-
authors: ["dependabot[bot]", "renovate[bot]"]
266
+
labels: ['skip-changelog', 'dependencies']
267
+
authors: ['dependabot[bot]', 'renovate[bot]']
258
268
```
259
269
260
270
PRs with the `skip-changelog` label or from excluded authors will not appear in the changelog.
0 commit comments