Azure Pipeline执行Gulp@1任务报错：无法找到gulp可执行文件

问题描述 #

搭建运行自定义Gulp命令的CI构建时，Azure Pipeline的Gulp@1任务抛出异常。已执行包含Gulp CLI依赖的npm install命令，但仍收到"找不到gulp可执行文件"的报错，本地构建可正常运行。

错误日志 #

Starting: gulp
==============================================================================
Task         : gulp
Description  : Run the gulp Node.js streaming task-based build system
Version      : 1.231.0
Author       : Microsoft Corporation
Help         : https://docs.microsoft.com/azure/devops/pipelines/tasks/build/gulp
==============================================================================
##[error]Unhandled: Unable to locate executable file: 'gulp'. Please verify either the file path exists or the file can be found within a directory specified by the PATH environment variable. Also verify the file has a valid extension for an executable file.
##[error]Error: Unable to locate executable file: 'gulp'. Please verify either the file path exists or the file can be found within a directory specified by the PATH environment variable. Also verify the file has a valid extension for an executable file.
    at Object._which [as which] (D:\agent_A\_work\_tasks\gulp_b82cfbe4-34f9-40f5-889e-c8842ca9dd9d\1.231.0\node_modules\azure-pipelines-task-lib\internal.js:323:23)
    at Object.<anonymous> (D:\agent_A\_work\_tasks\gulp_b82cfbe4-34f9-40f5-889e-c8842ca9dd9d\1.231.0\gulptask.js:29:19)
    at Module._compile (node:internal/modules/cjs/loader:1105:14)
    at Object.Module._extensions..js (node:internal/modules/cjs/loader:1159:10)
    at Module.load (node:internal/modules/cjs/loader:981:32)
    at Function.Module._load (node:internal/modules/cjs/loader:822:12)
    at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:77:12)
    at node:internal/main/run_main_module:17:47
Finishing: gulp

当前构建任务配置 #

steps:
# Authenticate NuGet feeds to use this org's artifacts
- task: NuGetAuthenticate@0
  displayName: 'Authenticate Nuget Feeds'

# Restore Nuget Tool Installer
- task: NuGetToolInstaller@1
  displayName: NuGet Tool Installer
  inputs:
    versionSpec: '6.x'

# Restore Nuget Packages with Feed
- task: NuGetCommand@2
  displayName: Restore Nuget Packages with Feed
  inputs:
    command: 'restore'
    restoreSolution: '$(solution)'
    feedsToUse: 'select'
    vstsFeed: 'feed'
    
- task: Npm@1
  displayName: 'npm install'
  inputs:
    command: install
    workingDir: '$(Build.SourcesDirectory)'
    verbose: false

- task: Gulp@1
  inputs:
    workingDir: '$(Build.SourcesDirectory)'
    gulpFile: 'gulpfile.js'
    targets: 'proj:publish'
    displayName: 'Build Proj'

解决方法 #

方法1：指定本地gulp可执行文件路径 #

npm install默认将gulp-cli安装在项目的node_modules/.bin目录下，Azure Pipeline的Gulp任务可能未自动识别该路径。在Gulp@1任务中添加gulpPath参数，明确指向本地的gulp可执行文件：

- task: Gulp@1
  inputs:
    workingDir: '$(Build.SourcesDirectory)'
    gulpFile: 'gulpfile.js'
    targets: 'proj:publish'
    gulpPath: '$(Build.SourcesDirectory)/node_modules/.bin/gulp'
    displayName: 'Build Proj'

方法2：全局安装gulp-cli #

在npm install任务之后，添加全局安装gulp-cli的步骤，确保gulp被加入系统PATH：

- task: Npm@1
  displayName: 'npm install gulp-cli globally'
  inputs:
    command: custom
    customCommand: 'install -g gulp-cli'

方法3：确认package.json依赖 #

检查项目的package.json，确保gulp-cli已被添加到devDependencies中。如果没有，在本地执行以下命令后提交代码：

npm install gulp-cli --save-dev

内容的提问来源于stack exchange，提问作者SamNewton