Skip to content

NodeJS

Overview

Execute any NPM, Grunt or Gulp task.

Tools Section

Name Type Default Section Description
dockerImage String nodejs Docker image to run all NodeJS commands in.
commandArgs List nodejs.npm Additional arguments to the NPM commands.
command String install nodejs.npm The NPM command to run within a nodejs.npm workflow step.
npmRegistry String nodejs.npm URL to an alternate NPM registry.
commandArgs List nodejs.gulp Additional arguments to a Gulp command.
command String install nodejs.gulp The Gulp command to run within a nodejs.gulp workflow step.
commandArgs List nodejs.grunt Additional arguments to a Grunt command.
command String install nodejs.grunt The Grunt command to run within a nodejs.grunt workflow step.

Available Methods

npm

Execute NPM tasks.

Name Type Default Description
dockerImage String Docker image to run all NodeJS commands in.
commandArgs List Additional arguments to the NPM commands.
command String install The NPM command to run within a nodejs.npm workflow step.
npmRegistry String URL to an alternate NPM registry.

npm Example

branches:
  feature:
    steps:
      - nodejs:
          # Simple
          - node:
          # Advanced
          - node:
              command: compile

gulp

Execute Gulp tasks.

Name Type Default Description
dockerImage String Docker image to run all NodeJS commands in.
commandArgs List Additional arguments to a Gulp command.
command String install The Gulp command to run within a nodejs.gulp workflow step.

gulp Example

branches:
  feature:
    steps:
      - nodejs:
          # Simple
          - gulp:
          # Advanced
          - gulp:
              name: compileScss

grunt

Execute Grunt tasks.

Name Type Default Description
dockerImage String Docker image to run all NodeJS commands in.
commandArgs List Additional arguments to a Grunt command.
command String install The Grunt command to run within a nodejs.grunt workflow step.

grunt Example

branches:
  feature:
    steps:
      - nodejs:
          # Simple
          - grunt:
          # Advanced
          - grunt:
              name: webpack

Full Example Pipeline

pipelines:
  tools:
    branches:
      patterns:
        feature: .+
  tools:
    nodejs:
      buildImage: node:9.3-alpine
  branches:
    feature:
      steps:
        - nodejs:
          - npm:
        - docker:
          - build:
          - push:

Additional Resources