Skip to content

Conversation

@NirajC-Microsoft
Copy link
Contributor

Purpose

This pull request introduces several documentation enhancements and deployment improvements, primarily focusing on expanding troubleshooting guidance, adding a new guide for Azure Container Registry (ACR) image management, and improving tagging and metadata in deployment scripts and infrastructure templates. Additionally, minor improvements were made to end-to-end tests for better reliability.

Documentation Enhancements:

  • Added a comprehensive new guide ACRBuildAndPushGuide.md that provides step-by-step instructions for building and pushing Docker images to Azure Container Registry, including prerequisites, build/push commands, and manual image update steps for both Backend and WebApp services.
  • Significantly expanded TroubleShootingSteps.md with new troubleshooting entries for a wide range of Azure deployment errors (e.g., InvalidRequestContent, ReadOnlyDisabledSubscription, SkuNotAvailable, PrincipalNotFound, RedundancyConfigurationNotAvailable, etc.), including detailed causes, resolutions, and relevant documentation links. Also improved clarity and accuracy in existing error explanations and updated support links. [1] [2] [3] [4] [5] F9d75360L321, F9d75360L352)
  • Updated error code groupings and added clarifications for specific error messages (e.g., array index out of bounds in resource IDs). [1] [2]

Deployment and Infrastructure Improvements:

  • Enhanced .github/workflows/CAdeploy.yml to add timestamp-based tagging to deployments, improving traceability by including a CreatedDate tag with each deployment.
  • Updated the infra/main.bicep template to improve the logic for the createdBy tag, using the user principal name if available, otherwise falling back to the object ID, and updated the TemplateName tag to reflect whether private networking is enabled.

Testing Improvements:

  • Improved reliability of the delete_chat_history end-to-end test by adjusting wait times for UI actions to better accommodate asynchronous UI updates.
  • ...

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.

What to Check

Verify that the following are valid

  • ...

Other Information

VishalS-Microsoft and others added 2 commits September 22, 2025 14:09
* CI Pipeline fix for Client Advisor

* added tags in CAdeploy.yml file

* add my feature branch

* tags changes updated in CAdeploy.yml file

* added template name condition based

* removed my feature branch from pipeline

