Version Extraction Algorithm

The Starlight Plugin Show Latest Version plugin fetches the latest release of your package as specified in the source configuration option.

Regex Pattern

The Starlight Plugin Show Latest Version plugin uses a regex pattern to extract the version (and prerelease). The default pattern is:

/^(?:v|[^0-9\s]*@)?v?(?<version>[0-9]+\.[0-9]+\.[0-9]+)(?:-(?<prerelease>[0-9A-Za-z]+(?:\.[0-9A-Za-z]+)*))?(?![-.]|[^-\w.])$/;

You can override the pattern using the regexPattern configuration option.

Supported tag_names

The tag_name can be one of the following formats which will produce these badges:

• 1.2.3 → v1.2.3
• 10.20.30 → v10.20.30
• v1.2.3 → v1.2.3
• release@1.2.3 → v1.2.3
• name@v1.2.3 → v1.2.3
• package-name@1.2.3 → v1.2.3
• feature/branch@1.2.3 → v1.2.3
• 1.2.3-rc.1 → v1.2.3-rc.1
• name@1.2.3-beta.2 → v1.2.3-beta.2
• v1.2.3-alpha.34 → v1.2.3-alpha.34
• package-name@1.2.3-rc.1 → v1.2.3-rc.1
• 1.2.3-alpha → v1.2.3-alpha
• 1.2.3-beta → v1.2.3-beta
• 1.2.3-rc → v1.2.3-rc
• 1.2.3-feature.test → v1.2.3-feature.test
• 1.2.3-long.complex.prerelease.tag → v1.2.3-long.complex.prerelease.tag

Invalid tag_names

Here are examples of tag_name formats which would not be supported by the default version extraction algorithm:

• 1.2 → no semantic versioning because it is missing the third number
• v1.2 → no semantic versioning because it is missing the third number
• 1.2. → invalid version format, incomplete
• v1.2. → invalid version format, incomplete
• 1.2.3.4 → too many version segments
• 1.2.3. → invalid version format, trailing dot
• v1.2.3.4 → too many version segments
• 1.2.3- → invalid prerelease format
• 1.2.3-.rc → invalid prerelease format
• 1.2.3-rc. → invalid prerelease format
• 1.2.3--rc → invalid prerelease format
• random-text → non-version string
• ‎ → empty string
• 123 → non-version string
• v1.2.3-special!char → invalid version format with special characters
• 1.2.3-pre release → invalid version format due to space