oxidecomputer / oxidecomputer/oxide.rs
Put some instructions in the body of the release
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 75
- Forks
- 21
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 19
Description
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:
Anything else you would like to add?
No response
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at .github/workflows/release.yml around line 258 and inspect how the release body is generated. Add concise instructions for downloading, extracting, and placing the CLI binary on PATH, then verify that a generated release displays those instructions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions
- Domain
- ci-cd, cli, documentation, release
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100