Skip to content

Commit f3a8a01

Browse files
committed
Fix semver version regex escaping of .
This means that a version like v0x1e1 were accepted as valid semver versions. Now this version is not considered a semver version anymore. Signed-off-by: Leandro Lucarella <[email protected]>
1 parent 2481ff7 commit f3a8a01

File tree

3 files changed

+6
-4
lines changed

3 files changed

+6
-4
lines changed

RELEASE_NOTES.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ But you might still need to adapt your code:
3131
## Bug Fixes
3232

3333
- Fixed wrong comparison for `mike` versions when versions were equal.
34+
- Fixed version regex escaping of `.`. This means that a version like v0x1e1 were accepted as valid semver versions. Now this version is not considered a semver version anymore.
3435

3536
### Cookiecutter template
3637

src/frequenz/repo/config/mkdocs/mike.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -136,10 +136,10 @@ def build_mike_version(repo_info: RepoVersionInfo) -> MikeVersionInfo:
136136
)
137137

138138

139-
_is_version_re = re.compile(r"^v(\d+).(\d+)(-dev|-pre)?$")
140-
_stable_to_semver_re = re.compile(r"^v(\d+).(\d+)$")
141-
_pre_to_semver_re = re.compile(r"^v(\d+).(\d+)-pre$")
142-
_dev_to_semver_re = re.compile(r"^v(\d+).(\d+)-dev$")
139+
_is_version_re = re.compile(r"^v(\d+)\.(\d+)(?:-dev|-pre)?$")
140+
_stable_to_semver_re = re.compile(r"^v(\d+)\.(\d+)$")
141+
_pre_to_semver_re = re.compile(r"^v(\d+)\.(\d+)-pre$")
142+
_dev_to_semver_re = re.compile(r"^v(\d+)\.(\d+)-dev$")
143143

144144

145145
def _to_fake_sortable_semver(version: str) -> str:

tests/mkdocs/test_mike.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -267,6 +267,7 @@ def test_build_mike_version(
267267
("v2.0", "v1.0-pre", 1),
268268
("blah", "v1.0-dev", 1),
269269
("blah", "blah", 0),
270+
("v1x0-dev", "v1.0-dev", 1),
270271
("alpha", "beta", -1),
271272
],
272273
)

0 commit comments

Comments
 (0)