{"id":20490670,"url":"https://github.com/circleci-public/cimg-node","last_synced_at":"2025-07-12T12:35:53.769Z","repository":{"id":37798627,"uuid":"195098882","full_name":"CircleCI-Public/cimg-node","owner":"CircleCI-Public","description":"The CircleCI Node.js Docker Convenience Image.","archived":false,"fork":false,"pushed_at":"2025-03-27T15:55:33.000Z","size":508,"stargazers_count":43,"open_issues_count":11,"forks_count":34,"subscribers_count":15,"default_branch":"main","last_synced_at":"2025-03-31T07:05:02.412Z","etag":null,"topics":["circleci","circleci-cimg","convenience-image","docker","node","nodejs","npm","yarn"],"latest_commit_sha":null,"homepage":"https://circleci.com/developer/images/image/cimg/node","language":"Dockerfile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CircleCI-Public.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-07-03T17:22:54.000Z","updated_at":"2025-03-14T13:48:44.000Z","dependencies_parsed_at":"2023-10-17T01:49:46.417Z","dependency_job_id":"5eadf595-d3da-4c86-af21-fddf69d7ca1a","html_url":"https://github.com/CircleCI-Public/cimg-node","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CircleCI-Public%2Fcimg-node","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CircleCI-Public%2Fcimg-node/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CircleCI-Public%2Fcimg-node/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CircleCI-Public%2Fcimg-node/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CircleCI-Public","download_url":"https://codeload.github.com/CircleCI-Public/cimg-node/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247617004,"owners_count":20967516,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["circleci","circleci-cimg","convenience-image","docker","node","nodejs","npm","yarn"],"created_at":"2024-11-15T17:17:57.423Z","updated_at":"2025-04-07T08:25:27.230Z","avatar_url":"https://github.com/CircleCI-Public.png","language":"Dockerfile","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\t\u003cp\u003e\n\t\t\u003cimg alt=\"CircleCI Logo\" src=\"https://raw.github.com/CircleCI-Public/cimg-node/main/img/circle-circleci.svg?sanitize=true\" width=\"75\" /\u003e\n\t\t\u003cimg alt=\"Docker Logo\" src=\"https://raw.github.com/CircleCI-Public/cimg-node/main/img/circle-docker.svg?sanitize=true\" width=\"75\" /\u003e\n\t\t\u003cimg alt=\"Node.js Logo\" src=\"https://raw.github.com/CircleCI-Public/cimg-node/main/img/circle-nodejs.svg?sanitize=true\" width=\"75\" /\u003e\n\t\u003c/p\u003e\n\t\u003ch1\u003eCircleCI Convenience Images =\u003e Node.js\u003c/h1\u003e\n\t\u003ch3\u003eA Continous Integration focused Node.js Docker image built to run on CircleCI\u003c/h3\u003e\n\u003c/div\u003e\n\n[![CircleCI Build Status](https://circleci.com/gh/CircleCI-Public/cimg-node.svg?style=shield)](https://circleci.com/gh/CircleCI-Public/cimg-node) [![Software License](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/CircleCI-Public/cimg-node/master/LICENSE) [![Docker Pulls](https://img.shields.io/docker/pulls/cimg/node)](https://hub.docker.com/r/cimg/node) [![CircleCI Community](https://img.shields.io/badge/community-CircleCI%20Discuss-343434.svg)](https://discuss.circleci.com/c/ecosystem/circleci-images) [![Repository](https://img.shields.io/badge/github-README-brightgreen)](https://github.com/CircleCI-Public/cimg-node)\n\n***This image is designed to supercede the legacy CircleCI Node.js image, `circleci/node`.***\n\n`cimg/node` is a Docker image created by CircleCI with continuous integration builds in mind.\nEach 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.\n\n## Support Policy\n\nThe 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.\n\n## Table of Contents\n\n- [Getting Started](#getting-started)\n- [How This Image Works](#how-this-image-works)\n- [Development](#development)\n- [Contributing](#contributing)\n- [Additional Resources](#additional-resources)\n- [License](#license)\n\n## Getting Started\n\nThis image can be used with the CircleCI `docker` executor.\nFor example:\n\n```yaml\njobs:\n  build:\n    docker:\n      - image: cimg/node:15.0.1\n    steps:\n      - checkout\n      - run: node --version\n```\n\nIn the above example, the CircleCI Node.js Docker image is used for the primary container.\nMore specifically, the tag `15.0.1` is used meaning the version of Node.js will be Node.js v15.0.1.\nYou can now use Node.js within the steps for this job.\n\n## How This Image Works\n\nThis image contains the Node.js programming language and its package managers.\nThis includes `npm` and `yarn`.\n\nThere 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.\n\n### Variants\n\nVariant images typically contain the same base software, but with a few additional modifications.\n\n#### Browsers\n\nThe browsers variant is the same Node.js image but with Java, Selenium, and browser dependencies pre-installed via apt.\nThe browsers variant can be used by appending `-browser` to the end of an existing `cimg/node` tag.\nThe browsers variant is designed to work in conjunction with the [CircleCI Browser Tools orb](https://circleci.com/developer/orbs/orb/circleci/browser-tools).\nYou 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.\n\n```yaml\norbs:\n  browser-tools: circleci/browser-tools@1.1.0\njobs:\n  build:\n    docker:\n      - image: cimg/node:15.0.1-browsers\n    steps:\n      - browser-tools/install-browser-tools\n      - checkout\n      - run: |\n          node --version\n          java --version\n          google-chrome --version\n```\n\n### Tagging Scheme\n\nThis image has the following tagging scheme:\n\n```text\ncimg/node:\u003cnode-version\u003e\n```\n\n`\u003cnode-version\u003e` - The version of Node.js to use.\nThis 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.\nThis Node.js image has two version aliases, \"current\" and \"lts\".\nThis 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/).\nKeep in mind that using an alias tag will be less stable that specifying a full SemVer version.\nIf you use the minor release tag, it will automatically point to future patch updates as they are released by Node.js.\nFor 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.\n\n\n## Development\n\nImages can be built and run locally with this repository.\nThis has the following requirements:\n\n- local machine of Linux (Ubuntu tested) or macOS\n- modern version of Bash (v4+)\n- modern version of Docker Engine (v19.03+)\n\n### Cloning For Community Users (no write access to this repository)\n\nFork this repository on GitHub.\nWhen 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.\nIt would look something like this:\n\n```bash\ngit clone --recurse-submodules \u003cmy-clone-url\u003e\n```\n\nIf you missed this step and already cloned, you can just run `git submodule update --recursive` to populate the submodule.\nThen you can optionally add this repo as an upstream to your own:\n\n```bash\ngit remote add upstream https://github.com/CircleCI-Public/cimg-node.git\n```\n\n### Cloning For Maintainers ( you have write access to this repository)\n\nClone the project with the following command so that you populate the submodule:\n\n```bash\ngit clone --recurse-submodules git@github.com:CircleCI-Public/cimg-node.git\n```\n\n### Generating Dockerfiles\n\nDockerfiles can be generated for a specific Node.js version using the `gen-dockerfiles.sh` script.\nFor example, to generate the Dockerfile for Node.js v12.16, you would run the following from the root of the repo:\n\n```bash\n./shared/gen-dockerfiles.sh 12.16.3=lts\n```\n\nThe generated Dockerfile will be located at `./12.16/Dockefile`.\nTo build this image locally and try it out, you can run the following:\n\n```bash\ncd 12.16\ndocker build -t test/node:12.16.3 .\ndocker run -it test/node:12.16.3 bash\n```\n\n### Building the Dockerfiles\n\nTo build the Docker images locally as this repository does, you'll want to run the `build-images.sh` script:\n\n```bash\n./build-images.sh\n```\n\nThis would need to be run after generating the Dockerfiles first.\nWhen releasing proper images for CircleCI, this script is run from a CircleCI pipeline and not locally.\n\n### Publishing Official Images (for Maintainers only)\n\nThe individual scripts (above) can be used to create the correct files for an image, and then added to a new git branch, committed, etc.\nA release script is included to make this process easier.\nTo 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:\n\n```bash\n./shared/release.sh 9.99=alias\n```\n\nThis will automatically create a new Git branch, generate the Dockerfile(s), stage the changes, commit them, and push them to GitHub.\nThe commit message will end with the string `[release]`.\nThis string is used by CircleCI to know when to push images to Docker Hub.\n\"alias\" would be \"current\" or \"lts\" depending on the version.\nAll that would need to be done after that is:\n\n- wait for build to pass on CircleCI\n- review the PR\n- merge the PR\n\nThe main branch build will then publish a release.\n\n### Incorporating Changes\n\nHow changes are incorporated into this image depends on where they come from.\n\n**build scripts** - Changes within the `./shared` submodule happen in its [own repository](https://github.com/CircleCI-Public/cimg-shared).\nFor those changes to affect this image, the submodule needs to be updated.\nTypically like this:\n\n```bash\ncd shared\ngit pull\ncd ..\ngit add shared\ngit commit -m \"Updating submodule for foo.\"\n```\n\n**parent image** - By design, when changes happen to a parent image, they don't appear in existing Node.js images.\nThis is to aid in \"determinism\" and prevent breaking customer builds.\nNew Node.js images will automatically pick up the changes.\n\nIf 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.\nThis will create a new Dockerfile and once published, a new image.\n\n**Node specific changes** - Editing the `Dockerfile.template` file in this repo is how to modify the Node.js image specifically.\nDon't forget that to see any of these changes locally, the `gen-dockerfiles.sh` script will need to be run again (see above).\n\n## Contributing\n\nWe encourage [issues](https://github.com/CircleCI-Public/cimg-node/issues) and [pull requests](https://github.com/CircleCI-Public/cimg-node/pulls) against this repository.\n\nPlease 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.\n\n## Additional Resources\n\n[CircleCI Docs](https://circleci.com/docs/) - The official CircleCI Documentation website.  \n[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.\nIt will list all of the keys and values supported in `.circleci/config.yml`.  \n[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.  \n\n## License\n\nThis repository is licensed under the MIT license.\nThe license can be found [here](./LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcircleci-public%2Fcimg-node","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcircleci-public%2Fcimg-node","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcircleci-public%2Fcimg-node/lists"}