Skip to content

doc: add Rust toolchain general install instructions #63426

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.

Sign up for GitHub

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

Open
MikeMcC399 wants to merge 2 commits into
base: main
Choose a base branch
from
+16 −0
Open

doc: add Rust toolchain general install instructions #63426

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
47c1e91
doc: add Rust toolchain general install instructions
MikeMcC399 May 19, 2026
6e94d65
add comment that Temporal support is enabled by default
MikeMcC399 May 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions BUILDING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,10 +237,24 @@ tarball and/or browse the git repository checked out at the relevant tag.
### Prerequisites

* [A supported version of Python][Python versions] for building and testing.
* A Rust toolchain if [Building Node.js with Temporal support](#building-nodejs-with-temporal-support)
is required (enabled by default starting in Node.js 26)
Comment on lines +240 to +241
Copy link
Copy Markdown
Contributor

@aduh95 aduh95 May 19, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

Suggested change
* A Rust toolchain if [Building Node.js with Temporal support](#building-nodejs-with-temporal-support)
is required (enabled by default starting in Node.js 26)
* A Rust toolchain if [building Node.js with `Temporal` support](#building-nodejs-with-temporal-support)
(auto-detect by default as of Node.js 26.0.0).

* Memory: at least 8GB of RAM is typically required when compiling with 4 parallel jobs (e.g: `make -j4`)

### Unix and macOS

Developers should use the official [Install Rust](https://rust-lang.org/tools/install/)
instructions to install a Rust toolchain, required for Temporal support introduced in Node.js 26.

Copy link
Copy Markdown
Contributor

@aduh95 aduh95 May 19, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

It's not developer-specific, and in fact I wouldn't be surprised if most developers don't need any Rust toolchain

Suggested change
Consult the official [Install Rust](https://rust-lang.org/tools/install/)
instructions to install a Rust toolchain, required for Temporal support introduced in Node.js 25.4.0.

Individual packages such as `rust` and `cargo` in some operating system distributions may be considered
as an alternative for CI environments.
Copy link
Copy Markdown
Contributor

@aduh95 aduh95 May 19, 2026

Choose a reason for hiding this comment

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

Why just for CI? There's nothing CI specific about those distributions of Rust AFAIK

Suggested change
as an alternative for CI environments.
as an alternative, for example in CI environments.

Consult with relevant operating system documentation to ensure that packages
meet the minimum version specified in
[Building Node.js with Temporal support](#building-nodejs-with-temporal-support),
Comment on lines +252 to +253
Copy link
Copy Markdown
Contributor

@aduh95 aduh95 May 19, 2026

Choose a reason for hiding this comment

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

Suggested change
meet the minimum version specified in
[Building Node.js with Temporal support](#building-nodejs-with-temporal-support),
meet the minimum version specified in the
[Building Node.js with Temporal support](#building-nodejs-with-temporal-support) section,

as packaged versions may lag behind the `stable` version installed by the official instructions.
Avoid mixing `rustup` together with `rust` and `cargo` package installations, due to
potential version conflicts.

#### Unix prerequisites

* `gcc` and `g++` >= 13.2 or `clang` and `clang++` >= 19.1
Expand Down Expand Up @@ -1055,6 +1069,8 @@ requires a Rust toolchain:
* rustc >= 1.82 (with LLVM >= 19)
* cargo >= 1.82

Refer to [Install Rust](https://rust-lang.org/tools/install/) for instructions.

If `--v8-enable-temporal-support` and `--v8-disable-temporal-support` are both
omitted, `configure.py` probes for `cargo` and `rustc`. If either is missing,
a warning is printed and Temporal support is disabled.
Expand Down
Loading