[Feature Request]: Add a custom sorting feature to the dropdown list

insightsengineering / r-pkgdown-multiversion

Github Action to generate multiple versions of pkgdown docs for R packages

https://github.com/marketplace/actions/r-pkgdown-multi-version-docs

Apache License 2.0

4 stars 0 forks source link

[Feature Request]: Add a custom sorting feature to the dropdown list #7

Closed cicdguy closed 2 years ago

cicdguy commented 2 years ago

Feature description

A user of this action should be able to specify a custom sorting order for the items from the dropdown list.

Code of Conduct

[X] I agree to follow this project's Code of Conduct.

Contribution Guidelines

[X] I agree to follow this project's Contribution Guidelines.

Security Policy

[X] I agree to follow this project's Security Policy.

walkowif commented 2 years ago

Currently versions in r-pkgdown-multiversion action are sorted in the following way:

Only versions that match main, devel, pre-release, latest-tag, and semantic version regex are processed.
First, versions are sorted according to the number of characters.
Versions of equal length are then sorted alphabetically (in the above context, only semantic versions can be of equal length so in practice this compares only digits and dot sign).
Finally the order is reversed (so the longest version names are at the beginning/top).

So now it would be useful to know what these custom sorting orders to implement could be.

cicdguy commented 2 years ago

The requested order is as follows:

I want devel to show up first, then pre-release to show up second, and main to show up third, followed by all semantic versions. The order of devel, pre-release and main is something that me, as a user, would indicate (somehow).

cicdguy commented 2 years ago

Closing as this was implemented in #9