diff --git a/headless-services/concourse-language-server/src/main/resources/desc/InParallelStep/in_parallel.html b/headless-services/concourse-language-server/src/main/resources/desc/InParallelStep/in_parallel.html deleted file mode 100644 index 3bb213052..000000000 --- a/headless-services/concourse-language-server/src/main/resources/desc/InParallelStep/in_parallel.html +++ /dev/null @@ -1,19 +0,0 @@ -

Performs the given steps in parallel.

If any sub-steps in an in_parallel result in an error, the in_parallel step as a -whole is considered to have errored.

Similarly, when aggregating task steps, if any -fail, the in_parallel step will fail. This is useful for build matrixes:

plan:
-- get: some-repo
-- in_parallel:
-  - task: unit-windows
-    file: some-repo/ci/windows.yml
-  - task: unit-linux
-    file: some-repo/ci/linux.yml
-  - task: unit-darwin
-    file: some-repo/ci/darwin.yml

The in_parallel step is also useful for performing arbitrary steps in -parallel, for the sake of speeding up the build. It is often used to fetch -all dependent resources together:

plan:
-- in_parallel:
-  - get: component-a
-  - get: component-b
-  - get: integration-suite
-- task: integration
-  file: integration-suite/task.yml
\ No newline at end of file diff --git a/headless-services/concourse-language-server/src/main/resources/desc/InParallelStep/in_parallel.md b/headless-services/concourse-language-server/src/main/resources/desc/InParallelStep/in_parallel.md new file mode 100644 index 000000000..bcee44d2d --- /dev/null +++ b/headless-services/concourse-language-server/src/main/resources/desc/InParallelStep/in_parallel.md @@ -0,0 +1,31 @@ +Performs the given steps in parallel. + +If any sub-steps in an `in_parallel` result in an error, the `in_parallel` step +as a whole is considered to have errored. + +Similarly, when aggregating `task` steps, if any *fail*, the +`in_parallel` step will fail. This is useful for build matrices: + +``` +plan: +- get: some-repo +- in_parallel: + - task: unit-windows + file: some-repo/ci/windows.yml + - task: unit-linux + file: some-repo/ci/linux.yml + - task: unit-darwin + file: some-repo/ci/darwin.yml +``` + +The `in_parallel` step is also useful for performing arbitrary steps in parallel, for the sake of speeding up the build. It is often used to fetch all dependent resources together: + +``` +plan: +- in_parallel: + - get: component-a + - get: component-b + - get: integration-suite +- task: integration + file: integration-suite/task.yml +``` \ No newline at end of file