Skip to content

Docs CI is Setting Latest on Non-Latest Patch Releases #5591

@stanbrub

Description

@stanbrub

Since the time that the Docs CI was reworked to publish versioned docs to a special directory in deephaven.io (deephaven-core-v2), version numbers have gone upward. Recently, we released a version 0.33.4 that was older than the current 0.34.3, and the workflow set 0.33.4 to "latest".

The deephaven.io site uses "latest" for Reference API Doc links to avoid having to set the latest version manually in the navigation panel. When a new release happens, the link is changed on the file system, and no changes are required in the web site's source.

Possible Solutions:

  • Update the RELEASE.md to include some instructions for fixing the latest symlink manually if we do a patch on an older release
    • If we intend to do old patches rarely, this is the easiest approach
  • Add a conditional to the symlinks step in the workflow to skip the latest symlink if the version is older than latest
    • Find a way to get the latest version and compare versions in a way other than lexicographical
    • Or change the branching scheme so (e.g. old_release/v0.33.4) so it's obvious to the workflow that this is not latest

Other considerations:

Metadata

Metadata

Assignees

Labels

May2024bugSomething isn't workingcicoreCore development tasks

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions