Reference - integrate custom build tasks into extensions
TFS 2017
Use this reference when you want to create and integrate custom build pipeline tasks with extensions in Azure DevOps.
Tip
Check out our newest documentation on extension development using the Azure DevOps Extension SDK.
Custom tasks
Tasks are the building blocks for defining automation in a build or release pipeline. We offer many built-in tasks to enable fundamental build and deployment scenarios. We recommend that you review these scenarios before building your own. If the existing tasks don't satisfy your needs, you can build a custom task.
Custom build task JSON
When you're creating a custom build or release task with an extension, your extension includes a task.json
file for each build or release task.
The task.json
file describes the build or release task. The build system uses it to render configuration options to the user and to know which scripts to execute at build time.
The build/release task SDK documentation is on GitHub. Specifically, you may be interested in the task.json schema.
Bundle multiple versions of build/release tasks within one extension
You can include multiple versions of a build or release task within your extension. Roll out future versions of your extension without interrupting service of users on older versions. The following information shows the layout for having multiple versions in one extension.
Traditional extension layout
- extensionManifest.json
- extensionIcon.png
- Task1
- task.json
- icon.png
- taskScript.ps1
Note
When you're setting up a task icon, ensure the following is true.
- The icon name is icon.png
- The icon size is 32x32 pixels
- The icon is in the same location as the
task.json
file
Multiple versions layout
Note
The code looks for the task.json
file inside of the task folder and then one level deeper.
If one isn't found in either level, you see an error message.
- extensionManifest.json
- extensionIcon.png
- Task1
- Task1V1
- task.json
- icon.png
- taskScript.ps1
- Task1V2
- task.json
- icon.png
- taskScript.ps1
- Task1V1
- Task2
- Task2V1
- task.json
- icon.png
- taskScript.ps1
- Task2V2
- task.json
- icon.png
- taskScript.ps1
- Task2V1
Tip
To ensure the _build/Tasks/ssrsfilesdeploy
folder contains the V1 and V2 contents, set matchCopy(item, srcPath, destPath, { noRecurse:
to false
in the make-util.js
file.