You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Thank you for your contribution. Here are a set of guidelines for contributing to the docker-node project.
3
+
Thank you for your contribution. Here are a set of guidelines for contributing
4
+
to the docker-node project.
4
5
5
6
## Version Updates
6
7
7
8
New **Node.js** releases are released as soon as possible.
8
9
9
-
New **NPM** releases are not tracked. We simply use the NPM version bundled in the corresponding Node.js release.
10
+
New **NPM** releases are not tracked. We simply use the NPM version bundled in
11
+
the corresponding Node.js release.
10
12
11
-
**Yarn** is updated to the latest version only when there is a new Node.js SemVer PATCH release (unless Yarn has received a security update), and it's updated only in the branch with the new release, preferably in the same PR. The `update.sh` script does this automatically when invoked with a specific branch, e.g. `./update.sh 6.10`.
13
+
**Yarn** is updated to the latest version only when there is a new Node.js
14
+
SemVer PATCH release (unless Yarn has received a security update), and it's
15
+
updated only in the branch with the new release, preferably in the same PR. The
16
+
`update.sh` script does this automatically when invoked with a specific branch,
17
+
e.g. `./update.sh 6.10`.
12
18
13
19
### Submitting a PR for a version update
14
20
15
-
If you'd like to help us by submitting a PR for a version update, please do the following:
16
-
17
-
1.[Fork this project.](https://help.github.com/en/github/getting-started-with-github/fork-a-repo)
18
-
1.[Clone the forked repository.](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository)
19
-
1. Create a branch for the update PR. For example, `git checkout master; git checkout -b version-update`.
20
-
1. Run `./update.sh`. You can see additional options by using accessing the built-in help documentation with `./update.sh -h`. This script will automatically update the appropriate files with the latest versions and checksums.
21
-
1. Commit the modified files to the `version-update` branch and push the branch to your fork.
22
-
1.[Create a PR to merge the branch from your fork into this project's master branch.](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork).
21
+
If you'd like to help us by submitting a PR for a version update, please do the
NodeJS is a big ecosystem with a variety of different use cases. The docker images for node are designed to provide the minimum for running core node. Additional dependencies (including dependencies for npm or yarn such as git) will not be included in these base images and will need to be included in descendent image.
41
+
NodeJS is a big ecosystem with a variety of different use cases. The docker
42
+
images for node are designed to provide the minimum for running core node.
43
+
Additional dependencies (including dependencies for npm or yarn such as git)
44
+
will not be included in these base images and will need to be included in
package in your Dockerfile is recommended: `apk add --no-cache libc6-compat`
186
193
187
-
To minimize image size, it's uncommon for additional related tools
188
-
(such as `git` or `bash`) to be included in Alpine-based images. Using this
189
-
image as a base, add the things you need in your own Dockerfile
190
-
(see the [`alpine` image description](https://hub.docker.com/_/alpine/) for
191
-
examples of how to install packages if you are unfamiliar).
194
+
To minimize image size, it's uncommon for additional related tools (such as
195
+
`git` or `bash`) to be included in Alpine-based images. Using this image as a
196
+
base, add the things you need in your own Dockerfile (see the [`alpine` image
197
+
description](https://hub.docker.com/_/alpine/) for examples of how to install
198
+
packages if you are unfamiliar).
192
199
193
200
### `node:slim`
194
201
@@ -217,14 +224,15 @@ upgrade your Docker daemon.
217
224
218
225
## Supported Node.js versions
219
226
220
-
This project will support Node.js versions as still under active support as per the [Node.js release schedule](https://github.com/nodejs/Release).
227
+
This project will support Node.js versions as still under active support as per
228
+
the [Node.js release schedule](https://github.com/nodejs/Release).
221
229
222
230
## Governance and Current Members
223
231
224
232
The Node.js Docker Image is governed by the Docker Working Group. See
0 commit comments