* Additional Troubleshooting steps
… bice… (#678)

* Remove createdby from pipeline and add change Createdby logic in bicep file

* Add 'createdBy' parameter to Azure deployment

* Add 'createdBy' parameter for tagging
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This pull request introduces comprehensive documentation enhancements, deployment improvements, and testing reliability fixes. The primary focus is on expanding troubleshooting guidance and adding container registry management documentation.

  • Enhanced troubleshooting documentation with 15+ new error scenarios and improved existing error descriptions
  • Added new ACR Build and Push Guide for Docker image management
  • Improved deployment tagging and metadata in CI/CD workflows and infrastructure templates
  • Fixed end-to-end test timing issues for better reliability

Reviewed Changes

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

Show a summary per file
File Description
docs/TroubleShootingSteps.md Expanded troubleshooting guide with new Azure deployment errors and improved existing error descriptions
docs/ACRBuildAndPushGuide.md New comprehensive guide for building and pushing Docker images to Azure Container Registry
.github/workflows/CAdeploy.yml Added timestamp-based tagging to deployments for better traceability
infra/main.bicep Improved tag logic for created by user and template name based on networking configuration
tests/e2e-test/pages/homePage.py Adjusted wait times in delete chat history test for better reliability

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@Roopan-Microsoft Roopan-Microsoft merged commit 7a86f2c into main Sep 29, 2025
14 checks passed
@github-actions
Copy link

🎉 This PR is included in version 1.9.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Roopan-Microsoft pushed a commit that referenced this pull request Oct 1, 2025
…emoved the unsued params (#690)

* fix: Dev to main (#681)

* fix: added tags in CAdeploy.yml file (#675)

* CI Pipeline fix for Client Advisor

* added tags in CAdeploy.yml file

* add my feature branch

* tags changes updated in CAdeploy.yml file

* added template name condition based

* removed my feature branch from pipeline

* Additional Troubleshooting steps

* fix: Remove createdby from pipeline and add change Createdby logic in bice… (#678)

* Remove createdby from pipeline and add change Createdby logic in bicep file

* Add 'createdBy' parameter to Azure deployment

* Add 'createdBy' parameter for tagging

* added new 'type' tag (#682)

* Update docs/TroubleShootingSteps.md

Co-authored-by: Copilot <[email protected]>

* Update GitHub Issues link in troubleshooting steps

---------

Co-authored-by: VishalS-Microsoft <[email protected]>
Co-authored-by: Harsh-Microsoft <[email protected]>
Co-authored-by: Copilot <[email protected]>

* fix: Removed commented params

* Update README and azure.yml for minimum azd version 1.18.0

---------

Co-authored-by: NirajC-Microsoft <[email protected]>
Co-authored-by: VishalS-Microsoft <[email protected]>
Co-authored-by: Harsh-Microsoft <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Prajwal D C <[email protected]>
Roopan-Microsoft added a commit that referenced this pull request Oct 3, 2025
…on & updated docs (#692)

* fix: added tags in CAdeploy.yml file (#675)

* CI Pipeline fix for Client Advisor

* added tags in CAdeploy.yml file

* add my feature branch

* tags changes updated in CAdeploy.yml file

* added template name condition based

* removed my feature branch from pipeline

* Additional Troubleshooting steps

* fix: Remove createdby from pipeline and add change Createdby logic in bice… (#678)

* Remove createdby from pipeline and add change Createdby logic in bicep file

* Add 'createdBy' parameter to Azure deployment

* Add 'createdBy' parameter for tagging

* added new 'type' tag (#682)

* Create new Managed Identity for SQL operations with least privileges

* Update docs/TroubleShootingSteps.md

Co-authored-by: Copilot <[email protected]>

* Update GitHub Issues link in troubleshooting steps

* removed SQL user assigned identity from key vault and SQL DB module

* Refactor DNS zone naming and update SQL database redundancy settings

* fix pylint issues

* refactor: Update README, azure.yml for minimum azd version 1.18.0 & removed the unsued params (#690)

* fix: Dev to main (#681)

* fix: added tags in CAdeploy.yml file (#675)

* CI Pipeline fix for Client Advisor

* added tags in CAdeploy.yml file

* add my feature branch

* tags changes updated in CAdeploy.yml file

* added template name condition based

* removed my feature branch from pipeline

* Additional Troubleshooting steps

* fix: Remove createdby from pipeline and add change Createdby logic in bice… (#678)

* Remove createdby from pipeline and add change Createdby logic in bicep file

* Add 'createdBy' parameter to Azure deployment

* Add 'createdBy' parameter for tagging

* added new 'type' tag (#682)

* Update docs/TroubleShootingSteps.md

Co-authored-by: Copilot <[email protected]>

* Update GitHub Issues link in troubleshooting steps

---------

Co-authored-by: VishalS-Microsoft <[email protected]>
Co-authored-by: Harsh-Microsoft <[email protected]>
Co-authored-by: Copilot <[email protected]>

* fix: Removed commented params

* Update README and azure.yml for minimum azd version 1.18.0

---------

Co-authored-by: NirajC-Microsoft <[email protected]>
Co-authored-by: VishalS-Microsoft <[email protected]>
Co-authored-by: Harsh-Microsoft <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Prajwal D C <[email protected]>

* Update Azure template validation action to latest version

* Update azure-dev.yml

* Update azure-dev.yml

* Chore: Disable Dev Container usage in Azure validation step

Disable the use of Dev Container for Azure template validation.

* chore: Refactor Azure DevOps workflow configuration

* fix: Rename main.bicep for network module

* chore: Update Azure template validation action version

* chore: Add validateTests parameter to Azure Dev workflow

* chore: Update Azure template validation action version

* fix post deployment script to support exp

* refactor: Comments fixed

---------

Co-authored-by: VishalS-Microsoft <[email protected]>
Co-authored-by: NirajC-Microsoft <[email protected]>
Co-authored-by: Harsh-Microsoft <[email protected]>
Co-authored-by: Vamshi-Microsoft <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Roopan-Microsoft <[email protected]>
@github-actions
Copy link

github-actions bot commented Oct 3, 2025

🎉 This PR is included in version 1.9.2 🎉

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.

4 participants