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

switch docs to reference "latest" release assets instead of specific version #1194

Open
noahdietz opened this issue Aug 29, 2022 · 2 comments
Labels
type: process A process-related concern. May include testing, release, or the like.

Comments

@noahdietz
Copy link
Collaborator

We should change all of the examples in the README to use the "latest" release version, specifically when downloading release assets. See https://docs.github.com/en/repositories/releasing-projects-on-github/linking-to-releases.

As part of this, we'd need to exclude the release version from the asset names e.g. gapic-showcase-0.24.0-darwin-amd64.tar.gz --> gapic-showcase-darwin-amd64.tar.gz. This would involve changes to the release asset creation workflow and notification to downstream consumers that the naming scheme changed.

@noahdietz noahdietz added the type: process A process-related concern. May include testing, release, or the like. label Aug 29, 2022
@vchudnov-g
Copy link
Contributor

Is it possible to link to/download release artifacts with wildcards? Because ideally we could still have the individual artifacts have the version in their names to be descriptive, but at the same time allow easily downloading latest. Hmmm....

@vchudnov-g
Copy link
Contributor

And...no. Wildcards don't work. So here's a half-baked idea: I wonder whether with each release we could keep the versioned-name artifacts but create symlinks without the version name. That way we generally use the versioned-name one in some instructions/scripts that need to be pinned to a version number, but use the unversioned names where we need to, like for this issue.

I'm not sure that's the way we should go, but maybe. Maybe it's overkill. But it seems useful if the user could know which version they're getting when they download "latest". GitHub feature request? ;-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: process A process-related concern. May include testing, release, or the like.
Projects
None yet
Development

No branches or pull requests

2 participants