Skip to content

docs: mention upgrade command#4083

Open
nhedger wants to merge 1 commit intonextfrom
docs/upgrade-command
Open

docs: mention upgrade command#4083
nhedger wants to merge 1 commit intonextfrom
docs/upgrade-command

Conversation

@nhedger
Copy link
Member

@nhedger nhedger commented Mar 21, 2026

Summary

This PR adds instructions about upgrading Biome for users that install Biome manually.

Merge after biomejs/biome#9546

@netlify
Copy link

netlify bot commented Mar 21, 2026

Deploy Preview for biomejs ready!

Name Link
🔨 Latest commit 91d4050
🔍 Latest deploy log https://app.netlify.com/projects/biomejs/deploys/69be8db189092500089273fe
😎 Deploy Preview https://deploy-preview-4083--biomejs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@github-actions
Copy link
Contributor

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

Locale File Note
en src/content/docs/guides/manual-installation.mdx Source changed, localizations will be marked as outdated.
Warnings reference
Icon Description
🔄️ The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

@ematipico
Copy link
Member

Here we follow the same flow of the core repository.

We send the PRs to the next branch, so we merge code a docs together

@nhedger nhedger changed the base branch from main to next March 21, 2026 12:15
@nhedger nhedger force-pushed the docs/upgrade-command branch from b8cad4f to 49e7b7e Compare March 21, 2026 12:16
@nhedger nhedger force-pushed the docs/upgrade-command branch from 49e7b7e to 91d4050 Compare March 21, 2026 12:23
@nhedger nhedger marked this pull request as ready for review March 21, 2026 17:45
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 21, 2026

Walkthrough

A documentation callout tip has been added to the manual installation guide. The tip explains how users can upgrade Biome to the latest version using the biome upgrade command. It is positioned in the installation workflow, after the instructions for using the standalone binary and before the "Next Steps" section.

🚥 Pre-merge checks | ✅ 2
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarises the main change—adding documentation about the upgrade command for manual Biome installations.
Description check ✅ Passed The description is directly related to the changeset, explaining that it adds upgrade instructions for users installing Biome manually.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/upgrade-command

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@src/content/docs/guides/manual-installation.mdx`:
- Around line 87-89: The tip block currently shows the bare command "biome
upgrade" which is inconsistent with the manual-install flow that uses the local
binary invocation "./biome"; update the tip text inside the :::tip block so the
command reads "./biome upgrade" (and scan the manual-installation guide for any
other occurrences of the string "biome upgrade" and replace them with "./biome
upgrade" to keep invocation style consistent).

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 96041bb2-07a7-4720-a3a5-8597647539d5

📥 Commits

Reviewing files that changed from the base of the PR and between 0ca8dcb and 91d4050.

📒 Files selected for processing (1)
  • src/content/docs/guides/manual-installation.mdx

Comment on lines +87 to +89
:::tip
To **upgrade** Biome to the latest version, run `biome upgrade`
:::
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Verify command-style consistency in manual installation docs.
rg -n -C2 'Now you can use Biome by simply running `\./biome`|`biome upgrade`|`\./biome upgrade`' src/content/docs/guides/manual-installation.mdx

Repository: biomejs/website

Length of output: 217


🏁 Script executed:

# Check the surrounding context (lines 75-95) to see if PATH is mentioned
sed -n '75,95p' src/content/docs/guides/manual-installation.mdx | cat -n

Repository: biomejs/website

Length of output: 736


🏁 Script executed:

# Search for PATH references in the entire file
rg -i 'path|environment|add.*to' src/content/docs/guides/manual-installation.mdx -n

Repository: biomejs/website

Length of output: 41


🏁 Script executed:

# Check how `biome upgrade` is documented elsewhere
rg -l 'biome upgrade' src/content/docs/ | head -10

Repository: biomejs/website

Length of output: 106


Use consistent invocation style for manual installations

Line 88 uses biome upgrade, but line 85 instructs users to run ./biome. For consistency with the manual-install flow (where the binary is in the current directory), change this to ./biome upgrade.

Suggested change
 :::tip
-To **upgrade** Biome to the latest version, run `biome upgrade`
+To **upgrade** Biome to the latest version, run `./biome upgrade`
 :::
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
:::tip
To **upgrade** Biome to the latest version, run `biome upgrade`
:::
:::tip
To **upgrade** Biome to the latest version, run `./biome upgrade`
:::
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@src/content/docs/guides/manual-installation.mdx` around lines 87 - 89, The
tip block currently shows the bare command "biome upgrade" which is inconsistent
with the manual-install flow that uses the local binary invocation "./biome";
update the tip text inside the :::tip block so the command reads "./biome
upgrade" (and scan the manual-installation guide for any other occurrences of
the string "biome upgrade" and replace them with "./biome upgrade" to keep
invocation style consistent).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants