Azure / Azure/azure-cli-extensions

More detail around non-required arguments for create

Open
#1,496 1 comment 0 reactions 0 assignees View on GitHub
Pipelines Service Attention
Dominant language
Python
Stars
454
Forks
1.7k
Avg merge
2d 19h
Merged PRs (30d)
64

Description

In creating an Azure pipeline certain arguments if not specified explicitly will make an attempt to auto detect based on the repository given. It would be better if in the documentation this was more explicit in saying that this attempt will be made but if the attempt fails for any reason this becomes a required argument. This would make required arguments for creation much clearer.

---
#### Document Details

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

* ID: 2a2123ca-5408-8f93-6f5c-93fe74684523
* Version Independent ID: 7a03fe73-da7f-9b5a-38e7-ef51d85d49fd
* Content: [az pipelines](https://docs.microsoft.com/en-us/cli/azure/ext/azure-devops/pipelines?view=azure-cli-latest#ext-azure-devops-az-pipelines-create)
* Content Source: [latest/docs-ref-autogen/ext/azure-devops/pipelines.yml](https://github.com/MicrosoftDocs/azure-docs-cli/blob/live/latest/docs-ref-autogen/ext/azure-devops/pipelines.yml)
* GitHub Login: @rloutlaw
* Microsoft Alias: **routlaw**

Contributor guide

Open the contributing guide

Research direction

Start with latest/docs-ref-autogen/ext/azure-devops/pipelines.yml and the az pipelines create documentation linked in the issue. Check the argument descriptions and make the auto-detection attempt and its fallback to required status explicit, then verify the generated documentation clearly explains which arguments are required when detection fails.

Written by the indexing model from the issue text.

Assessment

Tech stack
azure
Domain
cli, documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.