Skip to content

Commit 1719be1

Browse files
committed
docs: Explain how prerelease settings works together
1 parent 6521637 commit 1719be1

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

docs/customizing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ version given a list of parsed commits.
4444
| `always-bump-minor` | Always bump minor version | |
4545
| `always-bump-major` | Always bump major version |
4646
| `service-pack` | Designed for Java backport fixes. Uses Maven's specification for service pack versions (e.g. 1.2.3-sp.1) |
47-
| `prerelease` | Bumping prerelease number (eg. 1.2.0-beta01 to 1.2.0-beta02) or if prerelease type is set, using that in the prerelease part (eg. 1.2.1 to 1.3.0-beta) |
47+
| `prerelease` | Bumping prerelease number (eg. 1.2.0-beta01 to 1.2.0-beta02) or if prerelease type is set, using that in the prerelease part (eg. 1.2.1 to 1.3.0-beta). Works together with the "prerelease" settings from [manifest-releaser](/docs/manifest-releaser.md) (see for more infos) - a prerelease version number will only be created, if the prerelease setting is set to true (false by default). |
4848

4949
### Adding additional versioning strategy types
5050

docs/manifest-releaser.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -197,6 +197,10 @@ defaults (those are documented in comments)
197197
// when `manifest-release` creates GitHub Releases per package, create
198198
// those as "Prerelease" releases that have pre-major or prerelease versions.
199199
// absence defaults to false and all versions are fully Published.
200+
// Works together with the "prerelease" versioning strategy, which creates a
201+
// prerelease-version (like 1.0.0-alpha.1) only if this setting is set to true.
202+
// This allows to create prerelease-versions on conditions (e.g. publish them only
203+
// on release-candidate branches)
200204
"prerelease": true
201205

202206
// Skip creating GitHub Releases

0 commit comments

Comments
 (0)