Skip to content

docs: document automatic Node.js setup for self-hosted/GPU runners - #47234

Merged
pelikhan merged 2 commits into
mainfrom
copilot/add-node-runtime-validation
Jul 22, 2026
Merged

docs: document automatic Node.js setup for self-hosted/GPU runners#47234
pelikhan merged 2 commits into
mainfrom
copilot/add-node-runtime-validation

Conversation

Copilot AI commented Jul 22, 2026

Copy link
Copy Markdown
Contributor

Self-hosted and GPU runners frequently lack Node.js on PATH, causing workflows to fail late with node: command not found — wasting credits and producing cryptic errors.

What's already in the codebase

The compiler already handles this automatically (added in the base branch):

  • isCustomImageRunner() detects non-standard runners (self-hosted, GPU labels, enterprise runners, array/object runs-on forms)
  • DetectRuntimeRequirements() injects actions/setup-node (Node.js 24) early in the agent job for any non-standard runner
  • Standard GitHub-hosted runners (ubuntu-latest, ubuntu-22.04, etc.) are allowlisted and unchanged

This PR

Adds a Node.js subsection to the Runner environment requirements section of self-hosted-runners.md, documenting the automatic setup behavior:

  • Standard hosted runners: no action needed
  • Self-hosted/GPU runners: compiler auto-emits actions/setup-node before any agent or framework scripts
  • Override Node.js version via runtimes: frontmatter:
runs-on: self-hosted
runtimes:
  node:
    version: '22'

…ents

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Add early Node.js runtime validation for self-hosted GPU workflow runners docs: document automatic Node.js setup for self-hosted/GPU runners Jul 22, 2026
Copilot AI requested a review from pelikhan July 22, 2026 08:15
@pelikhan
pelikhan marked this pull request as ready for review July 22, 2026 08:26
Copilot AI review requested due to automatic review settings July 22, 2026 08:26
@pelikhan
pelikhan merged commit 1d691d1 into main Jul 22, 2026
@pelikhan
pelikhan deleted the copilot/add-node-runtime-validation branch July 22, 2026 08:26

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Documents automatic Node.js provisioning for non-standard runners.

Changes:

  • Explains runner-specific Node.js behavior.
  • Shows a runtimes.node.version override.
  • Notes automatic setup behavior.
Show a summary per file
File Description
docs/src/content/docs/reference/self-hosted-runners.md Documents Node.js requirements and compiler setup behavior.

Review details

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

  • Files reviewed: 1/1 changed files
  • Comments generated: 1
  • Review effort level: Medium

```

> [!NOTE]
> The automatic Node.js setup is emitted only for non-standard runners. If your self-hosted runner already has Node.js installed and on `PATH`, the `actions/setup-node` step still runs but is a no-op when the requested version is already present.
@github-actions

Copy link
Copy Markdown
Contributor

🎉 This pull request is included in a new release.

Release: v0.83.0

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Code Quality] Add early Node.js runtime validation for self-hosted/GPU workflow runners

3 participants