Azure-devops-docs: downloadType argument enum not clear

Created on 20 Nov 2018  Â·  4Comments  Â·  Source: MicrosoftDocs/azure-devops-docs

For the downloadType argument, it is not clear what the difference between 'single' and 'specific' is from the description provided


Document Details

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

Pri2 devopprod doc-bug

All 4 comments

@Lovakumar does your team own this task and its docs? If so, could you please assign this issue appropriately?

This has been clarified in the docs which should be live within a few days.

Options: single vs. specific:
Choose whether to download a single artifact or all artifacts of a specific build.

That's still not very clear. Is the enum value specific and that means use the specific build?

Choose whether to download a single artifact or all artifacts of a specific build.

That's still not very clear.

@davidstaheli @seesharprun

Not only is is not very clear, it actually seems wrong _(or other bits are still wrong)_.
The use of the value specific to denote all files seems to be the confusion.
Both of these settings values should be applied to the specified build, right?


Given the Description:

Choose whether to download a single artifact or all artifacts of a specific build.

How should that be interpreted?

  1. "Download a Single or Specific Artifact(s)"

    • "... download a single artifact .. of a specific build."
    • "... download all artifacts .. of a specific build."
      _(but really: "... download specific artifacts .. of a specific build.")_

  2. "Download a Single from this build or All from a Specific build?"

    • "... download a single artifact."
    • "... download all artifacts of a specific build."

Interpretation #2 doesn't make a lot of sense as a binary option; it forces a dual meaning of 'specific' between the description + option. If downloading a 'single' artifact, how would I specify a build?


If the intent and functionality should follow Interpretation #1, then the config value of 'specific is referring to the specific artifacts+files you want to download, right? If that follows, then this would be a better Description:

_Choose whether to download a single artifact or specific artifacts of the configured build or pipeline._

This would at least remove the overload of the term 'specific', which in the configuration _value_ is undoubtedly referring to _specific artifacts_, and not _a specific build_, as the Description seems to allude.


This still doesn't help the confusion between the artifactName (required) and itemPattern (optional) when combined with this setting. Based on the current docs, if downloadType == specific, artifactName is basically ignored because the default pattern will download all files across all artifacts. While we're at it, what is the default pattern?

Was this page helpful?
0 / 5 - 0 ratings

Related issues

michhar picture michhar  Â·  3Comments

adnanebrahimi picture adnanebrahimi  Â·  3Comments

Naphier picture Naphier  Â·  3Comments

robinmanuelthiel picture robinmanuelthiel  Â·  3Comments

o-o00o-o picture o-o00o-o  Â·  3Comments