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

Put some instructions in the body of the release #634

Open
1 of 4 tasks
david-crespo opened this issue Apr 8, 2024 · 2 comments
Open
1 of 4 tasks

Put some instructions in the body of the release #634

david-crespo opened this issue Apr 8, 2024 · 2 comments
Labels
feature Issue for a new feature that does not break current functionality

Comments

@david-crespo
Copy link
Contributor

Target component

  • CLI
  • SDK
  • Something else
  • Not sure

Overview

Building on an idea from @twinfees, if this is the primary way people get the CLI binaries, it would be nice to say here something to the effect of "download one of these, extract it [maybe include details on on appropriate method], and put it on your path".

https://github.com/oxidecomputer/oxide.rs/releases/tag/v0.4.0%2B20240327.0

Implementation details

Something to do with this:

body: ${{ fromJson(needs.host.outputs.val).announcement_github_body }}

Anything else you would like to add?

No response

@david-crespo david-crespo added the feature Issue for a new feature that does not break current functionality label Apr 8, 2024
@twinfees
Copy link

twinfees commented Apr 8, 2024

Thank you for opening this, @david-crespo! To further support this request, wanted to highlight that in this section, we say the following:

The download instructions can be found at https://github.com/oxidecomputer/oxide.rs/releases.

But, there aren't any actual instructions there.

@askfongjojo
Copy link

But, there aren't any actual instructions there.

I've made a docs PR to fix the language in the user guide section referenced above though it doesn't preclude adding instructions to the releases page for users who may need more assistance (e.g. knowing where to drop the binary or how to set path variable, etc).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature Issue for a new feature that does not break current functionality
Projects
None yet
Development

No branches or pull requests

3 participants