This document provides a walkthrough of the
.circleci/config.yml file for a Node.js sample application.
- Sample configuration
- Config walkthrough
version: 2.1 configuration:
In the project you will find a CircleCI configuration file
.circleci/config.yml. This file shows best practice for using version 2.1 config with Node projects.
A good way to start using CircleCI is to build a project yourself. Here’s how to build the demo project with your own account:
- Fork the project on GitHub to your own account.
- Go to the Add Projects page in the CircleCI application and click the Set Up Project button next to the project you just forked.
- To make changes you can edit the
.circleci/config.ymlfile and make a commit. When you push a commit to GitHub, CircleCI will build and test the project.
Below is the
.circleci/config.yml file in the demo project.
orbs: # declare what orbs we are going to use node: firstname.lastname@example.org # the node orb provides common node-related configuration version: 2.1 # using 2.1 provides access to orbs and other features workflows: matrix-tests: jobs: - node/test: version: 13.11.0 - node/test: version: 12.16.0 - node/test: version: 10.19.0
Using the 2.1 Node orb sets an executor from CircleCI’s highly cached convenience images built for CI and allows you to set the version of NodeJS to use. Any available tag in the docker image list can be used.
The Node Orb
test command will test your code with a one-line command, with optional parameters.
Matrix jobs are a simple way to test your Node app on various node environments. For a more in depth example of how the Node orb utilizes matrix jobs, see our blog on matrix jobs. See documentation on pipeline parameters to learn how to set a node version via Pipeline parameters.
Success! You just set up a Node.js app to build on CircleCI with version: 2.1 configuration. Check out our project’s pipeline page to see how this looks when building on CircleCI.
- See the Deploy document for example deploy target configurations.
- If you’re new to CircleCI 2.0, we recommend reading our Project Walkthrough for a detailed explanation of our configuration using Python and Flask as an example.
Help make this document better
This guide, as well as the rest of our docs, are open-source and available on GitHub. We welcome your contributions.
- Suggest an edit to this page (please read the contributing guide first).
- To report a problem in the documentation, or to submit feedback and comments, please open an issue on GitHub.
- CircleCI is always seeking ways to improve your experience with our platform. If you would like to share feedback, please join our research community.
CircleCI Documentation by CircleCI is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.