Skip to content

Commit da02594

Browse files
committed
Update readme
1 parent 7b8073a commit da02594

File tree

1 file changed

+25
-4
lines changed

1 file changed

+25
-4
lines changed

README.md

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,27 @@
11
# Azure Pipelines tasks
22

3-
TODO:
4-
* Update readme
5-
* Yaml build
6-
* Test runner
3+
This repository contains custom Azure Pipelines tasks.
4+
5+
## Creating new tasks
6+
7+
When creating a new task follow the [official documentation](https://docs.microsoft.com/en-us/azure/devops/extend/develop/add-build-task?view=azure-devops).
8+
9+
You can also use the [schema](https://github.com/Microsoft/azure-pipelines-task-lib/blob/master/tasks.schema.json) provided by Microsoft when building your `task.json` definition.
10+
11+
If your task has external dependencies ensure that you include a `dependency.json` file in the root of the task directory. The following dependency sources are supported:
12+
13+
* GitHub
14+
* PowerShell Gallery
15+
* NuGet
16+
17+
Use [this file](tasks\EnvironmentConfiguration\dependency.json) as a reference when building your `dependency.json`.
18+
19+
## Building locally
20+
21+
```PowerShell
22+
./BuildTask.ps1 -TaskRoot tasks/MyTask
23+
```
24+
25+
## Building in Azure DevOps
26+
27+
Create an `azure-pipelines.yml` in the root of your task directory and reference `azure-pipelines.template.json` from the root of the repository. Use [this file](tasks\EnvironmentConfiguration\azure-pipelines.yml) as a reference.

0 commit comments

Comments
 (0)