ansys / ansys/actions

Fix version ordering on the versions page generated by `_doc-gen-versions-page`

Open Beginner friendly
#1,528 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
19
Forks
7
Avg merge
2d 9h
Merged PRs (30d)
70

Description

Thanks to @ecoussoux-ansys for reporting this issue.

Sorting of versions is not very robust in auto-generated versions page. See the actions versions page for example where v2.0 is considered greater than v10.0. We need to change the sorting logic here to something more robust.

Thankfully most projects stick to 0.X.X releases (and those already releasing major versions haven't gone high enough in the major version number) and I guess the impact has not been felt across the ecosystem because of that.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at _doc-gen-versions-page/action.yml around line 88, where the versions-page sorting logic is defined. Compare its output with the linked Actions versions page, especially v2.0 and v10.0, and verify that generated version pages order releases robustly across multi-digit version numbers.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions
Domain
ci-cd
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
82/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.