Azure-devops-docs: checkout clean settings are wrong

Created on 15 Jul 2019  Â·  3Comments  Â·  Source: MicrosoftDocs/azure-devops-docs

Under the checkout: self step, the clean property must be true to clean. The all | outputs | resources value is ignored and causes git checkout to _not_ clean at all.
An AZP engineer told me that the all | outputs | resources setting only applies to cleaning of workspaces.


Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Pri1 devops-cictech devopprod doc-bug

Most helpful comment

Ah, I found where the agent uses this value and it's indeed a boolean. So we have a bug in our parser schema.

All 3 comments

@TingluoHuang or @ericsciple can you clarify here? schema.yml beginning around line 1410 says:

    - structure: mapping
      firstKey: checkout
      inherits: taskBase
      properties:
      - name: checkout
        type: string
        data:
          description: "Whether or not to check out the repository containing this pipeline definition"
          enum: "self,none"
      - name: clean
        type: string
        data:
          description: "Scorch the repo before fetching?"
          enum: "outputs,resources,all"

That said, workspace expects a suspiciously similar enum, so I'm wondering if this is a bug in the schema.

Ah, I found where the agent uses this value and it's indeed a boolean. So we have a bug in our parser schema.

Got to the bottom of it. It's a boolean, but it allows expressions, so we have to mark it as a string in the schema. And then we had a copy-paste error on what values are expected (which the parser doesn't use, but IntelliSense does). Both a doc fix and a product fix are inbound.

Was this page helpful?
0 / 5 - 0 ratings