Skip to content
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

Jump to bottom

Sort versions in the documentation version picker appropriately. #16966

Merged
merged 3 commits into from
Mar 14, 2024
Merged

Sort versions in the documentation version picker appropriately. #16966

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c515c45
Sort versions in the documentation version picker appropriately.
Half-Shot Feb 26, 2024
9bd22bf
Create 16966.doc
Half-Shot Feb 26, 2024
a967cbc
Merge branch 'develop' into patch-2
Half-Shot Mar 14, 2024
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
1 change: 1 addition & 0 deletions changelog.d/16966.doc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix the sort order for the documentation version picker, so that newer releases appear above older ones.
26 changes: 23 additions & 3 deletions docs/website_files/version-picker.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,10 +100,30 @@ function sortVersions(a, b) {
if (a === 'develop' || a === 'latest') return -1;
if (b === 'develop' || b === 'latest') return 1;

const versionA = (a.match(/v\d+(\.\d+)+/) || [])[0];
const versionB = (b.match(/v\d+(\.\d+)+/) || [])[0];
// If any of the versions do not confrom to a semantic version string, they
// will be sorted behind a valid version.
const versionA = (a.match(/v(\d+(\.\d+)+)/) || [])[1]?.split('.') ?? '';
const versionB = (b.match(/v(\d+(\.\d+)+)/) || [])[1]?.split('.') ?? '';

return versionB.localeCompare(versionA);
for (let i = 0; i < Math.max(versionA.length, versionB.length); i++) {
if (versionB[i] === undefined) {
return -1;
}
if (versionA[i] === undefined) {
return 1;
}

const partA = parseInt(versionA[i], 10);
const partB = parseInt(versionB[i], 10);

if (partA > partB) {
return -1;
} else if (partB > partA) {
return 1;
}
}

return 0;
}

/**
Expand Down
Loading