Skip to content

docs: describe manual PR image creation #2510

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 1 commit into
base: main
Choose a base branch
from
+14 −2
Open

docs: describe manual PR image creation #2510

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 14 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,17 @@ from templates starting with the Node 26 images.
- Another [workflow](https://github.com/nodejs/docker-node/blob/main/.github/workflows/official-pr.yml) detects the merger of these pull requests and opens a pull request to [docker-library/official-images](https://github.com/docker-library/official-images).
- The official images are built and published according to [docker's process](https://github.com/docker-library/faq#an-images-source-changed-in-git-now-what), resulting in the new images being available on [Docker Hub](https://hub.docker.com/_/node).

### Submitting a PR for a version update
### Image Creation Manually

If you'd like to help us by submitting a PR for a version update, please do the following:
Image updates for existing Node.js release lines are created automatically as described above.
If there is a problem with the automated process, it may be necessary to create an update PR manually.
If you believe there is a need for a manual PR, and you are not a member of the
[Docker Maintainers](./README.md#docker-maintainers) or
[Collaborators](./README.md#collaborators) team of this repo,
please first open an issue to describe the update problem
and your suggestion to resolve it.

To set up a version update PR, follow these instructions:

1. [Fork this project.](https://docs.github.com/en/get-started/quickstart/fork-a-repo)
1. [Clone the forked repository.](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository)
Expand All @@ -52,6 +60,10 @@ If you'd like to help us by submitting a PR for a version update, please do the
1. Commit the modified files to the `version-update` branch and push the branch to your fork.
1. [Create a PR to merge the branch from your fork into this project's default branch.](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork).

When a new Node.js release line is expected, addition preparation is necessary, including updates to the
[versions.json](./versions.json) file and creation of a major version directory, populated with generated files.
This task is undertaken by members of the repo team above.

## Adding dependencies to the base images

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.