search

oven-sh / bun

Incredibly fast JavaScript runtime, bundler, test runner, and package manager – all in one
https://bun.sh
Other
74.14k stars 2.77k forks source link

Add documentation for `bun upgrade` #10560

Open jsandford-mastery opened 6 months ago

jsandford-mastery commented 6 months ago

What is the type of issue?

Documentation is missing

What is the issue?

bun upgrade is not mentioned in the docs. There are no current mentions in gh issues about this adding this, but there are mentions there of using it. Good news is that it is in bun --help.

Where did you find it?

Found in https://bun.sh/docs/ and not found at https://bun.sh/docs/cli/upgrade or https://bun.sh/docs/cli/update.

lafkpages commented 6 months ago

bun upgrade is documented in the Installation docs, although those docs are outdated and don't mention the --stable flag required to downgrade from canary.

Edit: see #11000

jsandford-mastery commented 5 months ago

Thanks for pointing this out! I feel a bit dumb. The reason I couldn't find it was because I used the algolia-powered site search to look for upgrade and it didn't show the Installation page in the visible list of results (first screen shot) and I didn't realize I could scroll down b/c my computer has scroll bars set to show automatically 😞. When I search for bun upgrade like I did before, I now am noticing the the Installation page show up at the very bottom of the results (second screen shot), but I apparently overlooked it. I also noticed that bun help shows the upgrade command. Im not sure if this is new, but it's great to see!

Screenshot Screenshot 2

Maybe it would be helpful to have a clarifying sentence on https://bun.sh/docs/cli/update that if someone is wanting to upgrade bun itself, they need to use bun upgrade.

Just as a way of comparison only and w/o negative sentiments, I looked at yarn and brew and I noticed that they use the upgrade (sub)command to update packages and, with brew, update "[fetches] the newest version of Homebrew and all formulae...". What was the reasoning behind bun update updating packages and bun upgrade updating bun itself? I'm sure there was a good reason.

THX!