Skip to content

{CI} Update references for generate/verify commandIdx to use azdev command #33121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DanielMicrosoft merged 5 commits into from
Apr 2, 2026
+25 −2
Merged

{CI} Update references for generate/verify commandIdx to use azdev command #33121

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
fc2d451
feature: update references to use azdev cmds
DanielMicrosoft Apr 1, 2026
2c8f9b1
test: make sure CI step can fail
DanielMicrosoft Apr 2, 2026
01bbfa3
fix: revert index failure
DanielMicrosoft Apr 2, 2026
07ab7c3
fix: standardize flag name
DanielMicrosoft Apr 2, 2026
bc34365
fix: give option to run azdev or script
DanielMicrosoft Apr 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion azure-pipelines.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1094,7 +1094,7 @@ jobs:
- bash: |
set -ev
. env/bin/activate
python scripts/generate_latest_indices.py verify
azdev latest-index verify --repo .
displayName: 'Verify generated latest indices'
- job: CheckStyle
Expand Down
21 changes: 21 additions & 0 deletions doc/authoring_command_modules/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,27 @@ Style Checks
azdev style <module> [--pylint] [--pep8]
```

Latest Packaged Indices
-----------------------

Use azdev wrappers around Azure CLI's latest index generation script:

```
azdev latest-index generate
azdev latest-index verify
```

You can pass an explicit Azure CLI checkout path when needed:

```
azdev latest-index generate --cli /path/to/azure-cli
azdev latest-index verify --cli /path/to/azure-cli
```

`azdev latest-index verify` exits non-zero when generated output differs from
the checked-in `commandIndex.latest.json` or `helpIndex.latest.json`, making it
CI-friendly.

Submitting Pull Requests
------------------------

Expand Down
4 changes: 3 additions & 1 deletion scripts/generate_latest_indices.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,9 @@ def _run_verify(command_text, help_text):
print('Generated latest index files are out of date:')
for path in mismatched:
print(f' - {path.relative_to(REPO_ROOT)}')
print('Run:')
print('Run either:')
print(' azdev latest-index generate --cli .')
print('or:')
print(' python scripts/generate_latest_indices.py generate')
return 1

Expand Down
Loading