Azure-pipelines-agent: YAML resources documentation is unclear

[simonvane]

Have you tried trouble shooting?

yes

Agent Version and Platform

Hosted VS2017

VSTS Type and Version

VisualStudio.com

What's not working?

When build definition is exported using "View YAML" the following is included:

resources:
- repo: self
  clean: true

This does not match what is described in https://github.com/Microsoft/vsts-agent/blob/master/docs/preview/yamlgettingstarted-resources.md

Additional, it is unclear whether the "Get sources" part of the build is effected by this. The values in the UI don't change when clear is set to false for example. All in all, this part of the YAML build definition is difficult to understand.

[ericsciple]

I agree. We are currently working through changes around checkout and repositories.

In short, use the checkout options to control whether to clean

[ericsciple]

I've opened a work item internally to track changing the resources section from exported from the View Yaml link in the UI. We are working through changes for the resources section and the checkout step, in the server side repo (different repo).

The docs here are consistent with where we are going. The exported values from View Yaml is stale.