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.

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

Consolidate Hosted OSI Documentation Sources #4

Open
philipwindecker opened this issue Oct 22, 2024 · 2 comments · May be fixed by #5
Open

Consolidate Hosted OSI Documentation Sources #4

philipwindecker opened this issue Oct 22, 2024 · 2 comments · May be fixed by #5
Assignees

Comments

@philipwindecker
Copy link
Collaborator

philipwindecker commented Oct 22, 2024

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 OpenSimulationInterface/open-simulation-interface#832.

@philipwindecker
Copy link
Collaborator Author

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 added a commit that referenced this issue Oct 22, 2024
Signed-off-by: Philip WINDECKER (AVENYR GmbH) <[email protected]>
philipwindecker added a commit that referenced this issue Oct 22, 2024
Signed-off-by: Philip WINDECKER (AVENYR GmbH) <[email protected]>
@philipwindecker
Copy link
Collaborator Author

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.

@philipwindecker philipwindecker self-assigned this Oct 22, 2024
@philipwindecker philipwindecker linked a pull request Oct 22, 2024 that will close this issue
@philipwindecker philipwindecker linked a pull request Oct 23, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant