Skip to content

chore: Enhance error handling and user guidance in scripts and documentation#702

Merged
Roopan-Microsoft merged 4 commits into
mainfrom
dev
Dec 23, 2025
Merged

chore: Enhance error handling and user guidance in scripts and documentation#702
Roopan-Microsoft merged 4 commits into
mainfrom
dev

Conversation

@Pavan-Microsoft

Copy link
Copy Markdown
Contributor

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:

  • Added comprehensive error checks and user re-authentication flows in infra/scripts/copy_kb_files.sh and infra/scripts/run_create_index_scripts.sh to handle expired tokens and failures to retrieve user information, exiting with clear messages if problems persist. [1] [2]
  • Enhanced infra/scripts/process_sample_data.sh to 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:

  • Updated user-facing messages in azure.yaml and documents/DeploymentGuide.md to 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?

  • Yes
  • No

Golden Path Validation

  • I have tested the primary workflows (the "golden path") to ensure they function correctly without errors.

Deployment Validation

  • I have validated the deployment process successfully and all services are running as expected with this change.

Prajwal D C and others added 2 commits December 19, 2025 22:29
fix: Fixed deployment script issue for AVM module, fixed relative path issues & refactored bicep
@Roopan-Microsoft
Roopan-Microsoft merged commit 48753f1 into main Dec 23, 2025
9 checks passed
@github-actions

Copy link
Copy Markdown
Contributor

🎉 This PR is included in version 3.17.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants