Creating a custom Docker image with a specified version of the Node package installed

Question

Creating a custom Docker image with a specified version of the Node package installed

My goal is to create a Docker image with a node package installed. If I hardcode the package version in the Dockerfile, everything works fine (@14.0.0):

FROM stefanscherer/node-windows:12.16.1-nanoserver-1909
RUN npm install -g @sitecore-jss/<a href="/cdn-cgi/l/email-protection" class="__cf_email__" data-cfemail="e3908a9786808c915b8d80808dc08986191eadaf4ada7ada7">[email protected]</a>

Building command and output:

docker build -t sitecore-jss-cli:14.0.0-nanoserver-1909 .

Successfully built 1c0ebbcd5be2
Successfully tagged sitecore-jss-cli:14.0.0-nanoserver-1909

However, if I pass the version as an argument (to be able to use any version), an error occurs. Here's the updated Dockerfile:

ARG SITECOREJSS_VERSION
FROM stefanscherer/node-windows:12.16.1-nanoserver-1909
RUN npm install -g @sitecore-jss/sitecore-jss-cli@${SITECOREJSS_VERSION}

The command with the argument and resulting error message:

docker build --build-arg SITECOREJSS_VERSION=14.0.0 -t sitecore-jss-cli:14.0.0-nanoserver-1909 .

...
npm ERR! code EINVALIDTAGNAME
npm ERR! Invalid tag name "${SITECOREJSS_VERSION}": Tags may not have any characters that encodeURIComponent encodes.

It seems like the argument needs to be escaped somehow. Any suggestions on how to resolve this issue?

docker npm npm-install docker-for-windows

Answer 1

Answer №1

You are facing two main challenges:

Ordering Issue

The ARG variable declared outside the FROM block can only be accessed within the FROM line itself. To resolve this, if you do not need to utilize the --build-arg as part of the FROM, it should be moved inside:
```
FROM stefanscherer/node-windows:12.16.1-nanoserver-1909
ARG SITECOREJSS_VERSION
...
```
If the ARG needs to be used both in the FROM statement and elsewhere in the Dockerfile, it must be explicitly stated:
```
ARG SITECOREJSS_VERSION
FROM ...
ARG SITECOREJSS_VERSION
...
```
Interpolation Problem

According to this GitHub issue, when performing interpolation in commands within Windows images, you have to use %:
```
RUN npm install -g @sitecore-jss/sitecore-jss-cli@%SITECOREJSS_VERSION%
```

To make it all work correctly, your updated code snippet would look like this:

FROM stefanscherer/node-windows:12.16.1-nanoserver-1909
ARG SITECOREJSS_VERSION
RUN npm install -g @sitecore-jss/sitecore-jss-cli@%SITECOREJSS_VERSION%

Answer 2

You are facing two main challenges:

Ordering Issue

The ARG variable declared outside the FROM block can only be accessed within the FROM line itself. To resolve this, if you do not need to utilize the --build-arg as part of the FROM, it should be moved inside:
```
FROM stefanscherer/node-windows:12.16.1-nanoserver-1909
ARG SITECOREJSS_VERSION
...
```
If the ARG needs to be used both in the FROM statement and elsewhere in the Dockerfile, it must be explicitly stated:
```
ARG SITECOREJSS_VERSION
FROM ...
ARG SITECOREJSS_VERSION
...
```
Interpolation Problem

According to this GitHub issue, when performing interpolation in commands within Windows images, you have to use %:
```
RUN npm install -g @sitecore-jss/sitecore-jss-cli@%SITECOREJSS_VERSION%
```

To make it all work correctly, your updated code snippet would look like this:

FROM stefanscherer/node-windows:12.16.1-nanoserver-1909
ARG SITECOREJSS_VERSION
RUN npm install -g @sitecore-jss/sitecore-jss-cli@%SITECOREJSS_VERSION%

Creating a custom Docker image with a specified version of the Node package installed

Answer №1

Similar questions

Ways to showcase my Node.js CLI module across various environments

Stagnation in the progress of React installation

Guide to setting up npm for use with Github

Utilizing NodeJs to establish a seamless connection with elasticsearch

Node.js Reverse Geocoding with NPM

What would occur in the event that NPM were to shut down completely?

Separating the NPM MySql connection into its own file is necessary

I am encountering some difficulties in the installation process of Angular CLI

Centralized platform for accessing node and npm installers that adhere to Nexus standards

Error: The type definition file for webpack-env cannot be located during the build process

Can webpack be used to import a bundled webpack and library separately in a project?

Error message appears: "Unable to access 'upgrade' property of undefined" upon launching Vue application

After being transpiled with babel-preset-es2015, what is the designated global function or namespace for ES6 modules?

Issue with Laravel Spark due to NPM Dependencies

Having trouble sorting out the array in my Node.js code

The directory of your cache is populated with files that are owned by the

Setting timeouts during Vue-cli unit testing can help improve the efficiency and accuracy of your tests

Utilizing the require pattern to integrate JavaScript functionality into HTML

The React development server is currently inaccessible due to an error: ERR_CONNECTION_REFUSED

What is the best way to make a service in minikube accessible from another device on the same network?