Skip to content

docs: add supported architectures section#2498

Merged
MikeMcC399 merged 1 commit into
nodejs:mainfrom
MikeMcC399:architecture-support
May 18, 2026
Merged

docs: add supported architectures section#2498
MikeMcC399 merged 1 commit into
nodejs:mainfrom
MikeMcC399:architecture-support

Conversation

@MikeMcC399
Copy link
Copy Markdown
Contributor

Description

Add a new section "Supported architectures" to the README.md document.

Motivation and Context

The README.md document does not currently describe the support status of the underlying architectures used in the node Docker images.

Debian images (trixie, bookworm & bullseye) all use architectures covered in Node.js Support tiers 1 & 2. These are glibc C library based.

Alpine images rely on musl C library support from nodejs/unofficial-builds that are classified as "Experimental".

node:alpine* images are in wide and successful use since their introduction 10 years ago. Users who choose these images should nevertheless be made aware of the support status of the images. Docker Hub node does not describe support categories.

nodejs/node#62764 seeks to promote Alpine from "Experimental" to "Tier 2" and awareness of the current status may assist in recruiting volunteers to provide additional support and achieve the needed support level promotion.

Testing Details

N/A - documentation change only

Types of changes

  • Documentation
  • Version change (Update, remove or add more Node.js versions)
  • Variant change (Update, remove or add more variants, or versions of variants)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Other (none of the above)

Checklist

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING.md document.
  • All new and existing tests passed.

@MikeMcC399 MikeMcC399 marked this pull request as ready for review May 13, 2026 10:13
@MikeMcC399 MikeMcC399 requested review from Copilot and sxa and removed request for Copilot May 13, 2026 10:13
@MikeMcC399
Copy link
Copy Markdown
Contributor Author

sxa
sxa previously requested changes May 13, 2026
Comment thread README.md Outdated
Comment thread README.md Outdated
@MikeMcC399
Copy link
Copy Markdown
Contributor Author

https://github.com/nodejs/node/blob/main/BUILDING.md#platform-list has now been changed to refer explicitly to only Tier 1 & 2:

For production applications, run Node.js on supported platforms only (Tier 1 or 2).

@MikeMcC399 MikeMcC399 force-pushed the architecture-support branch from 1f951b7 to 8b50e8e Compare May 18, 2026 07:54
@MikeMcC399 MikeMcC399 requested a review from nschonni May 18, 2026 07:57
@MikeMcC399 MikeMcC399 dismissed sxa’s stale review May 18, 2026 07:59

Requested changes from @sxa were implemented

Copy link
Copy Markdown
Member

@sxa sxa left a comment

Choose a reason for hiding this comment

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

I feel the word "rigourously" in the final sentence about no-x64 platforms is doing a lot of heavy lifting to the point I'd prefer to state that it's explicitly untested or similar as we have no testing at all on that platform at the moment, but I'll approve and let you decide whether to update that :-)

Maybe add a link into the Alpine->tier 2 issue for anyone who would like things to change...

Comment thread README.md Outdated
@MikeMcC399
Copy link
Copy Markdown
Contributor Author

I feel the word "rigourously" in the final sentence about no-x64 platforms is doing a lot of heavy lifting to the point I'd prefer to state that it's explicitly untested or similar as we have no testing at all on that platform at the moment, but I'll approve and let you decide whether to update that :-)

Agreed, as I've updated this to remove the word.

Maybe add a link into the Alpine->tier 2 issue for anyone who would like things to change...

I'd like to formulate this in a separate PR. Perhaps we could put together a job description concerning tasks, skills, etc.?

Co-Authored-By: Stewart X Addison <6487691+sxa@users.noreply.github.com>
@MikeMcC399 MikeMcC399 force-pushed the architecture-support branch from 626cd60 to 73bc468 Compare May 18, 2026 14:17
@MikeMcC399 MikeMcC399 merged commit 49e1461 into nodejs:main May 18, 2026
3 checks passed
@MikeMcC399 MikeMcC399 deleted the architecture-support branch May 18, 2026 14:19
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.

Add architecture dependent supportability information

2 participants