Skip to content

Correct semantic version example in "New Release" to conform with SemVer

lusitania requested to merge (removed):align-semver into master

What does this MR do and why?

In the "new release" dialogue (/-/releases/new) the following example is given:

Releases are based on Git tags. We recommend tags that use semantic versioning, for example v1.0.0, v2.1.0-pre.

This is contradicting with what SemVer has to say about this:

Is “v1.2.3” a semantic version?

No, “v1.2.3” is not a semantic version. However, prefixing a semantic version with a “v” is a common way (in English) to indicate it is a version number. Abbreviating “version” as “v” is often seen with version control. Example: git tag v1.2.3 -m "Release version 1.2.3", in which case “v1.2.3” is a tag name and the semantic version is “1.2.3”.

I suggest to strip the v from the example like so:

Now Changed
... for example v1.0.0, v2.1.0-pre. ... for example 1.0.0, 2.1.0-pre.

Closes #387954 (closed)

Screenshots or screen recordings

image

How to set up and validate locally

Numbered steps to set up and validate the change are strongly suggested.

No idea. Apply the change and reload?

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Edited by lusitania

Merge request reports