Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/circleci-public/cimg-node
The CircleCI Node.js Docker Convenience Image.
https://github.com/circleci-public/cimg-node
circleci circleci-cimg convenience-image docker node nodejs npm yarn
Last synced: 7 days ago
JSON representation
The CircleCI Node.js Docker Convenience Image.
- Host: GitHub
- URL: https://github.com/circleci-public/cimg-node
- Owner: CircleCI-Public
- License: mit
- Created: 2019-07-03T17:22:54.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-12-04T13:30:45.000Z (21 days ago)
- Last Synced: 2024-12-04T14:28:18.203Z (21 days ago)
- Topics: circleci, circleci-cimg, convenience-image, docker, node, nodejs, npm, yarn
- Language: Dockerfile
- Homepage: https://circleci.com/developer/images/image/cimg/node
- Size: 482 KB
- Stars: 42
- Watchers: 17
- Forks: 33
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
CircleCI Convenience Images => Node.js
A Continous Integration focused Node.js Docker image built to run on CircleCI
[](https://circleci.com/gh/CircleCI-Public/cimg-node) [](https://raw.githubusercontent.com/CircleCI-Public/cimg-node/master/LICENSE) [](https://hub.docker.com/r/cimg/node) [](https://discuss.circleci.com/c/ecosystem/circleci-images) [](https://github.com/CircleCI-Public/cimg-node)
***This image is designed to supercede the legacy CircleCI Node.js image, `circleci/node`.***
`cimg/node` is a Docker image created by CircleCI with continuous integration builds in mind.
Each tag contains a version of Node.js, `npm`, `yarn v1`, and any binaries and tools that are required for builds to complete successfully in a CircleCI environment.
## Support Policy
The CircleCI Docker Convenience Image support policy can be found on the [CircleCI docs](https://circleci.com/docs/convenience-images-support-policy) site. This policy outlines the release, update, and deprecation policy for CircleCI Docker Convenience Images.
## Table of Contents
- [Getting Started](#getting-started)
- [How This Image Works](#how-this-image-works)
- [Development](#development)
- [Contributing](#contributing)
- [Additional Resources](#additional-resources)
- [License](#license)
## Getting Started
This image can be used with the CircleCI `docker` executor.
For example:
```yaml
jobs:
build:
docker:
- image: cimg/node:15.0.1
steps:
- checkout
- run: node --version
```
In the above example, the CircleCI Node.js Docker image is used for the primary container.
More specifically, the tag `15.0.1` is used meaning the version of Node.js will be Node.js v15.0.1.
You can now use Node.js within the steps for this job.
## How This Image Works
This image contains the Node.js programming language and its package managers.
This includes `npm` and `yarn`.
There was a recent change reimplmenting vanilla node after briefly using nvm. While it is implied and recommended to not use `sudo` when possible, you will now need it when installing packages globally.
### Variants
Variant images typically contain the same base software, but with a few additional modifications.
#### Browsers
The browsers variant is the same Node.js image but with Java, Selenium, and browser dependencies pre-installed via apt.
The browsers variant can be used by appending `-browser` to the end of an existing `cimg/node` tag.
The browsers variant is designed to work in conjunction with the [CircleCI Browser Tools orb](https://circleci.com/developer/orbs/orb/circleci/browser-tools).
You can use the orb to install a version of Google Chrome and/or Firefox into your build. The image contains all of the supporting tools needed to use both the browser and its driver.
```yaml
orbs:
browser-tools: circleci/[email protected]
jobs:
build:
docker:
- image: cimg/node:15.0.1-browsers
steps:
- browser-tools/install-browser-tools
- checkout
- run: |
node --version
java --version
google-chrome --version
```
### Tagging Scheme
This image has the following tagging scheme:
```text
cimg/node:
```
`` - The version of Node.js to use.
This can be a full SemVer point release (such as `10.16.3`), or just the minor release (such as `12.6`), or a version alias.
This Node.js image has two version aliases, "current" and "lts".
This aliases will always point to the latest "current" and latest "lts" releases that Node.js has as according to [their website](https://nodejs.org/en/).
Keep in mind that using an alias tag will be less stable that specifying a full SemVer version.
If you use the minor release tag, it will automatically point to future patch updates as they are released by Node.js.
For example, the tag `12.6` points to Node.js v12.6.0 now, but when the next release comes out, it will point to Node.js v12.6.1.
## Development
Images can be built and run locally with this repository.
This has the following requirements:
- local machine of Linux (Ubuntu tested) or macOS
- modern version of Bash (v4+)
- modern version of Docker Engine (v19.03+)
### Cloning For Community Users (no write access to this repository)
Fork this repository on GitHub.
When you get your clone URL, you'll want to add `--recurse-submodules` to the clone command in order to populate the Git submodule contained in this repo.
It would look something like this:
```bash
git clone --recurse-submodules
```
If you missed this step and already cloned, you can just run `git submodule update --recursive` to populate the submodule.
Then you can optionally add this repo as an upstream to your own:
```bash
git remote add upstream https://github.com/CircleCI-Public/cimg-node.git
```
### Cloning For Maintainers ( you have write access to this repository)
Clone the project with the following command so that you populate the submodule:
```bash
git clone --recurse-submodules [email protected]:CircleCI-Public/cimg-node.git
```
### Generating Dockerfiles
Dockerfiles can be generated for a specific Node.js version using the `gen-dockerfiles.sh` script.
For example, to generate the Dockerfile for Node.js v12.16, you would run the following from the root of the repo:
```bash
./shared/gen-dockerfiles.sh 12.16.3=lts
```
The generated Dockerfile will be located at `./12.16/Dockefile`.
To build this image locally and try it out, you can run the following:
```bash
cd 12.16
docker build -t test/node:12.16.3 .
docker run -it test/node:12.16.3 bash
```
### Building the Dockerfiles
To build the Docker images locally as this repository does, you'll want to run the `build-images.sh` script:
```bash
./build-images.sh
```
This would need to be run after generating the Dockerfiles first.
When releasing proper images for CircleCI, this script is run from a CircleCI pipeline and not locally.
### Publishing Official Images (for Maintainers only)
The individual scripts (above) can be used to create the correct files for an image, and then added to a new git branch, committed, etc.
A release script is included to make this process easier.
To make a proper release for this image, lets's use the fake Node version of Node v9.99, you would run the following from the repo root:
```bash
./shared/release.sh 9.99=alias
```
This will automatically create a new Git branch, generate the Dockerfile(s), stage the changes, commit them, and push them to GitHub.
The commit message will end with the string `[release]`.
This string is used by CircleCI to know when to push images to Docker Hub.
"alias" would be "current" or "lts" depending on the version.
All that would need to be done after that is:
- wait for build to pass on CircleCI
- review the PR
- merge the PR
The main branch build will then publish a release.
### Incorporating Changes
How changes are incorporated into this image depends on where they come from.
**build scripts** - Changes within the `./shared` submodule happen in its [own repository](https://github.com/CircleCI-Public/cimg-shared).
For those changes to affect this image, the submodule needs to be updated.
Typically like this:
```bash
cd shared
git pull
cd ..
git add shared
git commit -m "Updating submodule for foo."
```
**parent image** - By design, when changes happen to a parent image, they don't appear in existing Node.js images.
This is to aid in "determinism" and prevent breaking customer builds.
New Node.js images will automatically pick up the changes.
If you *really* want to publish changes from a parent image into the Node.js image, you have to build a specific image version as if it was a new image.
This will create a new Dockerfile and once published, a new image.
**Node specific changes** - Editing the `Dockerfile.template` file in this repo is how to modify the Node.js image specifically.
Don't forget that to see any of these changes locally, the `gen-dockerfiles.sh` script will need to be run again (see above).
## Contributing
We encourage [issues](https://github.com/CircleCI-Public/cimg-node/issues) and [pull requests](https://github.com/CircleCI-Public/cimg-node/pulls) against this repository.
Please check out our [contributing guide](.github/CONTRIBUTING.md) which outlines best practices for contributions and what you can expect from the images team at CircleCI.
## Additional Resources
[CircleCI Docs](https://circleci.com/docs/) - The official CircleCI Documentation website.
[CircleCI Configuration Reference](https://circleci.com/docs/2.0/configuration-reference/#section=configuration) - From CircleCI Docs, the configuration reference page is one of the most useful pages we have.
It will list all of the keys and values supported in `.circleci/config.yml`.
[Docker Docs](https://docs.docker.com/) - For simple projects this won't be needed but if you want to dive deeper into learning Docker, this is a great resource.
## License
This repository is licensed under the MIT license.
The license can be found [here](./LICENSE).