Libraries for writing VSTS and TFS build tasks
Перейти к файлу
Zixuan Qian 90caa3f8b0 Update dirtests.ts 2023-08-21 16:45:43 -07:00
.github Update autoAssignAbtt workflow (#923) 2023-03-15 19:42:17 +03:00
docs create future home of tasks guide 2017-04-08 10:58:57 -04:00
node Update dirtests.ts 2023-08-21 16:45:43 -07:00
powershell refactor: remove Q library from Powershell SDK in favor of native promises (#944) 2023-08-14 16:47:05 +02:00
res Preparing for release of the 3.1.0 version (#713) 2021-02-17 10:48:59 +03:00
.gitignore Users/stfrance/oss (#331) 2018-03-23 13:57:20 -04:00
CONTRIBUTING.md Remove note about v4 task lib status (#919) 2023-03-31 16:09:17 +04:00
ISSUE_TEMPLATE.md Updating documentation (#461) 2019-02-14 10:34:20 -05:00
LICENSE Update LICENSE 2016-03-04 11:50:50 -08:00
README.md note about security issues 2019-10-24 08:58:10 -04:00
SECURITY.md Microsoft mandatory file (#839) 2022-06-03 14:49:33 +04:00
azure-pipelines-steps-node.yml Pipeline fixing (#897) 2022-11-24 13:57:00 +01:00
azure-pipelines-steps-test-build.yml Pipeline fixing (#897) 2022-11-24 13:57:00 +01:00
azure-pipelines.yml migrate to node20 2023-08-18 15:12:54 -07:00
index.html Create index.html 2017-04-08 10:56:17 -04:00
open-pullrequest.ps1 Move notifications about Task-lib Localization PR from Slack to MS Teams - Part 2 (#817) 2022-03-11 16:21:08 +03:00
send-notifications.ps1 Move notifications about Task-lib Localization PR from Slack to MS Teams - Part 2 (#817) 2022-03-11 16:21:08 +03:00
tasks.schema.json migrate to node20 2023-08-18 15:12:54 -07:00

README.md

Azure Pipelines Task SDK

Libraries for writing Azure Pipelines tasks

Reference examples of our in the box tasks are here

Status

Build & Test
Win-x64 Windows Build & Test
macOS macOS Build & Test
Linux-x64 Linux Build & Test

Highlights

  • Breaks coupling with agent: This lib is decoupled and ships with the task and the agent is just an engine to run tasks.
  • Testability: Aims to offer the ability to actually run your task scripts under all scenarios without a server or an agent.
  • Localization: The lib provides a mechanism for storing your localized strings with your task, and loading the correct set at run-time.
  • Consistent API: The TypeScript and PowerShell libs are largely consistent. They only differ where it makes sense (being true to the platform).
  • Tracing for free: Tracing has been built-in to many of the commands. Use the SDK and get some debug tracing for free.

TypeScript Tasks

Cross platform tasks are written in TypeScript. It is the preferred way to write tasks once.

NPM version VSTS

Documentation: Creating Node Tasks with the Typescript API

PowerShell Tasks

A task which automates Powershell technologies can be written with our Powershell SDK. These only run on Windows.

Documentation: PowerShell API

Notes on authoring Tasks

Starting from version v2.141.0, the agent can now run on three OS architectures: x86, x64, and 32-bit ARM. When authoring a new task, you can check agent variable: Agent.OSArchitecture (possible values: X86, X64, ARM) to restrict running said task to a particular set of OS architectures.

Security issues

Do you think there might be a security issue? Have you been phished or identified a security vulnerability? Please don't report it here - let us know by sending an email to secure@microsoft.com.