From 8af9b54311446159c75f4fc544b9fa57c4e0181c Mon Sep 17 00:00:00 2001 From: Dylan Anthony Date: Wed, 31 May 2023 15:23:20 -0600 Subject: [PATCH] docs: Document pre-release subset. Closes #359 --- docs/src/config/step/BumpVersion.md | 8 ++++++-- docs/src/config/step/PrepareRelease.md | 3 ++- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/src/config/step/BumpVersion.md b/docs/src/config/step/BumpVersion.md index 5c28d143..c74d6d4f 100644 --- a/docs/src/config/step/BumpVersion.md +++ b/docs/src/config/step/BumpVersion.md @@ -8,7 +8,7 @@ It may be easier to select the appropriate version automatically using [conventi ## Fields -1. `rule`: The [Semantic Versioning] rule to use. +1. `rule`: The Semantic Versioning [rule](#rules) to use. 2. `label`: Only applicable to `Pre` `rule`. The pre-release label to use. ## Examples @@ -69,6 +69,10 @@ Increment the Patch component of the semantic version and reset all lesser compo Increment the pre-release component of the semantic version or add it if missing. You must also provide a `label` parameter to this rule which will determine the pre-release string used. For example, running this rule with the `label` "rc" would change "1.2.3-rc.4" to "1.2.3-rc.5" or "1.2.3" to "1.2.4-rc.0". +```admonish warn +Only a very specific pre-release format is supported—that is `MAJOR.MINOR.PATCH-LABEL.NUMBER`. For example, `1.2.3-rc.4` is supported, but `1.2.3-rc4` is not. `LABEL` must be specified via config or the `--prerelease-label` option in the CLI. `NUMBER` starts at 0 and increments each time the rule is applied. +``` + ### Release Remove the pre-release component of the semantic version (e.g. 1.2.3-rc.4 -> 1.2.3). @@ -85,7 +89,7 @@ Remove the pre-release component of the semantic version (e.g. 1.2.3-rc.4 -> 1.2 This step will fail if any of the following are true: -1. A malformed version string is found while attempting to bump. +1. A malformed version string is found while attempting to bump. Note that only a subset of [pre-release version formats](#pre) are supported. 2. No [package] is defined missing or invalid. [semantic versioning]: https://semver.org diff --git a/docs/src/config/step/PrepareRelease.md b/docs/src/config/step/PrepareRelease.md index 61d26985..97e53698 100644 --- a/docs/src/config/step/PrepareRelease.md +++ b/docs/src/config/step/PrepareRelease.md @@ -12,7 +12,8 @@ The last "version tag" is used as the starting point to read commits—that's th ## Limitations -The CHANGELOG format is pretty strict. Only three sections will be added to the new version, `### Breaking Changes` for anything that conventional commits have marked as breaking, `### Fixes` for anything called `fix:`, and `### Features` for anything with `feat: `. Any other commits (conventional or not) will be left out. +- The CHANGELOG format is pretty strict. Only three sections will be added to the new version, `### Breaking Changes` for anything that conventional commits have marked as breaking, `### Fixes` for anything called `fix:`, and `### Features` for anything with `feat: `. Any other commits (conventional or not) will be left out. +- Knope uses a simpler subset of semantic versioning which you can read about in [BumpVersion] ## Commit Scopes