Skip to content

test: enforce release notes index ordering #142

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
X-PG13 merged 1 commit into from
May 29, 2026
Merged

test: enforce release notes index ordering #142

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions tests/test_release_metadata.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,13 @@
re.MULTILINE,
)
MARKDOWN_LINK_RE = re.compile(r"!?\[[^\]\n]+\]\(([^)\n]+)\)")
RELEASE_INDEX_LINK_RE = re.compile(
r"^- \[v(?P<label>\d+\.\d+\.\d+)\]\(\./v(?P<target>\d+\.\d+\.\d+)\.md\)$",
re.MULTILINE,
)
SEMVER_RE = re.compile(r"^\d+\.\d+\.\d+$")
LATEST_HEADING_ZH = "\u6700\u65b0\u7248\u672c"
RECENT_RELEASES_HEADING_ZH = "\u8fd1\u671f\u7248\u672c"


def _read_text(relative_path: str) -> str:
Expand Down Expand Up @@ -71,6 +76,19 @@ def _markdown_link_targets(relative_path: str) -> set[str]:
return targets


def _release_index_versions(section: str) -> list[str]:
versions: list[str] = []
for match in RELEASE_INDEX_LINK_RE.finditer(section):
label_version = match.group("label")
target_version = match.group("target")
if label_version != target_version:
raise AssertionError(
f"Release index label v{label_version} points to v{target_version}"
)
versions.append(label_version)
return versions


class ReleaseMetadataTestCase(unittest.TestCase):
def test_project_and_runtime_versions_match(self) -> None:
project_version = _project_version()
Expand Down Expand Up @@ -106,6 +124,30 @@ def test_current_release_docs_are_present_and_indexed(self) -> None:
self.assertIn(release_link, _markdown_section(release_index, "Latest"))
self.assertIn(release_link, _markdown_section(release_index_zh, LATEST_HEADING_ZH))

def test_release_note_indexes_keep_latest_and_recent_releases_ordered(self) -> None:
changelog_versions = CHANGELOG_RELEASE_RE.findall(_read_text("CHANGELOG.md"))
current_version = _project_version()
expected_recent_versions = changelog_versions[1:4]

self.assertGreaterEqual(len(changelog_versions), 4)
self.assertEqual(changelog_versions[0], current_version)
self.assertEqual(len(expected_recent_versions), 3)

for release_index_path, latest_heading, recent_heading in (
("docs/releases/README.md", "Latest", "Recent Releases"),
("docs/releases/README.zh-CN.md", LATEST_HEADING_ZH, RECENT_RELEASES_HEADING_ZH),
):
release_index = _read_text(release_index_path)

self.assertEqual(
[current_version],
_release_index_versions(_markdown_section(release_index, latest_heading)),
)
self.assertEqual(
expected_recent_versions,
_release_index_versions(_markdown_section(release_index, recent_heading)),
)

def test_release_asset_names_match_current_package_version(self) -> None:
version = _project_version()

Expand Down