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

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

Open
stanbrub opened this issue Jun 8, 2024 · 0 comments
Open

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

stanbrub opened this issue Jun 8, 2024 · 0 comments
Assignees
Labels
bug Something isn't working ci core Core development tasks May2024
Milestone

Comments

@stanbrub
Copy link
Contributor

stanbrub commented Jun 8, 2024

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:

@stanbrub stanbrub added bug Something isn't working triage labels Jun 8, 2024
@rcaudy rcaudy added core Core development tasks ci and removed triage labels Jun 8, 2024
@rcaudy rcaudy added this to the 3. May 2024 milestone Jun 8, 2024
@stanbrub stanbrub changed the title Docs CI is Setting Latest on Wayback Releases Docs CI is Setting Latest on Older Releases Jun 11, 2024
@stanbrub stanbrub changed the title Docs CI is Setting Latest on Older Releases Docs CI is Setting Latest on Older Patch Releases Jun 11, 2024
@stanbrub stanbrub changed the title Docs CI is Setting Latest on Older Patch Releases Docs CI is Setting Latest on Non-Latest Patch Releases Jun 11, 2024
devinrsmith added a commit to devinrsmith/deephaven-core that referenced this issue Jun 20, 2024
Note: docs-ci-v2 is no longer present in main, but is applicable for 0.33.x releases.

Workaround for deephaven#5591
devinrsmith added a commit that referenced this issue Jun 20, 2024
Note: docs-ci-v2 is no longer present in main, but is applicable for 0.33.x releases.

Workaround for #5591
@pete-petey pete-petey modified the milestones: 3. May 2024, Backlog Aug 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working ci core Core development tasks May2024
Projects
None yet
Development

No branches or pull requests

3 participants