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

Reconsider available versions page in lieu of GitHub Releases #8227

Open
AaronFriel opened this issue Nov 10, 2022 · 3 comments
Open

Reconsider available versions page in lieu of GitHub Releases #8227

AaronFriel opened this issue Nov 10, 2022 · 3 comments
Labels
area/docs Improvements or additions to documentation kind/enhancement Improvements or new features

Comments

@AaronFriel
Copy link
Member

The Available Versions page provides only a subset of the information GitHub releases contain. As an example:

Compare to the GitHub Releases page, which since 3.0 has contained release notes, artifacts, checksums, and in future releases may additionally contain signature bundles (see: pulumi/pulumi#11310).

We could either:

In the former case, it may make sense to maintain a history of pre-3.0 releases.

@AaronFriel AaronFriel added area/docs Improvements or additions to documentation needs-triage Needs attention from the triage team labels Nov 10, 2022
@blampe
Copy link
Contributor

blampe commented Nov 10, 2022

Replace entries on this page with links to the tagged GitHub Releases

I might have a slight preference for this one -- if only because it can be a little tricky digging through GH for older releases. It also keeps folks on pulumi. I don't feel strongly, though.

I think this could co-exist with a solution for pulumi/pulumi#11325 with the addition of a latest tag. The docs can point to the latest release on GH, and that tag is bumped with each release. So the end result might be a table like

Version Date Downloads
latest xx link to gh/releases/latest
3.1 xx link to gh/releases/3.1
...
2.x xx link to legacy get.pulumi.com

(Or maybe we hide the latest column from the UI.)

Regardless of whether we keep the page or point to GitHub, we need to consider how our tools parse the underlying versions.json. The exist

I think an entry like

  {
    "version": "latest",
    "date": "...",
    "downloads": {
      "linux-x64": "https://get.pulumi.com/releases/sdk/pulumi-latest-linux-x64.tar.gz",
    ...
    },
    "checksums": "https://get.pulumi.com/releases/sdk/pulumi-latest-checksums.txt",
    "latest": true
  },

would be backward-compatible with the existing page, while allowing tools to actually grab the latest release without being hindered by the docs publishing delay.

@susanev susanev removed the needs-triage Needs attention from the triage team label Nov 12, 2022
@susanev
Copy link
Contributor

susanev commented Nov 12, 2022

@AaronFriel im assuming you dont need a triage on this, so i dropped the label. pls let me know if you do, thank you!

@ringods
Copy link
Member

ringods commented Nov 14, 2022

Also noting here that the checksums for the Windows MSI package were added to the pulumi/pulumi-winget repository, not the core pulumi/pulumi one:

https://github.com/pulumi/pulumi-winget/releases

And with the work starting to sign our artifacts, this will lead to more metadata with each release:

pulumi/pulumi#11310

@lukehoban lukehoban added the kind/enhancement Improvements or new features label Mar 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Improvements or additions to documentation kind/enhancement Improvements or new features
Projects
Status: 🧳 Backlog
Development

No branches or pull requests

5 participants