feat: Improve Developer Experience by Abdul-Microsoft · Pull Request #973 · microsoft/Multi-Agent-Custom-Automation-Engine-Solution-Accelerator

Abdul-Microsoft · 2026-05-08T12:28:50Z

Purpose

This pull request adds comprehensive documentation for automating both local development setup and deployment of local changes to Azure using cross-platform scripts. The documentation covers prerequisites, detailed workflows, usage examples, and troubleshooting for both processes.

Local Development Setup Documentation (AutomatedLocalSetup.md):

Introduces and documents two scripts (setup_local_dev.sh for Linux/macOS/WSL and setup_local_dev.ps1 for Windows PowerShell) that automate the entire local development environment setup, including Azure authentication, environment file generation, dependency installation, RBAC role assignment, and VS Code configuration.
Details all prerequisites, step-by-step actions performed by the scripts, command-line options, usage examples, and troubleshooting tips.

Deployment to Azure Documentation (DeployLocalChanges.md):

Adds documentation for two deployment scripts (deploy_to_azure.sh for Linux/macOS/WSL and deploy_to_azure.ps1 for Windows PowerShell) that detect changed services, build and push Docker images, and update Azure resources.
Explains prerequisites, change detection logic using git diff, ACR selection and authentication, command-line options, usage examples, and rollback instructions.

Does this introduce a breaking change?

Yes
No

How to Test

Get the code

git clone [repo-address]
cd [repo-name]
git checkout [branch-name]
npm install

Test the code

What to Check

Verify that the following are valid

...

Other Information

- setup_local_dev.sh/.ps1: Automates full local development setup - Prerequisite checks with detailed install guidance - Azure config fetch from Resource Group (container app or individual resources) - RBAC role assignment with pre-check (Cosmos DB, AI Foundry, Search, Storage) - Virtual environment setup for backend, MCP server, and frontend - VS Code settings and launch.json generation - Auto-fix for .venv lock issues (VS Code Python extension) - deploy_to_azure.sh/.ps1: Deploys local code changes to Azure - Builds Docker images for selected services (backend, mcp, frontend) - Pushes to ACR with unique timestamp+git-sha tags - Updates Container Apps and App Service with new images - ACR discovery, creation, and AcrPull role assignment - Dry-run mode, build-only/deploy-only modes - Rollback commands printed after deployment - .gitignore: Added local dev artifacts (.macae_*.pid, start_all_services.sh) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

…signment, and change detection

…Linux/macOS and Windows

Copilot

Pull request overview

This PR adds cross-platform automation for setting up a local development environment and deploying local code changes to Azure, along with new documentation describing both workflows.

Changes:

Add setup_local_dev.sh / setup_local_dev.ps1 to automate local environment setup (Azure auth, .env generation, dependency install, RBAC, VS Code config).
Add deploy_to_azure.sh / deploy_to_azure.ps1 to build/push only changed services and update Azure resources.
Add new docs for both workflows and update .gitignore for local artifacts.

Reviewed changes

Copilot reviewed 6 out of 7 changed files in this pull request and generated 20 comments.

Show a summary per file

File	Description
setup_local_dev.sh	Bash-based local setup automation (config discovery, env generation, RBAC, installs, VS Code config).
setup_local_dev.ps1	PowerShell-based local setup automation with similar workflow on Windows.
deploy_to_azure.sh	Bash deployment helper for building/pushing images and updating Azure resources.
deploy_to_azure.ps1	PowerShell deployment helper mirroring the bash script.
docs/AutomatedLocalSetup.md	New documentation for automated local setup scripts.
docs/DeployLocalChanges.md	New documentation for deploying local changes scripts.
.gitignore	Ignore additional local dev artifacts.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Remove local dev setup artifacts from .gitignore

Copilot

Pull request overview

Copilot reviewed 6 out of 7 changed files in this pull request and generated 9 comments.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

- Fix Write-LogWarn crash from extra -ForegroundColor parameter (deploy_to_azure.ps1) - Fix misleading git diff warning message in both deploy scripts - Change -r to -g short flag for --resource-group to match docs (setup_local_dev.sh) - Gate RBAC assignment behind --assign-rbac / -AssignRbac flag (both setup scripts) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated 5 comments.

RBAC roles are essential for local dev and should always be assigned. The script already skips roles that are already assigned, so running unconditionally is safe and simplifies the user experience. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Moved all 4 scripts to scripts/ directory and updated all references in docs/AutomatedLocalSetup.md and docs/DeployLocalChanges.md. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated 6 comments.

Scripts now compute REPO_ROOT as two levels up from their location in infra/scripts/, so all src/ and .azure/ paths resolve correctly. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated 10 comments.

+    if command -v docker &>/dev/null; then
+        log_success "Docker found: $(docker --version)"
+    else
+        missing+=("docker")
+    fi
+
+    if command -v az &>/dev/null; then
+        log_success "Azure CLI found"
+    else
+        missing+=("azure-cli")
+    fi


