chore: Enhance error handling and user guidance in scripts and documentation#702
Merged
Conversation
Pavan-Microsoft
requested review from
Avijit-Microsoft,
Prajwal-Microsoft,
Roopan-Microsoft,
Vinay-Microsoft,
aniaroramsft,
brittneek,
dgp10801,
nchandhi and
toherman-msft
as code owners
December 19, 2025 12:04
…h issues & refactored bicep
fix: Fixed deployment script issue for AVM module, fixed relative path issues & refactored bicep
Roopan-Microsoft
approved these changes
Dec 23, 2025
Contributor
|
🎉 This PR is included in version 3.17.1 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose
This pull request focuses on improving the robustness and clarity of deployment and data processing scripts, especially around Azure authentication and environment setup. The main changes enhance error handling for Azure CLI operations, clarify instructions for users, and ensure the scripts fail gracefully when encountering issues.
Improvements to error handling and robustness in scripts:
infra/scripts/copy_kb_files.shandinfra/scripts/run_create_index_scripts.shto handle expired tokens and failures to retrieve user information, exiting with clear messages if problems persist. [1] [2]infra/scripts/process_sample_data.shto check for failures when querying Azure Storage Account properties, authenticating with Azure CLI, retrieving subscription information, and setting the subscription, ensuring the script exits with informative errors if any step fails. [1] [2] [3] [4]Clarification and improvement of deployment instructions:
azure.yamlanddocuments/DeploymentGuide.mdto instruct users to create and activate a virtual environment before running the sample data processing command, making the setup steps clearer and reducing confusion. [1] [2] [3]Does this introduce a breaking change?
Golden Path Validation
Deployment Validation