PR feedback

Author: b0lle

.gitignore

@@ -8,15 +8,3 @@ __pycache__
 package-lock.json
 debug.sh
 .idea/
-
-# Devenv
-.devenv*
-devenv.local.nix
-devenv.lock
-devenv.nix
-devenv.yaml
-.envrc
-
-# direnv
-.direnv
-

docs/customizing.md

@@ -44,7 +44,7 @@ version given a list of parsed commits.
 | `always-bump-minor` | Always bump minor version |                                                                                                                                                                    |
 | `always-bump-major` | Always bump major version |                                                                                  
 | `service-pack`      | Designed for Java backport fixes. Uses Maven's specification for service pack versions (e.g. 1.2.3-sp.1)    |
-| `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). |
+| `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`. Default: `false`. For more information, see [Manifest Driven release-please](manifest-releaser.md). |
 
 ### Adding additional versioning strategy types
 

docs/manifest-releaser.md

@@ -199,8 +199,9 @@ defaults (those are documented in comments)
   // absence defaults to false and all versions are fully Published.
   // Works together with the "prerelease" versioning strategy, which creates a 
   // prerelease-version (like 1.0.0-alpha.1) only if this setting is set to true.
-  // This allows to create prerelease-versions on conditions (e.g. publish them only
-  // on release-candidate branches)
+  // This allows to create prerelease-versions while working on pre-release branches - 
+  // once the development is done and the branch gets merged to main/release-branch
+  // a full-release can be done.
   "prerelease": true
 
   // Skip creating GitHub Releases

test/versioning-strategies/prerelease.ts

@@ -132,7 +132,9 @@ describe('PrereleaseVersioningStrategy', () => {
     describe('without prerelease property', () => {
       const expectedBumps: Record<string, string> = {
         '1.2.3': '2.0.0',
-        '1.0.0-beta01': '1.0.0',
+        // beta01 indicates that there had to be a breaking change with prerelease=true.
+        // e.g. coong from 0.1.0 -> feat! (prerelease=True) -> 1.0.0-beta01 -> prerelease=False -> 1.0.0
+        '1.0.0-beta01': '1.0.0', 
         '1.1.0-beta01': '2.0.0',
         '1.3.0-alpha': '2.0.0',
         '1.3.0-alpha.1': '2.0.0',