+            log_warn "No service-specific changes detected (no uncommitted changes vs HEAD)."
+            echo ""
+            read -rp "No changes detected. Deploy all services anyway? [y/N]: " confirm
+            if [[ "${confirm,,}" == "y" || "${confirm,,}" == "yes" ]]; then


+    log_info "Generating .env file at: $env_file"
+
+    declare -A env_vars
+    while IFS= read -r line; do
+        line="${line%%$'\r'}"
+        [[ -z "$line" || "$line" == \#* ]] && continue


+AZURE_OPENAI_RAI_DEPLOYMENT_NAME=${env_vars[AZURE_OPENAI_RAI_DEPLOYMENT_NAME]:-gpt-4.1}
+AZURE_OPENAI_API_VERSION=${env_vars[AZURE_OPENAI_API_VERSION]:-2024-12-01-preview}
+REASONING_MODEL_NAME=${env_vars[REASONING_MODEL_NAME]:-o4-mini}
+SUPPORTED_MODELS=${env_vars[SUPPORTED_MODELS]:-["o3","o4-mini","gpt-4.1","gpt-4.1-mini"]}


+        cat > "$settings_file" << 'SETEOF'
+{
+    "python.defaultInterpreterPath": "${workspaceFolder}/src/backend/.venv/Scripts/python.exe",
+    "python.terminal.activateEnvironment": true,
+    "python.linting.enabled": true,
+    "python.formatting.provider": "black",
+    "python.debugging.logLevel": "Debug",
+    "debug.inlineValues": "on",
+    "files.exclude": {


+COSMOSDB_ENDPOINT=$($envVars["COSMOSDB_ENDPOINT"])
+COSMOSDB_DATABASE=$($envVars["COSMOSDB_DATABASE"] ?? "macae")
+COSMOSDB_CONTAINER=$($envVars["COSMOSDB_CONTAINER"] ?? "memory")
+
+# --- Azure OpenAI ---
+AZURE_OPENAI_ENDPOINT=$($envVars["AZURE_OPENAI_ENDPOINT"])
+AZURE_OPENAI_MODEL_NAME=$($envVars["AZURE_OPENAI_MODEL_NAME"] ?? "gpt-4.1-mini")
+AZURE_OPENAI_DEPLOYMENT_NAME=$($envVars["AZURE_OPENAI_DEPLOYMENT_NAME"] ?? "gpt-4.1-mini")
+AZURE_OPENAI_RAI_DEPLOYMENT_NAME=$($envVars["AZURE_OPENAI_RAI_DEPLOYMENT_NAME"] ?? "gpt-4.1")
+AZURE_OPENAI_API_VERSION=$($envVars["AZURE_OPENAI_API_VERSION"] ?? "2024-12-01-preview")
+REASONING_MODEL_NAME=$($envVars["REASONING_MODEL_NAME"] ?? "o4-mini")
+SUPPORTED_MODELS=$($envVars["SUPPORTED_MODELS"] ?? '["o3","o4-mini","gpt-4.1","gpt-4.1-mini"]')
+
+# --- Azure AI Foundry ---
+AZURE_AI_SUBSCRIPTION_ID=$($envVars["AZURE_AI_SUBSCRIPTION_ID"])
+AZURE_AI_RESOURCE_GROUP=$($envVars["AZURE_AI_RESOURCE_GROUP"])
+AZURE_AI_PROJECT_NAME=$($envVars["AZURE_AI_PROJECT_NAME"])
+AZURE_AI_PROJECT_ENDPOINT=$($envVars["AZURE_AI_PROJECT_ENDPOINT"])
+AZURE_AI_AGENT_ENDPOINT=$($envVars["AZURE_AI_AGENT_ENDPOINT"])
+AZURE_AI_AGENT_MODEL_DEPLOYMENT_NAME=$($envVars["AZURE_AI_AGENT_MODEL_DEPLOYMENT_NAME"] ?? "gpt-4.1-mini")
+AZURE_AI_AGENT_API_VERSION=$($envVars["AZURE_AI_AGENT_API_VERSION"] ?? "2025-05-01-preview")
+AZURE_AI_AGENT_PROJECT_CONNECTION_STRING=$($envVars["AZURE_AI_AGENT_PROJECT_CONNECTION_STRING"])
+AZURE_COGNITIVE_SERVICES=$($envVars["AZURE_COGNITIVE_SERVICES"] ?? "https://cognitiveservices.azure.com/.default")


+    Write-LogWarn "Execution policy is Restricted. Setting to RemoteSigned..."
+    Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser -Force


+            az webapp config appsettings set --name $script:FrontendApp --resource-group $ResourceGroup `
+                --settings DOCKER_REGISTRY_SERVER_URL="https://$($script:AcrLoginServer)" --output none
+            az webapp config set --name $script:FrontendApp --resource-group $ResourceGroup `
+                --generic-configurations '{\"acrUseManagedIdentityCreds\": true}' --output none


+            az webapp config appsettings set --name $script:FrontendApp --resource-group $ResourceGroup `
+                --settings DOCKER_REGISTRY_SERVER_URL="https://$($script:AcrLoginServer)" --output none
+            az webapp config set --name $script:FrontendApp --resource-group $ResourceGroup `
+                --generic-configurations '{\"acrUseManagedIdentityCreds\": true}' --output none
+            if ($LASTEXITCODE -ne 0) {
+                Write-LogError "Frontend registry config FAILED — image pull may fail."
+            } else {
+                Write-LogSuccess "Frontend registry config updated"
+            }


+# Terminal 2 — MCP Server (port 9000)
+cd src/mcp_server
+source .venv/Scripts/activate
+python mcp_server.py
+
+# Terminal 3 — Frontend (port 3000)
+cd src/App
+npm run dev


…nce in setup scripts

Abdul-Microsoft and others added 3 commits May 6, 2026 11:46

Enhance Azure deployment script with improved error handling, role as…

46ab935

…signment, and change detection

Add automated local development setup documentation with scripts for …

7915908

…Linux/macOS and Windows

Abdul-Microsoft marked this pull request as ready for review May 8, 2026 12:28

Copilot AI review requested due to automatic review settings May 8, 2026 12:28

Abdul-Microsoft requested review from Avijit-Microsoft, Fr4nc3, Prajwal-Microsoft, Roopan-Microsoft, Vinay-Microsoft, aniaroramsft, dgp10801, marktayl1, nchandhi and toherman-msft as code owners May 8, 2026 12:28

Copilot started reviewing on behalf of Abdul-Microsoft May 8, 2026 12:29 View session

Copilot AI reviewed May 8, 2026

View reviewed changes

Clean up .gitignore by removing unnecessary entries

4536355

Remove local dev setup artifacts from .gitignore

Copilot AI review requested due to automatic review settings May 8, 2026 12:37

Copilot started reviewing on behalf of Abdul-Microsoft May 8, 2026 12:38 View session

Copilot AI reviewed May 8, 2026

View reviewed changes

Abdul-Microsoft and others added 2 commits May 8, 2026 18:16

Remove .gitignore from PR changes

978ec27

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot AI review requested due to automatic review settings May 11, 2026 06:39

Copilot started reviewing on behalf of Abdul-Microsoft May 11, 2026 06:40 View session

Copilot AI reviewed May 11, 2026

View reviewed changes

Comment thread infra/scripts/deploy_to_azure.sh

Comment thread infra/scripts/setup_local_dev.sh

Comment thread infra/scripts/setup_local_dev.ps1

Comment thread infra/scripts/deploy_to_azure.sh

Comment thread docs/AutomatedLocalSetup.md Outdated

Abdul-Microsoft and others added 2 commits May 11, 2026 12:16

refactor: Move automation scripts to scripts/ folder

862a064

Moved all 4 scripts to scripts/ directory and updated all references in docs/AutomatedLocalSetup.md and docs/DeployLocalChanges.md. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot AI review requested due to automatic review settings May 11, 2026 07:14

docs: Update script paths to scripts/ folder in documentation

3d0dd43

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot started reviewing on behalf of Abdul-Microsoft May 11, 2026 07:14 View session

refactor: Move automation scripts to infra/scripts/

43560f3

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Abdul-Microsoft temporarily deployed to production May 11, 2026 07:15 — with GitHub Actions Inactive

Copilot AI reviewed May 11, 2026

View reviewed changes

Comment thread docs/AutomatedLocalSetup.md

Comment thread docs/AutomatedLocalSetup.md

Comment thread docs/DeployLocalChanges.md

Comment thread docs/DeployLocalChanges.md

Comment thread docs/AutomatedLocalSetup.md

Comment thread docs/DeployLocalChanges.md

fix: Resolve repo root path correctly from infra/scripts/ location

15a180e

Scripts now compute REPO_ROOT as two levels up from their location in infra/scripts/, so all src/ and .azure/ paths resolve correctly. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Abdul-Microsoft temporarily deployed to production May 11, 2026 07:24 — with GitHub Actions Inactive

fix: Correctly resolve repo root path in setup_local_dev.ps1 script

fe60b9d

Copilot AI review requested due to automatic review settings May 11, 2026 08:37

Abdul-Microsoft temporarily deployed to production May 11, 2026 08:37 — with GitHub Actions Inactive

Copilot started reviewing on behalf of Abdul-Microsoft May 11, 2026 08:38 View session

Copilot AI reviewed May 11, 2026

View reviewed changes

refactor: Update setup instructions and improve service startup guida…

e5dc378

…nce in setup scripts

Abdul-Microsoft temporarily deployed to production May 20, 2026 07:34 — with GitHub Actions Inactive

		Write-LogWarn "Execution policy is Restricted. Setting to RemoteSigned..."
		Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser -Force

Conversation

Abdul-Microsoft commented May 8, 2026

Purpose

Does this introduce a breaking change?

How to Test

What to Check

Other Information

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants