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
| None of the above | Patch (when `AutoPatching: true`) | — |
208
208
209
-
**Prerelease versions:** Adding a `Prerelease` label to the PR produces a prerelease tag (e.g., `1.2.3-preview0001`). The format is controlled by `IncrementalPrerelease` (sequential numbering) or `DatePrereleaseFormat` (.NET DateTime format string).
209
+
**Prerelease versions:** With `AutoPatching: true`, adding the default `release:pre-release` label to the PR produces a
210
+
patch prerelease tag (e.g., `1.2.3-preview0001`). When AutoPatching is disabled, also apply one configured bump label.
211
+
The format is controlled by `IncrementalPrerelease` (sequential numbering) or `DatePrereleaseFormat` (.NET DateTime
212
+
format string).
213
+
214
+
All five label mappings remain configurable in `.github/PSModule.yml`.
210
215
211
216
An important direct default-branch push and a default-branch manual dispatch always resolve to `Patch`, regardless of
212
217
`AutoPatching`. A push that exactly matches a merged pull request uses that PR's version label instead.
Copy file name to clipboardExpand all lines: docs/content/reference/scenario-matrix.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,7 +28,7 @@ execution; other pages link here rather than repeating it.
28
28
29
29
-\* Only when `Publish.Site.Skip` is `false`.
30
30
- † Requires an important change and all required build, test, and coverage gates to succeed. An open PR also requires
31
-
the `Prerelease` label. A default-branch push uses labels and notes only when its SHA exactly matches a merged pull
31
+
the configured prerelease label (`release:pre-release` by default) and a resolved bump. A default-branch push uses labels and notes only when its SHA exactly matches a merged pull
32
32
request; otherwise it releases a Patch version with commit-based notes. A default-branch manual run is also a Patch
33
33
release with commit-based notes.
34
34
- ‡ Cleans up prerelease versions and tags for the closed pull request when `Publish.Module.AutoCleanup` is enabled;
Copy file name to clipboardExpand all lines: docs/content/reference/settings.md
+10-8Lines changed: 10 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -65,10 +65,11 @@ For worked examples, see [Configuring the pipeline](../guides/configuring-the-pi
65
65
|`Publish.Module.IncrementalPrerelease`|`Boolean`| Use incremental prerelease versioning |`true`|
66
66
|`Publish.Module.DatePrereleaseFormat`|`String`| Format for date-based prerelease (uses [.NET DateTime format strings](https://learn.microsoft.com/dotnet/standard/base-types/standard-date-and-time-format-strings)) |`''`|
67
67
|`Publish.Module.VersionPrefix`|`String`| Prefix for version tags |`'v'`|
68
-
|`Publish.Module.MajorLabels`|`String`| Labels indicating a major version bump |`'major, breaking'`|
69
-
|`Publish.Module.MinorLabels`|`String`| Labels indicating a minor version bump |`'minor, feature'`|
70
-
|`Publish.Module.PatchLabels`|`String`| Labels indicating a patch version bump |`'patch, fix'`|
71
-
|`Publish.Module.IgnoreLabels`|`String`| Labels indicating no release |`'NoRelease'`|
68
+
|`Publish.Module.MajorLabels`|`String`| Labels indicating a major version bump |`'release:major'`|
69
+
|`Publish.Module.MinorLabels`|`String`| Labels indicating a minor version bump |`'release:minor'`|
70
+
|`Publish.Module.PatchLabels`|`String`| Labels indicating a patch version bump |`'release:patch'`|
71
+
|`Publish.Module.IgnoreLabels`|`String`| Labels indicating no release |`'release:skip'`|
72
+
|`Publish.Module.PrereleaseLabels`|`String`| Labels indicating a prerelease |`'release:pre-release'`|
72
73
|`Publish.Module.UsePRTitleAsReleaseName`|`Boolean`| Use the PR title as the GitHub release name instead of version string |`false`|
73
74
|`Publish.Module.UsePRBodyAsReleaseNotes`|`Boolean`| Use the PR body as the release notes content |`true`|
74
75
|`Publish.Module.UsePRTitleAsNotesHeading`|`Boolean`| Prepend PR title as H1 heading with PR number link before the body |`true`|
0 commit comments