search

OpenSimulationInterface / osi-antora-generator

Mozilla Public License 2.0
0 stars 1 forks source link

Consolidate Hosted OSI Documentation Sources #4

Open philipwindecker opened 5 days ago

philipwindecker commented 5 days ago

Describe the bug

Output prioritizes release candiates over releases.

Describe how to reproduce the bug

Open link to documentation with "latest" selected.

Describe the expected behavior

Latest is latest release, release candidates not present after release.

Source issue

This relates to https://github.com/OpenSimulationInterface/open-simulation-interface/issues/832.

philipwindecker commented 5 days ago

Note: Release candidates are created the same way as releases. Antora sorts versions internally through their own logic, which in this case considers v..-rc over v..* (with the same digits).

To remove such a rc version from the build steps, there are two options:

  1. Remove the created tag
  2. Add the tag to the exceptions in the site.yml

I will go the second route (as this can be reverted later and will not cause incompatibility issues with local setups).

philipwindecker commented 5 days ago

Suggestion for the future

If the group would like to keep release candidates but have them not be eligible for 'latest', each release could be marked with prerelease: true in the "antora.yml" file in the osi-documentation repository while the project is running. The prerelease tag would have to be set to false for the final release (and be updated afterwards again).

It could also be checked if this can be done programatically, but expect this to take some time in development.