Skip to content

Commit 73bc468

Browse files
MikeMcC399sxa
andcommitted
docs: add supported architectures section
Co-Authored-By: Stewart X Addison <6487691+sxa@users.noreply.github.com>
1 parent cad8ad1 commit 73bc468

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ The official Node.js docker image, made with love by the node community.
3333
- [License](#license)
3434
- [Supported Docker versions](#supported-docker-versions)
3535
- [Supported Node.js versions](#supported-nodejs-versions)
36+
- [Supported architectures](#supported-architectures)
37+
- [musl builds for Alpine](#musl-builds-for-alpine)
3638
- [Yarn v1 Classic bundling](#yarn-v1-classic-bundling)
3739
- [Governance and Current Members](#governance-and-current-members)
3840
- [Docker Maintainers](#docker-maintainers)
@@ -286,6 +288,23 @@ for current Engine versions.
286288

287289
This project will support Node.js versions as still under active support as per the [Node.js release schedule](https://github.com/nodejs/Release).
288290

291+
## Supported architectures
292+
293+
`node` images are built for the Linux operating system and architecture combinations defined in [versions.json](https://github.com/nodejs/docker-node/blob/main/versions.json).
294+
295+
- The [Node.js Platform list](https://github.com/nodejs/node/blob/main/BUILDING.md#official-binary-platforms-and-toolchains) defines [Support Tiers](https://github.com/nodejs/node/blob/main/BUILDING.md#strategy) 1, 2 and Experimental for platform and architecture combinations of Node.js builds and for each separate Node.js release line
296+
- The [Docker official images library](https://github.com/docker-library/official-images#architectures-other-than-amd64) lists the supported architectures in the Docker build environment
297+
298+
Each of the architectures for Debian images belong to the Node.js support tier 1 or 2, recommended for production applications.
299+
300+
### musl builds for Alpine
301+
302+
`musl` builds for `amd64` are listed under support tier "Experimental" and are tested by the Node.js build process before being used in Docker images. "Experimental" status for Node.js is defined as:
303+
304+
> Experimental: May not compile or test suite may not pass. The core team does not create releases for these platforms. Test failures on experimental platforms do not block releases. Contributions to improve support for these platforms are welcome.
305+
306+
`musl` builds for other architectures, including `arm64`, are not tested before release.
307+
289308
## Yarn v1 Classic bundling
290309

291310
The [Yarn v1 Classic](https://classic.yarnpkg.com/) package manager is bundled in `node` image

0 commit comments

Comments
 (0)