From 0d3ac889e7574fd2576425307670299934bf0f44 Mon Sep 17 00:00:00 2001 From: Kris De Volder Date: Wed, 13 Dec 2017 14:21:12 -0800 Subject: [PATCH] Tweak GetStep `version` docs --- .../src/main/resources/desc/GetStep/version.html | 11 ----------- .../src/main/resources/desc/GetStep/version.md | 7 +++++++ 2 files changed, 7 insertions(+), 11 deletions(-) delete mode 100644 headless-services/concourse-language-server/src/main/resources/desc/GetStep/version.html create mode 100644 headless-services/concourse-language-server/src/main/resources/desc/GetStep/version.md diff --git a/headless-services/concourse-language-server/src/main/resources/desc/GetStep/version.html b/headless-services/concourse-language-server/src/main/resources/desc/GetStep/version.html deleted file mode 100644 index 6020386a9..000000000 --- a/headless-services/concourse-language-server/src/main/resources/desc/GetStep/version.html +++ /dev/null @@ -1,11 +0,0 @@ -

Optional. Defaults to latest. The version of the resource to -fetch.

If set to latest, scheduling will just find the latest available -version of a resource and use it, allowing versions to be skipped. This is -usually what you want, e.g. if someone pushes 100 git commits.

If set to every, builds will walk through all available versions of -the resource. Note that if passed is also configured, it will only -step through the versions satisfying the constraints.

If set to a specific version (e.g. {ref: abcdef123}), only that -version will be used. Note that the version must be available and detected by -the resource, otherwise the input will never be satisfied. You may want to -use check-resource to force detection of resource versions, -if you need to use an older one that was never detected (as all newly -configured resources start from the latest version).

\ No newline at end of file diff --git a/headless-services/concourse-language-server/src/main/resources/desc/GetStep/version.md b/headless-services/concourse-language-server/src/main/resources/desc/GetStep/version.md new file mode 100644 index 000000000..28b315403 --- /dev/null +++ b/headless-services/concourse-language-server/src/main/resources/desc/GetStep/version.md @@ -0,0 +1,7 @@ +*Optional*. Defaults to latest. The version of the resource to fetch. + +If set to latest, scheduling will just find the latest available version of a resource and use it, allowing versions to be skipped. This is usually what you want, e.g. if someone pushes 100 git commits. + +If set to every, builds will walk through all available versions of the resource. Note that if passed is also configured, it will only step through the versions satisfying the constraints. + +If set to a specific version (e.g. {ref: abcdef123}), only that version will be used. Note that the version must be available and detected by the resource, otherwise the input will never be satisfied. You may want to use check-resource to force detection of resource versions, if you need to use an older one that was never detected (as all newly configured resources start from the latest version). \ No newline at end of file