mirror of
https://github.com/github/awesome-copilot.git
synced 2026-07-14 01:51:02 +00:00
Komal Vardhan Lolugu
4e8726dd50
* azure-devops-cli: handle long comments on Windows (#2061) On Windows 'az' is a cmd.exe batch wrapper capped at ~8191 characters, so a long --discussion / --description value silently truncates or fails. Document three verified ways out so the coding agent doesn't waste 3-5 turns falling back to raw token retrieval and REST: 1. azps.ps1 in PowerShell on Windows. Same Azure CLI, invoked through the Python entry point with no cmd.exe length cap. Pair with 'Get-Content -Raw' so the body lives in a variable, not on the command line. 2. Native --file-path flags where Azure CLI offers them. Applies to 'az devops wiki page create' and 'az devops wiki page update', both documented with --encoding. 3. 'az devops invoke --in-file' as the universal escape hatch for commands with no --file-path (work-item --discussion, PR --description). Documented example posts to the work item comments REST endpoint with api-version 7.0-preview.3. The earlier draft suggested the Azure CLI '@<file>' convention as a generic substitute for inline string args. The official docs only document it for JSON parameters and the CLI source uses 'get_file_json' specifically, so the claim is removed and replaced with an explicit warning not to rely on it for plain string args. Files touched: - skills/azure-devops-cli/SKILL.md: new 'Posting long comments on Windows' section with shell-detection table and three verified options. - skills/azure-devops-cli/references/boards-and-iterations.md: short pointer at each --discussion example back to SKILL.md, plus an inline PowerShell snippet. Closes #2061. * azure-devops-cli: move long-comments guidance to reference file (#2061 review) aaronpowell asked for the Windows long-comments section to live as a reference file rather than inline in SKILL.md, so the token weight isn't always loaded into the agent's context. - Move the "Posting long comments on Windows" section to a new references/long-comments-on-windows.md verbatim. - Strip the section from SKILL.md (56 fewer lines in the always-loaded surface). - Add the new file to the Reference Files table in SKILL.md with a one-line "when to read" hint covering --discussion, --description, and --content failures on Windows. - Update the two pointer comments in references/boards-and-iterations.md to point at the new reference file instead of the SKILL.md section. docs/README.skills.md regenerated by 'npm run build' to pick up the new reference file in the skill's bundled assets column.
96 lines
4.2 KiB
Markdown
96 lines
4.2 KiB
Markdown
---
|
|
name: azure-devops-cli
|
|
description: Manage Azure DevOps resources via CLI including projects, repos, pipelines, builds, pull requests, work items, artifacts, and service endpoints. Use when working with Azure DevOps, az commands, devops automation, CI/CD, or when user mentions Azure DevOps CLI.
|
|
---
|
|
|
|
# Azure DevOps CLI
|
|
|
|
Manage Azure DevOps resources using the Azure CLI with the Azure DevOps extension.
|
|
|
|
**CLI Version:** 2.81.0 (current as of 2025)
|
|
|
|
## Prerequisites
|
|
|
|
```bash
|
|
# Install Azure CLI
|
|
brew install azure-cli # macOS
|
|
curl -sL https://aka.ms/InstallAzureCLIDeb | sudo bash # Linux
|
|
|
|
# Install Azure DevOps extension
|
|
az extension add --name azure-devops
|
|
```
|
|
|
|
## Authentication
|
|
|
|
```bash
|
|
# Login with PAT token
|
|
az devops login --organization https://dev.azure.com/{org} --token YOUR_PAT_TOKEN
|
|
|
|
# Set default organization and project (avoids repeating --org/--project)
|
|
# Note: Legacy URL https://{org}.visualstudio.com should be replaced with https://dev.azure.com/{org}
|
|
az devops configure --defaults organization=https://dev.azure.com/{org} project={project}
|
|
|
|
# List current configuration
|
|
az devops configure --list
|
|
```
|
|
|
|
## CLI Structure
|
|
|
|
```
|
|
az devops # Main DevOps commands
|
|
├── admin # Administration (banner)
|
|
├── extension # Extension management
|
|
├── project # Team projects
|
|
├── security # Security operations
|
|
│ ├── group # Security groups
|
|
│ └── permission # Security permissions
|
|
├── service-endpoint # Service connections
|
|
├── team # Teams
|
|
├── user # Users
|
|
├── wiki # Wikis
|
|
├── configure # Set defaults
|
|
├── invoke # Invoke REST API
|
|
├── login # Authenticate
|
|
└── logout # Clear credentials
|
|
|
|
az pipelines # Azure Pipelines
|
|
├── agent # Agents
|
|
├── build # Builds
|
|
├── folder # Pipeline folders
|
|
├── pool # Agent pools
|
|
├── queue # Agent queues
|
|
├── release # Releases
|
|
├── runs # Pipeline runs
|
|
├── variable # Pipeline variables
|
|
└── variable-group # Variable groups
|
|
|
|
az boards # Azure Boards
|
|
├── area # Area paths
|
|
├── iteration # Iterations
|
|
└── work-item # Work items
|
|
|
|
az repos # Azure Repos
|
|
├── import # Git imports
|
|
├── policy # Branch policies
|
|
├── pr # Pull requests
|
|
└── ref # Git references
|
|
|
|
az artifacts # Azure Artifacts
|
|
└── universal # Universal Packages
|
|
```
|
|
|
|
## Reference Files
|
|
|
|
Read the relevant reference file based on the user's task. Each file contains complete command syntax and examples for its domain.
|
|
|
|
| File | When to read | Covers |
|
|
|---|---|---|
|
|
| `references/repos-and-prs.md` | Repos, branches, pull requests, branch policies | Repositories, Import, PRs (create/list/vote/reviewers/policies), Git refs, Branch policies |
|
|
| `references/pipelines-and-builds.md` | Pipelines, builds, releases, artifacts | Pipelines CRUD, runs, builds, releases, artifacts download/upload |
|
|
| `references/boards-and-iterations.md` | Work items, sprints, area paths | Work items (WIQL/create/update/relations), Area paths, Iterations, Team iterations |
|
|
| `references/variables-and-agents.md` | Pipeline variables, agent pools | Pipeline variables, Variable groups, Pipeline folders, Agent pools/queues |
|
|
| `references/org-and-security.md` | Projects, teams, users, permissions, wikis | Projects, Extensions, Teams, Users, Security groups/permissions, Service endpoints, Wikis, Admin |
|
|
| `references/advanced-usage.md` | Output formatting, JMESPath queries | Output formats, JMESPath queries (basic + advanced), Global args, Common params, Git aliases |
|
|
| `references/workflows-and-patterns.md` | Automation scripts, best practices, error handling | Common workflows, Best practices, Error handling, Scripting patterns, Real-world examples |
|
|
| `references/long-comments-on-windows.md` | Long `--discussion`, `--description`, or `--content` values failing on Windows | The `cmd.exe` 8191 char cap on `az.cmd`, shell detection, and three verified workarounds (`azps.ps1`, native `--file-path`, `az devops invoke --in-file`) |
|