Skip to content

refactor: scripts for improved logging and error handling; remove redundant code and streamline role assignments in Azure CLI scripts#693

Merged
Avijit-Microsoft merged 2 commits into
devfrom
pk-km-sampledata-manual
Dec 16, 2025
Merged

refactor: scripts for improved logging and error handling; remove redundant code and streamline role assignments in Azure CLI scripts#693
Avijit-Microsoft merged 2 commits into
devfrom
pk-km-sampledata-manual

Conversation

@Pavan-Microsoft

Copy link
Copy Markdown
Contributor

Purpose

This pull request focuses on improving the clarity, user experience, and output consistency of deployment scripts and documentation. The main changes include refining setup instructions, streamlining and clarifying script outputs, and reducing unnecessary or verbose logging in automation scripts.

Documentation improvements:

  • Updated Python version requirements in DeploymentGuide.md and LocalDebuggingSetup.md to allow any version 3.9 or newer, instead of restricting to 3.9–3.11, making setup more flexible. [1] [2]
  • Enhanced deployment steps in DeploymentGuide.md with clearer instructions for setting up virtual environments, Azure login (including device code), and running sample data scripts. Steps were reorganized and clarified for different environments (Codespaces, Dev Container, etc.). [1] [2]

Script output and UX improvements:

  • Standardized and simplified output messages across deployment and data scripts to use concise, success-oriented feedback (e.g., ✓ Created user: ..., ✓ Uploading call transcripts). Reduced or removed verbose and redundant print statements for a cleaner user experience. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15] [16] [17] [18]

Quality-of-life and error handling:

  • Improved error handling and logic in shell scripts, such as using device code for Azure CLI login when not already authenticated and providing clearer error messages for role assignment failures.
  • Removed unnecessary script startup and completion messages to focus on actionable feedback.

These changes collectively make the deployment and setup process more robust, user-friendly, and maintainable, reducing confusion and improving the signal-to-noise ratio in script outputs.

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.

…ndant code and streamline role assignments in Azure CLI scripts
@Avijit-Microsoft
Avijit-Microsoft merged commit 1b0be78 into dev Dec 16, 2025
5 checks passed
@github-actions

Copy link
Copy Markdown
Contributor

🎉 This PR is included in version 3.17.0 🎉

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.

2 participants