Gulp task

Azure Pipelines | Azure DevOps Server 2020 | Azure DevOps Server 2019 | TFS 2018 - TFS 2015

Use this task to run gulp tasks using the Node.js streaming task-based build system.

Demands

gulp

YAML snippet

# gulp
# Run the gulp Node.js streaming task-based build system
- task: gulp@1
  inputs:
    #gulpFile: 'gulpfile.js' 
    #targets: # Optional
    #arguments: # Optional
    #workingDirectory: # Optional
    #gulpjs: # Optional
    #publishJUnitResults: false # Optional
    #testResultsFiles: '**/TEST-*.xml' # Required when publishJUnitResults == True
    #testRunTitle: # Optional
    #enableCodeCoverage: false 
    #testFramework: 'Mocha' # Optional. Options: mocha, jasmine
    #srcFiles: # Optional
    #testFiles: 'test/*.js' # Required when enableCodeCoverage == True

Arguments

Argument Description
gulpFile
gulp File Path
(Required) Relative path from the repo root of the gulp file script that you want to run.
Default value: gulpfile.js
targets
gulp Task(s)
(Optional) Space-delimited list of tasks to run. If not specified, the default task will run.
arguments
Arguments
Additional arguments passed to gulp.
Tip: --gulpfile is not needed since already added via gulpFile input above
cwd
Working Directory
(Optional) Current working directory when the script is run. Defaults to the folder where the script is located.
Argument aliases: workingDirectory
gulpjs
gulp.js location
(Optional) Path to an alternative gulp.js, relative to the working directory.
Argument aliases: workingDirectory
publishJUnitResults
Publish to Azure Pipelines
Select this option to publish JUnit test results produced by the gulp build to Azure Pipelines
Default value: false
testResultsFiles
Test Results Files
(Required) Test results files path. Wildcards can be used. For example, **/TEST-*.xml for all XML files whose name starts with TEST-.
Default value: **/TEST-*.xml
testRunTitle
Test Run Title
(Optional) Provide a name for the test run
enableCodeCoverage
Enable Code Coverage
(Optional) Select this option to enable Code Coverage using Istanbul
Default value: false
testFramework
Test Framework
(Optional) Select your test framework
Default value: Mocha
srcFiles
Source Files
(Optional) Provide the path to your source files, that you want to hookRequire ()
testFiles
Test Script Files
(Required) Provide the path to your test script files
Default value: test/*.js

Example

Run gulp.js

On the Build tab:

Package: npm


Package: npm

Install npm.

  • Command: install

Build: gulp


Build: gulp

Run your script.

  • gulp file path: gulpfile.js
  • Advanced, gulp.js location: node_modules/gulp/bin/gulp.js

Build a Node.js app

Build your Node.js app with gulp

Open source

This task is open source on GitHub. Feedback and contributions are welcome.

FAQ

Do I need an agent?

You need at least one agent to run your build or release.

I'm having problems. How can I troubleshoot them?

See Troubleshoot Build and Release.

I can't select a default agent pool and I can't queue my build or release. How do I fix this?

See Agent pools.

I use TFS on-premises and I don't see some of these features. Why not?

Some of these features are available only on Azure Pipelines and not yet available on-premises. Some features are available on-premises if you have upgraded to the latest version of TFS.