You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/azure-pipelines-vscode-ext/README.md
+32-73
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,12 @@
1
-
# Azure Pipelines Tools VSCode Extension
1
+
# Azure Pipelines Tools for VSCode
2
2
3
-
This is a minimal Azure Pipelines Extension, the first vscode Extension which can Validate and Expand Azure Pipeline YAML files locally without any REST service.
3
+
The first VSCode Extension which can Validate and Expand Azure Pipeline YAML files locally without any REST service.
4
4
5
-

6
-

5
+
#### Live syntax checking for pipelines
6
+

7
+
8
+
#### Live preview of the extended / rendered pipeline
9
+

7
10
8
11
## Features
9
12
@@ -17,18 +20,26 @@ Syntax `[<owner>/]<repo>@<ref>=<uri>` per line. `<uri>` can be formed like `file
17
20
18
21
`> Check Syntax Azure Pipeline`
19
22
20
-
This command explicitly checks for syntax errors in the yaml structure and expression syntaxes. These are necessary but not sufficient checks for a successful Validation of the Azure Pipeline File.
23
+
This command explicitly checks for syntax errors in the yaml structure and expression syntaxes.
24
+
25
+
Referenced templates are read to apply the correct schema for their parameters, if this fails this check is disabled.
26
+
27
+
These are necessary but not sufficient checks for a successful Validation of the Azure Pipeline File.
21
28
22
29
### Validate Azure Pipeline
23
30
24
31
`> Validate Azure Pipeline`
25
32
33
+
**Use this command on your entrypoint Pipeline, otherwise parameters may be missing**
34
+
26
35
This command tries to evaluate your current open Azure Pipeline including templates and notifies you about the result.
27
36
28
37
### Expand Azure Pipeline
29
38
30
39
`> Expand Azure Pipeline`
31
40
41
+
**Use this command on your entrypoint Pipeline, otherwise parameters may be missing**
42
+
32
43
This command tries to evaluate your current open Azure Pipeline including templates and show the result in a new document, which you can save or validate via the official api.
33
44
34
45
### Azure Pipelines Linter Task
@@ -104,74 +115,26 @@ You can configure parameters, variables, repositories per task. You can define m
104
115
]
105
116
}
106
117
```
107
-
Sample Pipeline which dumps the parameters object (legacy parameters syntax)
Sample Pipeline which dumps the parameters object (legacy parameters syntax)
162
-
```yaml
163
-
parameters:
164
-
booleanparam:
165
-
numberparam:
166
-
stringparam:
167
-
objectparam:
168
-
arrayparam:
169
-
steps:
170
-
- script: echo '${{ converttojson(parameters) }}'
171
-
- script: echo '${{ converttojson(variables) }}'
172
-
```
136
+
Sample output for task with label test
173
137
174
-
Output of the Sample Pipeline
175
138
```yaml
176
139
stages:
177
140
- stage:
@@ -200,6 +163,7 @@ stages:
200
163
inputs:
201
164
script: |-
202
165
echo '{
166
+
"myvar": "testx",
203
167
"system.debug": "true"
204
168
}'
205
169
```
@@ -210,23 +174,18 @@ stages:
210
174
- You can run template files with the same template engine locally via the [Runner.Client and Server tool](https://github.com/ChristopherHX/runner.server) using the official Azure Pipelines Agent
211
175
- `Runner.Client azexpand` works like Valdate Azure Pipeline by only checking the return value to be zero
212
176
- `Runner.Client azexpand -q > final.yml`works like Expand Azure Pipeline, but directly writes the expanded file to disk
213
-
- Fast feedback
214
-
- Fast to install
215
177
- Less trial and error commits
216
-
- You can help by reporting bugs
217
-
- It's fully Open Source under the MIT license
218
178
- Works side by side with the official Azure Pipelines VSCode extension
219
179
220
180
## Contra
221
181
- May contain different bugs than the Azure Pipelines Service
222
-
- You could self-host Azure Devops Server and commit your changes to your local system with more accurate results of the template engine
223
-
- May not have feature parity with Azure Pipelines
182
+
- You can self-host Azure Devops Server and commit your changes to your local system with more accurate results of the template engine
224
183
- Missing predefined Variables, feel free to add them manually as needed
225
184
226
185
## Available in both VSCode Marketplace and Open VSX Registry
0 commit comments