-
+
Solution overview
-It leverages Azure OpenAI Service and Azure AI Search, to identify relevant documents, summarize unstructured information, and generate document templates.
+This solution leverages Microsoft Foundry, Azure AI Search, Azure Cosmos DB, and Azure Blob Storage to interpret creative briefs, retrieve product information, generate marketing content, and validate brand compliance.
-The sample data is sourced from generic AI-generated promissory notes. The documents are intended for use as sample data only.
+The sample data includes synthetic product catalogs and brand guidelines. The data is intended for use as sample data only.
### Solution architecture
-||
+||
|---|
@@ -35,7 +32,9 @@ The sample data is sourced from generic AI-generated promissory notes. The docum
[Azure OpenAI Service](https://learn.microsoft.com/en-us/azure/ai-services/openai/)
-[Azure AI Search](https://learn.microsoft.com/en-us/azure/search/)
+[Microsoft Agent Framework](https://github.com/microsoft/agent-framework)
+
+[Azure Cosmos DB](https://learn.microsoft.com/en-us/azure/cosmos-db/)
[Azure AI Foundry](https://learn.microsoft.com/en-us/azure/ai-studio/)
@@ -46,21 +45,22 @@ The sample data is sourced from generic AI-generated promissory notes. The docum
Click to learn more about the key features this solution enables
- - **Semantic search**
- Azure AI Search to enable RAG and grounding of the application on the processed dataset.
-
- - **Summarization**
- Azure OpenAI Service and GPT models to help summarize the search content and answer questions.
+ - **Creative Brief Interpretation**
+ Parse free-text creative briefs into structured fields (overview, objectives, target audience, key message, tone/style, deliverable, timelines, visual guidelines, CTA).
- - **Content generation**
- Azure OpenAI Service and GPT models to help generate relevant content with Prompt Flow.
-
-
+ - **Multimodal Content Generation**
+ Generate marketing copy and images using GPT models and DALL-E 3 grounded in enterprise product data.
+ - **Brand Compliance Validation**
+ Validate all generated content against brand guidelines with severity-categorized feedback (Error, Warning, Info).
+ - **Specialized Agent Orchestration**
+ Uses Microsoft Agent Framework with HandoffBuilder to coordinate Triage, Planning, Research, Text Content, Image Content, and Compliance agents.
+
+
-
+
Quick deploy
@@ -69,13 +69,10 @@ Follow the quick deploy steps on the deployment guide to deploy this solution to
> **Note:** This solution accelerator requires **Azure Developer CLI (azd) version 1.18.0 or higher**. Please ensure you have the latest version installed before proceeding with deployment. [Download azd here](https://learn.microsoft.com/en-us/azure/developer/azure-developer-cli/install-azd).
-[Click here to launch the deployment guide](./docs/DeploymentGuide.md)
+[Click here to launch the deployment guide](./content-gen/docs/DEPLOYMENT.md)
-**For Local Development**
-- [Local Development Setup Guide](docs/LocalDevelopmentSetup.md) - Comprehensive setup instructions for Windows, Linux, and macOS
-
-| [](https://codespaces.new/microsoft/document-generation-solution-accelerator) | [](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/microsoft/document-generation-solution-accelerator) | [&message=Open&color=blue&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/azure/?vscode-azure-exp=foundry&agentPayload=eyJiYXNlVXJsIjogImh0dHBzOi8vcmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbS9taWNyb3NvZnQvZG9jdW1lbnQtZ2VuZXJhdGlvbi1zb2x1dGlvbi1hY2NlbGVyYXRvci9yZWZzL2hlYWRzL21haW4vaW5mcmEvdnNjb2RlX3dlYiIsICJpbmRleFVybCI6ICIvaW5kZXguanNvbiIsICJ2YXJpYWJsZXMiOiB7ImFnZW50SWQiOiAiIiwgImNvbm5lY3Rpb25TdHJpbmciOiAiIiwgInRocmVhZElkIjogIiIsICJ1c2VyTWVzc2FnZSI6ICIiLCAicGxheWdyb3VuZE5hbWUiOiAiIiwgImxvY2F0aW9uIjogIiIsICJzdWJzY3JpcHRpb25JZCI6ICIiLCAicmVzb3VyY2VJZCI6ICIiLCAicHJvamVjdFJlc291cmNlSWQiOiAiIiwgImVuZHBvaW50IjogIiJ9LCAiY29kZVJvdXRlIjogWyJhaS1wcm9qZWN0cy1zZGsiLCAicHl0aG9uIiwgImRlZmF1bHQtYXp1cmUtYXV0aCIsICJlbmRwb2ludCJdfQ==) |
+| [](https://codespaces.new/hunterjam/content-generation-solution-accelerator) | [](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/hunterjam/content-generation-solution-accelerator) | [&message=Open&color=blue&logo=visualstudiocode&logoColor=white)](https://vscode.dev/azure/?vscode-azure-exp=foundry&agentPayload=eyJiYXNlVXJsIjogImh0dHBzOi8vcmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbS9odW50ZXJqYW0vY29udGVudC1nZW5lcmF0aW9uLXNvbHV0aW9uLWFjY2VsZXJhdG9yL3JlZnMvaGVhZHMvbWFpbi9jb250ZW50LWdlbi9pbmZyYS92c2NvZGVfd2ViIiwgImluZGV4VXJsIjogIi9pbmRleC5qc29uIiwgInZhcmlhYmxlcyI6IHsiYWdlbnRJZCI6ICIiLCAiY29ubmVjdGlvblN0cmluZyI6ICIiLCAidGhyZWFkSWQiOiAiIiwgInVzZXJNZXNzYWdlIjogIiIsICJwbGF5Z3JvdW5kTmFtZSI6ICIiLCAibG9jYXRpb24iOiAiIiwgInN1YnNjcmlwdGlvbklkIjogIiIsICJyZXNvdXJjZUlkIjogIiIsICJwcm9qZWN0UmVzb3VyY2VJZCI6ICIiLCAiZW5kcG9pbnQiOiAiIn0sICJjb2RlUm91dGUiOiBbImFpLXByb2plY3RzLXNkayIsICJweXRob24iLCAiZGVmYXVsdC1henVyZS1hdXRoIiwgImVuZHBvaW50Il19) |
|---|---|---|
@@ -104,14 +101,13 @@ _Note: This is not meant to outline all costs as selected SKUs, scaled use, cust
| Product | Description | Cost |
|---|---|---|
| [Azure AI Foundry](https://learn.microsoft.com/en-us/azure/ai-foundry/) | Free tier. Build generative AI applications on an enterprise-grade platform. | [Pricing](https://azure.microsoft.com/pricing/details/ai-studio/) |
-| [Azure AI Search](https://learn.microsoft.com/en-us/azure/search/) | Standard tier, S1. Pricing is based on the number of documents and operations. Information retrieval at scale for vector and text content in traditional or generative search scenarios. | [Pricing](https://azure.microsoft.com/pricing/details/search/) |
-| [Azure Storage Account](https://learn.microsoft.com/en-us/azure/storage/blobs/) | Standard tier, LRS. Pricing is based on storage and operations. Blob storage in the clopud, optimized for storing massive amounts of unstructured data. | [Pricing](https://azure.microsoft.com/pricing/details/storage/blobs/) |
-| [Azure Key Vault](https://learn.microsoft.com/en-us/azure/key-vault/) | Standard tier. Pricing is based on the number of operations. Maintain keys that access and encrypt your cloud resources, apps, and solutions. | [Pricing](https://azure.microsoft.com/pricing/details/key-vault/) |
-| [Azure AI Services](https://learn.microsoft.com/en-us/azure/ai-services/) | S0 tier, defaults to gpt-4.1 and text-embedding-ada-002 models. Pricing is based on token count. | [Pricing](https://azure.microsoft.com/pricing/details/cognitive-services/) |
-| [Azure Container App](https://learn.microsoft.com/en-us/azure/container-apps/) | Consumption tier with 0.5 CPU, 1GiB memory/storage. Pricing is based on resource allocation, and each month allows for a certain amount of free usage. Allows you to run containerized applications without worrying about orchestration or infrastructure. | [Pricing](https://azure.microsoft.com/pricing/details/container-apps/) |
+| [Azure Storage Account](https://learn.microsoft.com/en-us/azure/storage/blobs/) | Standard tier, LRS. Pricing is based on storage and operations. Blob storage for product images and generated content. | [Pricing](https://azure.microsoft.com/pricing/details/storage/blobs/) |
+| [Azure AI Services](https://learn.microsoft.com/en-us/azure/ai-services/) | S0 tier, defaults to gpt-5.1 (GPT) and gpt-image-1 (DALL-E 3) models. Pricing is based on token count. | [Pricing](https://azure.microsoft.com/pricing/details/cognitive-services/) |
+| [Azure Container Instance](https://learn.microsoft.com/en-us/azure/container-instances/) | Backend API hosting with private VNet integration. Pricing is based on resource allocation. | [Pricing](https://azure.microsoft.com/pricing/details/container-instances/) |
+| [Azure App Service](https://learn.microsoft.com/en-us/azure/app-service/) | B1 tier. Frontend hosting with Node.js proxy server. | [Pricing](https://azure.microsoft.com/pricing/details/app-service/) |
| [Azure Container Registry](https://learn.microsoft.com/en-us/azure/container-registry/) | Basic tier. Build, store, and manage container images and artifacts in a private registry for all types of container deployments | [Pricing](https://azure.microsoft.com/pricing/details/container-registry/) |
| [Log analytics](https://learn.microsoft.com/en-us/azure/azure-monitor/) | Pay-as-you-go tier. Costs based on data ingested. Collect and analyze on telemetry data generated by Azure. | [Pricing](https://azure.microsoft.com/pricing/details/monitor/) |
-| [Azure Cosmos DB](https://learn.microsoft.com/en-us/azure/cosmos-db/) | Fully managed, distributed NoSQL, relational, and vector database for modern app development. | [Pricing](https://azure.microsoft.com/en-us/pricing/details/cosmos-db/autoscale-provisioned/) |
+| [Azure Cosmos DB](https://learn.microsoft.com/en-us/azure/cosmos-db/) | Serverless tier. Product catalog and conversation history storage. | [Pricing](https://azure.microsoft.com/en-us/pricing/details/cosmos-db/autoscale-provisioned/) |
@@ -121,17 +117,17 @@ _Note: This is not meant to outline all costs as selected SKUs, scaled use, cust
either by deleting the resource group in the Portal or running `azd down`.
-
+
Business Scenario
-||
+||
|---|
-Put your data to work by reducing blank page anxiety, speeding up document drafting, improving draft document quality, and reference information quickly - keeping experts in their expertise. Draft document templates for your organization including Invoices, End-user Contracts, Purchase Orders, Investment Proposals, and Grant Submissions.
+Accelerate your marketing content creation by leveraging AI to interpret creative briefs and generate on-brand, multimodal content. The solution helps marketing teams reduce time-to-market for campaigns by automating the creation of compliant marketing copy and images grounded in product data.
⚠️ The sample data used in this repository is synthetic and generated using Azure OpenAI Service. The data is intended for use as sample data only.
@@ -140,42 +136,42 @@ Put your data to work by reducing blank page anxiety, speeding up document draft
Click to learn more about what value this solution provides
- - **Draft templates quickly**
- Put your data to work to create any kind of document that is supported by a large data library.
+ - **Interpret creative briefs**
+ Parse unstructured creative briefs into structured fields automatically, ensuring all campaign requirements are captured.
- - **Share**
- Share with co-authors, contributors and approvers quickly.
+ - **Generate multimodal content**
+ Create marketing copy and images that align with your brand voice and product catalog using GPT and DALL-E 3.
- - **Contextualize information**
- Provide context using natural language. Primary and secondary queries allow for access to supplemental detail – reducing cognitive load, increasing efficiency, and enabling focus on higher value work.
+ - **Ensure brand compliance**
+ Validate all generated content against brand guidelines with severity-categorized feedback before publication.
- - **Gain confidence in responses**
- Trust responses to queries by customizing how data is referenced and returned to users, reducing the risk of hallucinated responses.
Access reference documents in the same chat window to get more detail and confirm accuracy.
+ - **Ground in enterprise data**
+ Leverage product information, images, and brand guidelines stored in Azure to ensure accurate, relevant content.
- - **Secure data and responsible AI for innovation**
- Improve data security to minimize breaches, fostering a culture of responsible AI adoption, maximize innovation opportunities, and sustain competitive edge.
+ - **Secure data and responsible AI**
+ Maintain data security with managed identities and private networking while fostering responsible AI adoption.
-
+
Supporting documentation
### Security guidelines
-This template uses Azure Key Vault to store all connections to communicate between resources.
+This template uses [Managed Identity](https://learn.microsoft.com/entra/identity/managed-identities-azure-resources/overview) for authentication between Azure services.
-This template also uses [Managed Identity](https://learn.microsoft.com/entra/identity/managed-identities-azure-resources/overview) for local development and deployment.
+The backend runs in Azure Container Instance within a private VNet subnet, accessible only through the App Service frontend proxy. Private networking can be enabled via the `enablePrivateNetworking` parameter.
To ensure continued best practices in your own repository, we recommend that anyone creating solutions based on our templates ensure that the [Github secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning) setting is enabled.
You may want to consider additional security measures, such as:
* Enabling Microsoft Defender for Cloud to [secure your Azure resources](https://learn.microsoft.com/azure/defender-for-cloud).
-* Protecting the Azure Container Apps instance with a [firewall](https://learn.microsoft.com/azure/container-apps/waf-app-gateway) and/or [Virtual Network](https://learn.microsoft.com/azure/container-apps/networking?tabs=workload-profiles-env%2Cazure-cli).
+* Protecting the Azure App Service with [authentication](https://learn.microsoft.com/azure/app-service/overview-authentication-authorization) and/or [Virtual Network integration](https://learn.microsoft.com/azure/app-service/overview-vnet-integration).
@@ -199,7 +195,7 @@ Have questions, find a bug, or want to request a feature? [Submit a new issue](h
## Responsible AI Transparency FAQ
-Please refer to [Transparency FAQ](./docs/TRANSPARENCY_FAQ.md) for responsible AI transparency details of this solution accelerator.
+Please refer to [Transparency FAQ](./content-gen/docs/TRANSPARENCY_FAQ.md) for responsible AI transparency details of this solution accelerator.
diff --git a/TRANSITION_DOCUMENT.md b/TRANSITION_DOCUMENT.md
new file mode 100644
index 000000000..2797fcbd6
--- /dev/null
+++ b/TRANSITION_DOCUMENT.md
@@ -0,0 +1,399 @@
+# Content Generation Solution Accelerator - Transition Document
+
+**Date:** January 16, 2026
+**Prepared for:** Incoming Engineer
+**Repository:** https://github.com/hunterjam/content-generation-solution-accelerator
+**Upstream:** https://github.com/microsoft/document-generation-solution-accelerator
+
+---
+
+## 1. Project Overview
+
+This is a **multimodal content generation solution** for retail marketing campaigns. It uses Microsoft Agent Framework with HandoffBuilder orchestration to interpret creative briefs and generate compliant marketing content (text + images) grounded in enterprise product data and brand guidelines.
+
+### Key Capabilities
+- Parse free-text creative briefs into structured fields
+- Generate marketing copy using GPT models
+- Generate marketing images using DALL-E 3
+- Validate content against brand guidelines with severity-categorized compliance checks
+- Ground content in product catalog data from Cosmos DB
+
+---
+
+## 2. System Architecture & How It Works
+
+### High-Level Flow
+
+```
+User → Frontend (React) → Backend API (Python/Quart) → Agent Orchestrator → Azure OpenAI
+ ↓
+ Multi-Agent System
+ ↓
+ ┌───────────────┼───────────────┐
+ ↓ ↓ ↓
+ TriageAgent → PlanningAgent → ResearchAgent
+ ↓ ↓ ↓
+ TextContentAgent ImageContentAgent ComplianceAgent
+ ↓ ↓ ↓
+ └───────────────┼───────────────┘
+ ↓
+ Generated Content
+ (Text + Image + Compliance)
+```
+
+### The Agent System
+
+The solution uses **Microsoft Agent Framework** with **HandoffBuilder orchestration**. This means agents can dynamically hand off control to each other based on context. Here's how each agent works:
+
+| Agent | Responsibility | Inputs | Outputs |
+|-------|---------------|--------|---------|
+| **TriageAgent** | Coordinator - routes requests to the right specialist | User message | Handoff decision |
+| **PlanningAgent** | Parses creative briefs into structured fields, asks clarifying questions if info is missing | Free-text brief | Structured `CreativeBrief` JSON |
+| **ResearchAgent** | Retrieves product data from Cosmos DB, fetches brand guidelines | Product queries | Product details, brand info |
+| **TextContentAgent** | Generates marketing copy (headlines, body, CTAs, hashtags) | Brief + Products | Marketing copy JSON |
+| **ImageContentAgent** | Creates DALL-E prompts and generates images | Brief + Products | Image URL + prompt |
+| **ComplianceAgent** | Validates content against brand guidelines | Generated content | Violations list with severity |
+
+### Content Generation Workflow
+
+When a user submits a creative brief, this is what happens:
+
+1. **Brief Parsing** (PlanningAgent)
+ - User submits free-text brief like "Create a spring campaign for our new green paint colors"
+ - PlanningAgent extracts structured fields: objectives, target audience, key message, tone, deliverables
+ - If critical fields are missing, agent asks clarifying questions
+ - User confirms the parsed brief
+
+2. **Product Selection** (ResearchAgent)
+ - System queries Cosmos DB for matching products
+ - Products are presented to user for confirmation
+ - User can add/remove products from selection
+
+3. **Content Generation** (TextContentAgent + ImageContentAgent)
+ - **Text**: GPT generates headline, body copy, CTA, hashtags based on brief + products
+ - **Image**: DALL-E generates marketing image with product context
+ - If product has an image (`image_url`), it's overlaid on the generated background
+
+4. **Compliance Check** (ComplianceAgent)
+ - Validates content against brand guidelines
+ - Returns violations categorized by severity:
+ - **Error**: Must fix before use (blocks acceptance)
+ - **Warning**: Review recommended
+ - **Info**: Optional improvements
+
+5. **Response to User**
+ - Frontend displays generated content with compliance status
+ - User can regenerate, modify, or accept
+
+### Key Data Structures
+
+**CreativeBrief** (what the PlanningAgent extracts):
+```typescript
+{
+ overview: string; // Campaign summary
+ objectives: string; // Goals and KPIs
+ target_audience: string; // Who it's for
+ key_message: string; // Core value proposition
+ tone_and_style: string; // Voice (professional, playful, etc.)
+ deliverable: string; // Output type (social post, email, etc.)
+ timelines: string; // Deadlines
+ visual_guidelines: string; // Image style requirements
+ cta: string; // Call to action
+}
+```
+
+**Product** (from Cosmos DB):
+```typescript
+{
+ product_name: string;
+ description: string;
+ tags: string;
+ price: number;
+ sku: string;
+ image_url?: string; // Product image for overlay
+ hex_value?: string; // Color hex code for paint products
+}
+```
+
+**GeneratedContent** (what the system produces):
+```typescript
+{
+ text_content: {
+ headline: string;
+ body: string;
+ cta_text: string;
+ tagline: string;
+ };
+ image_content: {
+ image_url: string; // Generated or composite image
+ alt_text: string;
+ prompt_used: string; // The DALL-E prompt
+ };
+ violations: ComplianceViolation[];
+ requires_modification: boolean; // True if any "error" violations
+}
+```
+
+### Image Generation Details
+
+The image generation has special logic for **product overlay**:
+
+1. If the product has an `image_url` (e.g., a paint can image):
+ - DALL-E generates a **background scene** (e.g., living room with the paint color)
+ - The product image is **composited** onto the background
+ - This ensures the actual product packaging appears in the marketing image
+
+2. If no product image:
+ - DALL-E generates a complete scene
+ - No overlay is applied
+
+3. **Text-free images**: The system instructs DALL-E to generate images without text overlays, as text rendering in AI images is often poor quality.
+
+### Frontend-Backend Communication
+
+The frontend uses **Server-Sent Events (SSE)** for streaming responses:
+
+1. Frontend calls `/api/generate/start` with brief + products
+2. Backend returns a `task_id` immediately
+3. Frontend polls `/api/generate/status/{task_id}` every second
+4. Backend returns progress updates (heartbeats with stage info)
+5. When complete, backend returns the full `GeneratedContent`
+
+This polling approach handles the 30-60 second generation time without timeouts.
+
+### Content Safety
+
+The system has multiple layers of content safety:
+
+1. **Input filtering** (`orchestrator.py`): Regex patterns block harmful requests before they reach agents
+2. **Agent instructions**: Each agent has explicit refusal instructions for inappropriate content
+3. **Azure OpenAI content filters**: Built-in filters on the AI models
+4. **Compliance validation**: Final check against brand guidelines
+
+---
+
+## 3. Repository Structure
+
+```
+content-generation-solution-accelerator/
+├── content-gen/ # Main application (THIS IS THE ACTIVE CODE)
+│ ├── src/
+│ │ ├── app/ # Frontend application
+│ │ │ ├── frontend/ # React + Vite + TypeScript + Fluent UI
+│ │ │ │ └── src/
+│ │ │ │ ├── components/ # React components
+│ │ │ │ ├── api/ # API client functions
+│ │ │ │ └── types/ # TypeScript interfaces
+│ │ │ └── WebApp.Dockerfile # Frontend container build
+│ │ └── backend/ # Python backend
+│ │ ├── agents/ # AI agent implementations
+│ │ ├── api/ # API route handlers
+│ │ ├── services/ # Business logic services
+│ │ ├── orchestrator.py # Agent orchestration logic
+│ │ ├── settings.py # Configuration/environment
+│ │ └── ApiApp.Dockerfile # Backend container build
+│ ├── scripts/ # Deployment and data scripts
+│ │ └── post_deploy.py # Product data seeding
+│ ├── infra/ # Bicep infrastructure as code
+│ └── docs/ # Documentation
+├── archive-doc-gen/ # Legacy document generation (separate app)
+└── docs/ # Root-level documentation
+```
+
+---
+
+## 4. Key Files Reference
+
+### Backend
+| File | Purpose |
+|------|---------|
+| `src/backend/orchestrator.py` | Main agent orchestration, content generation workflow |
+| `src/backend/agents/image_content_agent.py` | DALL-E image generation logic |
+| `src/backend/settings.py` | All environment variables and configuration |
+| `src/backend/api/` | REST API endpoints |
+| `src/backend/services/` | Cosmos DB, storage, AI service integrations |
+
+### Frontend
+| File | Purpose |
+|------|---------|
+| `src/app/frontend/src/App.tsx` | Main React application |
+| `src/app/frontend/src/components/ChatPanel.tsx` | Main chat interface |
+| `src/app/frontend/src/components/InlineContentPreview.tsx` | Content display with compliance status |
+| `src/app/frontend/src/api/index.ts` | API client functions |
+| `src/app/frontend/src/types/index.ts` | TypeScript type definitions |
+
+### Deployment
+| File | Purpose |
+|------|---------|
+| `scripts/post_deploy.py` | Seeds sample product data to Cosmos DB |
+| `infra/main.bicep` | Azure infrastructure definition |
+| `azure.yaml` | Azure Developer CLI configuration |
+
+---
+
+## 5. Recent Changes (Last Session)
+
+### Commits Merged to Main
+
+1. **Fix image generation overlay handling** - Improved how product images are overlaid on generated backgrounds
+2. **Fix product/campaign logic** - Corrected color descriptions for paint products (Quiet Moss, Cloud Drift, Pine Shadow)
+3. **Add multi-product handling instructions** - Enhanced orchestrator to handle campaigns with multiple products
+4. **Add user guidance callouts** - Added clear "Action needed" / "Optional review" messages in UI for compliance status
+5. **Remove unused components** - Cleaned up dead code:
+ - `ContentPreview.tsx` (replaced by `InlineContentPreview.tsx`)
+ - `TaskHeader.tsx`
+ - Unused API functions (`getProducts`, `uploadProductImage`, `getBrandGuidelines`, `getConversations`, `getConversation`)
+ - Unused types (`ComplianceSeverity`, `ContentResponse`)
+
+### Important Discovery
+The frontend uses **`InlineContentPreview.tsx`** for displaying generated content, NOT `ContentPreview.tsx`. The latter was dead code and has been removed.
+
+---
+
+## 6. Development Workflow
+
+### Local Development
+
+```bash
+# Backend
+cd content-gen/src/backend
+pip install -r requirements.txt
+python app.py
+
+# Frontend
+cd content-gen/src/app/frontend
+npm install
+npm run dev
+```
+
+### Building & Deploying Containers
+
+```bash
+# Build and push frontend (using ACR build)
+az acr build --registry \
+ --image content-gen-webapp:latest \
+ --file content-gen/src/app/WebApp.Dockerfile \
+ content-gen/src/app
+
+# Build and push backend
+az acr build --registry \
+ --image content-gen-api:latest \
+ --file content-gen/src/backend/ApiApp.Dockerfile \
+ content-gen/src/backend
+
+# Restart services to pull new images
+az webapp restart --name --resource-group
+az container restart --name --resource-group
+```
+
+---
+
+## 7. Git Workflow
+
+### Branches
+- `main` - Production branch
+- `fix-image-generation-overlay` - Recent image generation fixes (merged)
+- `cleanup-unused-frontend-code` - Code cleanup (merged)
+
+### Remotes
+- `origin` - Fork: `hunterjam/content-generation-solution-accelerator`
+- `upstream` - Microsoft repo: `microsoft/document-generation-solution-accelerator`
+
+### Syncing with Upstream
+```bash
+git fetch upstream
+git merge upstream/main
+```
+
+---
+
+## 8. Environment Variables
+
+Key settings in `src/backend/settings.py`:
+
+| Variable | Description |
+|----------|-------------|
+| `AZURE_OPENAI_ENDPOINT` | Azure OpenAI endpoint for GPT |
+| `AZURE_OPENAI_DEPLOYMENT_NAME` | GPT model deployment name |
+| `AZURE_OPENAI_DALLE_ENDPOINT` | DALL-E endpoint (if separate) |
+| `AZURE_OPENAI_DALLE_DEPLOYMENT` | DALL-E deployment name |
+| `COSMOS_ENDPOINT` | Cosmos DB endpoint |
+| `COSMOS_DATABASE` | Database name |
+| `AZURE_STORAGE_ACCOUNT_NAME` | Blob storage account |
+| `ENABLE_IMAGE_GENERATION` | Toggle image generation feature |
+
+---
+
+## 9. Useful Commands
+
+```bash
+# View container logs
+az webapp log tail --name --resource-group
+
+# Check container configuration
+az webapp config container show --name --resource-group
+
+# List ACR images
+az acr repository list --name
+
+# Check image tags
+az acr repository show-tags --name --repository content-gen-webapp
+```
+
+---
+
+## 10. Contact & Resources
+
+- **Project README:** `content-gen/README.md`
+- **Deployment Docs:** `content-gen/docs/`
+- **Upstream Issues:** https://github.com/microsoft/document-generation-solution-accelerator/issues
+
+---
+
+## 11. Quick Start for New Engineer
+
+1. **Clone and setup:**
+ ```bash
+ git clone https://github.com/hunterjam/content-generation-solution-accelerator.git
+ cd content-generation-solution-accelerator
+ ```
+
+2. **Open in VS Code with Dev Container** (recommended)
+
+3. **Login to Azure:**
+ ```bash
+ az login
+ az account set --subscription
+ az acr login --name
+ ```
+
+4. **Run locally:**
+ ```bash
+ # Terminal 1 - Backend
+ cd content-gen/src/backend
+ pip install -r requirements.txt
+ # Set environment variables (see settings.py)
+ python app.py
+
+ # Terminal 2 - Frontend
+ cd content-gen/src/app/frontend
+ npm install
+ npm run dev
+ ```
+
+5. **Make changes and deploy:**
+ ```bash
+ # After code changes
+ git checkout -b feature/your-feature
+ # Make changes...
+ git commit -am "Your change"
+
+ # Build and deploy (replace placeholders with your Azure resources)
+ az acr build --registry --image content-gen-webapp:latest \
+ --file content-gen/src/app/WebApp.Dockerfile content-gen/src/app
+ az webapp restart --name --resource-group
+ ```
+
+---
+
+*Document generated: January 16, 2026*
diff --git a/.azdo/pipelines/azure-dev.yml b/archive-doc-gen/.azdo/pipelines/azure-dev.yml
similarity index 100%
rename from .azdo/pipelines/azure-dev.yml
rename to archive-doc-gen/.azdo/pipelines/azure-dev.yml
diff --git a/archive-doc-gen/.devcontainer/devcontainer.json b/archive-doc-gen/.devcontainer/devcontainer.json
new file mode 100644
index 000000000..f143c9dc4
--- /dev/null
+++ b/archive-doc-gen/.devcontainer/devcontainer.json
@@ -0,0 +1,38 @@
+{
+ "name": "azd-template",
+ "image": "mcr.microsoft.com/devcontainers/python:3.11-bullseye",
+ "forwardPorts": [50505],
+ "features": {
+ "ghcr.io/devcontainers/features/node:1": {
+ "nodeGypDependencies": true,
+ "installYarnUsingApt": true,
+ "version": "lts",
+ "pnpmVersion": "latest",
+ "nvmVersion": "latest"
+ },
+ "ghcr.io/devcontainers/features/azure-cli:1": {
+ "installBicep": true,
+ "version": "latest",
+ "bicepVersion": "latest"
+ },
+ "ghcr.io/azure/azure-dev/azd:0": {
+ "version": "stable"
+ }
+ },
+ "customizations": {
+ "vscode": {
+ "extensions": [
+ "ms-azuretools.azure-dev",
+ "ms-azuretools.vscode-bicep",
+ "ms-python.python",
+ "ms-toolsai.jupyter",
+ "GitHub.vscode-github-actions"
+ ]
+ }
+ },
+ "postCreateCommand": "bash ./.devcontainer/setup_env.sh",
+ "remoteUser": "vscode",
+ "hostRequirements": {
+ "memory": "4gb"
+ }
+}
diff --git a/archive-doc-gen/.devcontainer/setup_env.sh b/archive-doc-gen/.devcontainer/setup_env.sh
new file mode 100644
index 000000000..91de5b222
--- /dev/null
+++ b/archive-doc-gen/.devcontainer/setup_env.sh
@@ -0,0 +1,7 @@
+#!/bin/bash
+
+git fetch
+git pull
+
+# provide execute permission to quotacheck script
+sudo chmod +x ./scripts/quota_check_params.sh
\ No newline at end of file
diff --git a/.flake8 b/archive-doc-gen/.flake8
similarity index 100%
rename from .flake8
rename to archive-doc-gen/.flake8
diff --git a/archive-doc-gen/.gitattributes b/archive-doc-gen/.gitattributes
new file mode 100644
index 000000000..314766e91
--- /dev/null
+++ b/archive-doc-gen/.gitattributes
@@ -0,0 +1,3 @@
+* text=auto eol=lf
+*.{cmd,[cC][mM][dD]} text eol=crlf
+*.{bat,[bB][aA][tT]} text eol=crlf
diff --git a/.github/CODEOWNERS b/archive-doc-gen/.github/CODEOWNERS
similarity index 100%
rename from .github/CODEOWNERS
rename to archive-doc-gen/.github/CODEOWNERS
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/archive-doc-gen/.github/ISSUE_TEMPLATE/bug_report.md
similarity index 100%
rename from .github/ISSUE_TEMPLATE/bug_report.md
rename to archive-doc-gen/.github/ISSUE_TEMPLATE/bug_report.md
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/archive-doc-gen/.github/ISSUE_TEMPLATE/feature_request.md
similarity index 100%
rename from .github/ISSUE_TEMPLATE/feature_request.md
rename to archive-doc-gen/.github/ISSUE_TEMPLATE/feature_request.md
diff --git a/.github/ISSUE_TEMPLATE/subtask.md b/archive-doc-gen/.github/ISSUE_TEMPLATE/subtask.md
similarity index 100%
rename from .github/ISSUE_TEMPLATE/subtask.md
rename to archive-doc-gen/.github/ISSUE_TEMPLATE/subtask.md
diff --git a/.github/dependabot.yml b/archive-doc-gen/.github/dependabot.yml
similarity index 100%
rename from .github/dependabot.yml
rename to archive-doc-gen/.github/dependabot.yml
diff --git a/.github/pull_request_template.md b/archive-doc-gen/.github/pull_request_template.md
similarity index 100%
rename from .github/pull_request_template.md
rename to archive-doc-gen/.github/pull_request_template.md
diff --git a/.github/workflows/Scheduled-Dependabot-PRs-Auto-Merge.yml b/archive-doc-gen/.github/workflows/Scheduled-Dependabot-PRs-Auto-Merge.yml
similarity index 100%
rename from .github/workflows/Scheduled-Dependabot-PRs-Auto-Merge.yml
rename to archive-doc-gen/.github/workflows/Scheduled-Dependabot-PRs-Auto-Merge.yml
diff --git a/archive-doc-gen/.github/workflows/azure-dev.yml b/archive-doc-gen/.github/workflows/azure-dev.yml
new file mode 100644
index 000000000..6f1c6305f
--- /dev/null
+++ b/archive-doc-gen/.github/workflows/azure-dev.yml
@@ -0,0 +1,35 @@
+name: Azure Template Validation
+on:
+ workflow_dispatch:
+
+permissions:
+ contents: read
+ id-token: write
+ pull-requests: write
+
+jobs:
+ template_validation_job:
+ runs-on: ubuntu-latest
+ name: Template validation
+
+ steps:
+ # Step 1: Checkout the code from your repository
+ - name: Checkout code
+ uses: actions/checkout@v6
+
+ # Step 2: Validate the Azure template using microsoft/template-validation-action
+ - name: Validate Azure Template
+ uses: microsoft/template-validation-action@v0.4.4
+ id: validation
+ env:
+ AZURE_CLIENT_ID: ${{ secrets.AZURE_CLIENT_ID }}
+ AZURE_TENANT_ID: ${{ secrets.AZURE_TENANT_ID }}
+ AZURE_SUBSCRIPTION_ID: ${{ secrets.AZURE_SUBSCRIPTION_ID }}
+ AZURE_ENV_NAME: ${{ secrets.AZURE_ENV_NAME }}
+ AZURE_LOCATION: ${{ secrets.AZURE_LOCATION }}
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ AZURE_DEV_COLLECT_TELEMETRY: ${{ vars.AZURE_DEV_COLLECT_TELEMETRY }}
+
+ # Step 3: Print the result of the validation
+ - name: Print result
+ run: cat ${{ steps.validation.outputs.resultFile }}
\ No newline at end of file
diff --git a/.github/workflows/broken-links-checker.yml b/archive-doc-gen/.github/workflows/broken-links-checker.yml
similarity index 100%
rename from .github/workflows/broken-links-checker.yml
rename to archive-doc-gen/.github/workflows/broken-links-checker.yml
diff --git a/archive-doc-gen/.github/workflows/create-release.yml b/archive-doc-gen/.github/workflows/create-release.yml
new file mode 100644
index 000000000..c45474d51
--- /dev/null
+++ b/archive-doc-gen/.github/workflows/create-release.yml
@@ -0,0 +1,64 @@
+on:
+ push:
+ branches:
+ - main
+
+permissions:
+ contents: write
+ pull-requests: write
+
+name: Create-Release
+
+jobs:
+ create-release:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v6
+ with:
+ ref: ${{ github.event.workflow_run.head_sha }}
+
+ - uses: codfish/semantic-release-action@v4
+ id: semantic
+ with:
+ tag-format: 'v${version}'
+ additional-packages: |
+ ['conventional-changelog-conventionalcommits@7']
+ plugins: |
+ [
+ [
+ "@semantic-release/commit-analyzer",
+ {
+ "preset": "conventionalcommits"
+ }
+ ],
+ [
+ "@semantic-release/release-notes-generator",
+ {
+ "preset": "conventionalcommits",
+ "presetConfig": {
+ "types": [
+ { type: 'feat', section: 'Features', hidden: false },
+ { type: 'fix', section: 'Bug Fixes', hidden: false },
+ { type: 'perf', section: 'Performance Improvements', hidden: false },
+ { type: 'revert', section: 'Reverts', hidden: false },
+ { type: 'docs', section: 'Other Updates', hidden: false },
+ { type: 'style', section: 'Other Updates', hidden: false },
+ { type: 'chore', section: 'Other Updates', hidden: false },
+ { type: 'refactor', section: 'Other Updates', hidden: false },
+ { type: 'test', section: 'Other Updates', hidden: false },
+ { type: 'build', section: 'Other Updates', hidden: false },
+ { type: 'ci', section: 'Other Updates', hidden: false }
+ ]
+ }
+ }
+ ],
+ '@semantic-release/github'
+ ]
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ - run: echo ${{ steps.semantic.outputs.release-version }}
+
+ - run: echo "$OUTPUTS"
+ env:
+ OUTPUTS: ${{ toJson(steps.semantic.outputs) }}
diff --git a/archive-doc-gen/.github/workflows/deploy-linux.yml b/archive-doc-gen/.github/workflows/deploy-linux.yml
new file mode 100644
index 000000000..c45aae3f5
--- /dev/null
+++ b/archive-doc-gen/.github/workflows/deploy-linux.yml
@@ -0,0 +1,283 @@
+name: Deploy-Test-Cleanup (v2) Linux
+on:
+ pull_request:
+ branches:
+ - main
+ paths:
+ - 'src/frontend/**'
+ - 'src/**/*.py'
+ - 'src/requirements*.txt'
+ - 'src/WebApp.Dockerfile'
+ - '!src/tests/**'
+ - 'infra/**/*.bicep'
+ - 'infra/**/*.json'
+ - '*.yaml'
+ - '.github/workflows/deploy-*.yml'
+ workflow_run:
+ workflows: ["Build Docker and Optional Push"]
+ types:
+ - completed
+ branches:
+ - main
+ - dev
+ - demo
+ workflow_dispatch:
+ inputs:
+ azure_location:
+ description: 'Azure Location For Deployment'
+ required: false
+ default: 'australiaeast'
+ type: choice
+ options:
+ - 'australiaeast'
+ - 'centralus'
+ - 'eastasia'
+ - 'eastus2'
+ - 'japaneast'
+ - 'northeurope'
+ - 'southeastasia'
+ - 'uksouth'
+ resource_group_name:
+ description: 'Resource Group Name (Optional)'
+ required: false
+ default: ''
+ type: string
+
+ waf_enabled:
+ description: 'Enable WAF'
+ required: false
+ default: false
+ type: boolean
+ EXP:
+ description: 'Enable EXP'
+ required: false
+ default: false
+ type: boolean
+ build_docker_image:
+ description: 'Build And Push Docker Image (Optional)'
+ required: false
+ default: false
+ type: boolean
+
+ cleanup_resources:
+ description: 'Cleanup Deployed Resources'
+ required: false
+ default: false
+ type: boolean
+
+ run_e2e_tests:
+ description: 'Run End-to-End Tests'
+ required: false
+ default: 'GoldenPath-Testing'
+ type: choice
+ options:
+ - 'GoldenPath-Testing'
+ - 'Smoke-Testing'
+ - 'None'
+
+ AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID:
+ description: 'Log Analytics Workspace ID (Optional)'
+ required: false
+ default: ''
+ type: string
+ AZURE_EXISTING_AI_PROJECT_RESOURCE_ID:
+ description: 'AI Project Resource ID (Optional)'
+ required: false
+ default: ''
+ type: string
+ existing_webapp_url:
+ description: 'Existing WebApp URL (Skips Deployment)'
+ required: false
+ default: ''
+ type: string
+
+ schedule:
+ - cron: '0 9,21 * * *' # Runs at 9:00 AM and 9:00 PM GMT
+permissions:
+ contents: read
+ actions: read
+jobs:
+ validate-inputs:
+ runs-on: ubuntu-latest
+ outputs:
+ validation_passed: ${{ steps.validate.outputs.passed }}
+ azure_location: ${{ steps.validate.outputs.azure_location }}
+ resource_group_name: ${{ steps.validate.outputs.resource_group_name }}
+ waf_enabled: ${{ steps.validate.outputs.waf_enabled }}
+ exp: ${{ steps.validate.outputs.exp }}
+ build_docker_image: ${{ steps.validate.outputs.build_docker_image }}
+ cleanup_resources: ${{ steps.validate.outputs.cleanup_resources }}
+ run_e2e_tests: ${{ steps.validate.outputs.run_e2e_tests }}
+ azure_env_log_analytics_workspace_id: ${{ steps.validate.outputs.azure_env_log_analytics_workspace_id }}
+ azure_existing_ai_project_resource_id: ${{ steps.validate.outputs.azure_existing_ai_project_resource_id }}
+ existing_webapp_url: ${{ steps.validate.outputs.existing_webapp_url }}
+ steps:
+ - name: Validate Workflow Input Parameters
+ id: validate
+ shell: bash
+ env:
+ INPUT_AZURE_LOCATION: ${{ github.event.inputs.azure_location }}
+ INPUT_RESOURCE_GROUP_NAME: ${{ github.event.inputs.resource_group_name }}
+ INPUT_WAF_ENABLED: ${{ github.event.inputs.waf_enabled }}
+ INPUT_EXP: ${{ github.event.inputs.EXP }}
+ INPUT_BUILD_DOCKER_IMAGE: ${{ github.event.inputs.build_docker_image }}
+ INPUT_CLEANUP_RESOURCES: ${{ github.event.inputs.cleanup_resources }}
+ INPUT_RUN_E2E_TESTS: ${{ github.event.inputs.run_e2e_tests }}
+ INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID: ${{ github.event.inputs.AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID }}
+ INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID: ${{ github.event.inputs.AZURE_EXISTING_AI_PROJECT_RESOURCE_ID }}
+ INPUT_EXISTING_WEBAPP_URL: ${{ github.event.inputs.existing_webapp_url }}
+ run: |
+ echo "🔍 Validating workflow input parameters..."
+ VALIDATION_FAILED=false
+
+ # Validate azure_location (Azure region format)
+ LOCATION="${INPUT_AZURE_LOCATION:-australiaeast}"
+
+ if [[ ! "$LOCATION" =~ ^[a-z0-9]+$ ]]; then
+ echo "❌ ERROR: azure_location '$LOCATION' is invalid. Must contain only lowercase letters and numbers"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ azure_location: '$LOCATION' is valid"
+ fi
+
+ # Validate resource_group_name (Azure naming convention, optional)
+ if [[ -n "$INPUT_RESOURCE_GROUP_NAME" ]]; then
+ if [[ ! "$INPUT_RESOURCE_GROUP_NAME" =~ ^[a-zA-Z0-9._\(\)-]+$ ]] || [[ "$INPUT_RESOURCE_GROUP_NAME" =~ \.$ ]]; then
+ echo "❌ ERROR: resource_group_name '$INPUT_RESOURCE_GROUP_NAME' is invalid. Must contain only alphanumerics, periods, underscores, hyphens, and parentheses. Cannot end with period."
+ VALIDATION_FAILED=true
+ elif [[ ${#INPUT_RESOURCE_GROUP_NAME} -gt 90 ]]; then
+ echo "❌ ERROR: resource_group_name '$INPUT_RESOURCE_GROUP_NAME' exceeds 90 characters (length: ${#INPUT_RESOURCE_GROUP_NAME})"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ resource_group_name: '$INPUT_RESOURCE_GROUP_NAME' is valid"
+ fi
+ else
+ echo "✅ resource_group_name: Not provided (will be auto-generated)"
+ fi
+
+ # Validate waf_enabled (boolean)
+ WAF_ENABLED="${INPUT_WAF_ENABLED:-false}"
+ if [[ "$WAF_ENABLED" != "true" && "$WAF_ENABLED" != "false" ]]; then
+ echo "❌ ERROR: waf_enabled must be 'true' or 'false', got: '$WAF_ENABLED'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ waf_enabled: '$WAF_ENABLED' is valid"
+ fi
+
+ # Validate EXP (boolean)
+ EXP_ENABLED="${INPUT_EXP:-false}"
+ if [[ "$EXP_ENABLED" != "true" && "$EXP_ENABLED" != "false" ]]; then
+ echo "❌ ERROR: EXP must be 'true' or 'false', got: '$EXP_ENABLED'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ EXP: '$EXP_ENABLED' is valid"
+ fi
+
+ # Validate build_docker_image (boolean)
+ BUILD_DOCKER="${INPUT_BUILD_DOCKER_IMAGE:-false}"
+ if [[ "$BUILD_DOCKER" != "true" && "$BUILD_DOCKER" != "false" ]]; then
+ echo "❌ ERROR: build_docker_image must be 'true' or 'false', got: '$BUILD_DOCKER'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ build_docker_image: '$BUILD_DOCKER' is valid"
+ fi
+
+ # Validate cleanup_resources (boolean)
+ CLEANUP_RESOURCES="${INPUT_CLEANUP_RESOURCES:-false}"
+ if [[ "$CLEANUP_RESOURCES" != "true" && "$CLEANUP_RESOURCES" != "false" ]]; then
+ echo "❌ ERROR: cleanup_resources must be 'true' or 'false', got: '$CLEANUP_RESOURCES'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ cleanup_resources: '$CLEANUP_RESOURCES' is valid"
+ fi
+
+ # Validate run_e2e_tests (specific allowed values)
+ TEST_OPTION="${INPUT_RUN_E2E_TESTS:-GoldenPath-Testing}"
+ if [[ "$TEST_OPTION" != "GoldenPath-Testing" && "$TEST_OPTION" != "Smoke-Testing" && "$TEST_OPTION" != "None" ]]; then
+ echo "❌ ERROR: run_e2e_tests must be one of: GoldenPath-Testing, Smoke-Testing, None, got: '$TEST_OPTION'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ run_e2e_tests: '$TEST_OPTION' is valid"
+ fi
+
+ # Validate AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID (optional, Azure Resource ID format)
+ if [[ -n "$INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID" ]]; then
+ if [[ ! "$INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID" =~ ^/subscriptions/[a-fA-F0-9-]+/[Rr]esource[Gg]roups/[^/]+/providers/[Mm]icrosoft\.[Oo]perational[Ii]nsights/[Ww]orkspaces/[^/]+$ ]]; then
+ echo "❌ ERROR: AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID is invalid. Must be a valid Azure Resource ID format:"
+ echo " /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}"
+ echo " Got: '$INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID: Valid Resource ID format"
+ fi
+ else
+ echo "✅ AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID: Not provided (optional)"
+ fi
+
+ # Validate AZURE_EXISTING_AI_PROJECT_RESOURCE_ID (optional, Azure Resource ID format)
+ if [[ -n "$INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID" ]]; then
+ if [[ ! "$INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID" =~ ^/subscriptions/[a-fA-F0-9-]+/[Rr]esource[Gg]roups/[^/]+/providers/([Mm]icrosoft\.[Mm]achine[Ll]earning[Ss]ervices/([Ww]orkspaces|[Pp]rojects)/[^/]+|[Mm]icrosoft\.[Cc]ognitive[Ss]ervices/[Aa]ccounts/[^/]+/[Pp]rojects/[^/]+)$ ]]; then
+ echo "❌ ERROR: AZURE_EXISTING_AI_PROJECT_RESOURCE_ID is invalid. Must be a valid Azure Resource ID format:"
+ echo " /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}"
+ echo " Got: '$INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ AZURE_EXISTING_AI_PROJECT_RESOURCE_ID: Valid Resource ID format"
+ fi
+ else
+ echo "✅ AZURE_EXISTING_AI_PROJECT_RESOURCE_ID: Not provided (optional)"
+ fi
+
+ # Validate existing_webapp_url (optional, must start with https)
+ if [[ -n "$INPUT_EXISTING_WEBAPP_URL" ]]; then
+ if [[ ! "$INPUT_EXISTING_WEBAPP_URL" =~ ^https:// ]]; then
+ echo "❌ ERROR: existing_webapp_url must start with 'https://', got: '$INPUT_EXISTING_WEBAPP_URL'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ existing_webapp_url: '$INPUT_EXISTING_WEBAPP_URL' is valid"
+ fi
+ else
+ echo "✅ existing_webapp_url: Not provided (will perform deployment)"
+ fi
+
+ # Fail workflow if any validation failed
+ if [[ "$VALIDATION_FAILED" == "true" ]]; then
+ echo ""
+ echo "❌ Parameter validation failed. Please correct the errors above and try again."
+ exit 1
+ fi
+
+ echo ""
+ echo "✅ All input parameters validated successfully!"
+
+ # Output validated values
+ echo "passed=true" >> $GITHUB_OUTPUT
+ echo "azure_location=$LOCATION" >> $GITHUB_OUTPUT
+ echo "resource_group_name=$INPUT_RESOURCE_GROUP_NAME" >> $GITHUB_OUTPUT
+ echo "waf_enabled=$WAF_ENABLED" >> $GITHUB_OUTPUT
+ echo "exp=$EXP_ENABLED" >> $GITHUB_OUTPUT
+ echo "build_docker_image=$BUILD_DOCKER" >> $GITHUB_OUTPUT
+ echo "cleanup_resources=$CLEANUP_RESOURCES" >> $GITHUB_OUTPUT
+ echo "run_e2e_tests=$TEST_OPTION" >> $GITHUB_OUTPUT
+ echo "azure_env_log_analytics_workspace_id=$INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID" >> $GITHUB_OUTPUT
+ echo "azure_existing_ai_project_resource_id=$INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID" >> $GITHUB_OUTPUT
+ echo "existing_webapp_url=$INPUT_EXISTING_WEBAPP_URL" >> $GITHUB_OUTPUT
+
+ Run:
+ needs: validate-inputs
+ if: needs.validate-inputs.outputs.validation_passed == 'true'
+ uses: ./.github/workflows/deploy-orchestrator.yml
+ with:
+ runner_os: ubuntu-latest
+ azure_location: ${{ needs.validate-inputs.outputs.azure_location || 'australiaeast' }}
+ resource_group_name: ${{ needs.validate-inputs.outputs.resource_group_name || '' }}
+ waf_enabled: ${{ needs.validate-inputs.outputs.waf_enabled == 'true' }}
+ EXP: ${{ needs.validate-inputs.outputs.exp == 'true' }}
+ build_docker_image: ${{ needs.validate-inputs.outputs.build_docker_image == 'true' }}
+ cleanup_resources: ${{ needs.validate-inputs.outputs.cleanup_resources == 'true' }}
+ run_e2e_tests: ${{ needs.validate-inputs.outputs.run_e2e_tests || 'GoldenPath-Testing' }}
+ AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID: ${{ needs.validate-inputs.outputs.azure_env_log_analytics_workspace_id || '' }}
+ AZURE_EXISTING_AI_PROJECT_RESOURCE_ID: ${{ needs.validate-inputs.outputs.azure_existing_ai_project_resource_id || '' }}
+ existing_webapp_url: ${{ needs.validate-inputs.outputs.existing_webapp_url || '' }}
+ trigger_type: ${{ github.event_name }}
+ secrets: inherit
diff --git a/archive-doc-gen/.github/workflows/deploy-orchestrator.yml b/archive-doc-gen/.github/workflows/deploy-orchestrator.yml
new file mode 100644
index 000000000..31741f3b4
--- /dev/null
+++ b/archive-doc-gen/.github/workflows/deploy-orchestrator.yml
@@ -0,0 +1,141 @@
+name: Deployment orchestrator
+
+on:
+ workflow_call:
+ inputs:
+ runner_os:
+ description: 'Runner OS (ubuntu-latest or windows-latest)'
+ required: true
+ type: string
+ azure_location:
+ description: 'Azure Location For Deployment'
+ required: false
+ default: 'australiaeast'
+ type: string
+ resource_group_name:
+ description: 'Resource Group Name (Optional)'
+ required: false
+ default: ''
+ type: string
+ waf_enabled:
+ description: 'Enable WAF'
+ required: false
+ default: false
+ type: boolean
+ EXP:
+ description: 'Enable EXP'
+ required: false
+ default: false
+ type: boolean
+ build_docker_image:
+ description: 'Build And Push Docker Image (Optional)'
+ required: false
+ default: false
+ type: boolean
+ cleanup_resources:
+ description: 'Cleanup Deployed Resources'
+ required: false
+ default: false
+ type: boolean
+ run_e2e_tests:
+ description: 'Run End-to-End Tests'
+ required: false
+ default: 'GoldenPath-Testing'
+ type: string
+ AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID:
+ description: 'Log Analytics Workspace ID (Optional)'
+ required: false
+ default: ''
+ type: string
+ AZURE_EXISTING_AI_PROJECT_RESOURCE_ID:
+ description: 'AI Project Resource ID (Optional)'
+ required: false
+ default: ''
+ type: string
+ existing_webapp_url:
+ description: 'Existing Container WebApp URL (Skips Deployment)'
+ required: false
+ default: ''
+ type: string
+ trigger_type:
+ description: 'Trigger type (workflow_dispatch, pull_request, schedule)'
+ required: true
+ type: string
+
+env:
+ AZURE_DEV_COLLECT_TELEMETRY: ${{ vars.AZURE_DEV_COLLECT_TELEMETRY }}
+permissions:
+ contents: read
+ actions: read
+
+jobs:
+ docker-build:
+ uses: ./.github/workflows/job-docker-build.yml
+ with:
+ trigger_type: ${{ inputs.trigger_type }}
+ build_docker_image: ${{ inputs.build_docker_image }}
+ secrets: inherit
+
+ deploy:
+ if: "!cancelled() && (needs.docker-build.result == 'success' || needs.docker-build.result == 'skipped') && (inputs.trigger_type != 'workflow_dispatch' || inputs.existing_webapp_url == '' || inputs.existing_webapp_url == null)"
+ needs: docker-build
+ uses: ./.github/workflows/job-deploy.yml
+ with:
+ trigger_type: ${{ inputs.trigger_type }}
+ runner_os: ${{ inputs.runner_os }}
+ azure_location: ${{ inputs.azure_location }}
+ resource_group_name: ${{ inputs.resource_group_name }}
+ waf_enabled: ${{ inputs.waf_enabled }}
+ EXP: ${{ inputs.EXP }}
+ build_docker_image: ${{ inputs.build_docker_image }}
+ existing_webapp_url: ${{ inputs.existing_webapp_url }}
+ AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID: ${{ inputs.AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID }}
+ AZURE_EXISTING_AI_PROJECT_RESOURCE_ID: ${{ inputs.AZURE_EXISTING_AI_PROJECT_RESOURCE_ID }}
+ docker_image_tag: ${{ needs.docker-build.outputs.IMAGE_TAG }}
+ run_e2e_tests: ${{ inputs.run_e2e_tests }}
+ cleanup_resources: ${{ inputs.cleanup_resources }}
+ secrets: inherit
+
+ e2e-test:
+ if: "!cancelled() && ((needs.deploy.result == 'success' && needs.deploy.outputs.WEB_APPURL != '') || (inputs.existing_webapp_url != '' && inputs.existing_webapp_url != null)) && (inputs.trigger_type != 'workflow_dispatch' || (inputs.run_e2e_tests != 'None' && inputs.run_e2e_tests != '' && inputs.run_e2e_tests != null))"
+ needs: [docker-build, deploy]
+ uses: ./.github/workflows/test-automation-v2.yml
+ with:
+ DOCGEN_URL: ${{ needs.deploy.outputs.WEB_APPURL || inputs.existing_webapp_url }}
+ TEST_SUITE: ${{ inputs.trigger_type == 'workflow_dispatch' && inputs.run_e2e_tests || 'GoldenPath-Testing' }}
+ secrets: inherit
+
+ send-notification:
+ if: "!cancelled()"
+ needs: [docker-build, deploy, e2e-test]
+ uses: ./.github/workflows/job-send-notification.yml
+ with:
+ trigger_type: ${{ inputs.trigger_type }}
+ waf_enabled: ${{ inputs.waf_enabled }}
+ EXP: ${{ inputs.EXP }}
+ run_e2e_tests: ${{ inputs.run_e2e_tests }}
+ existing_webapp_url: ${{ inputs.existing_webapp_url }}
+ deploy_result: ${{ needs.deploy.result }}
+ e2e_test_result: ${{ needs.e2e-test.result }}
+ WEB_APPURL: ${{ needs.deploy.outputs.WEB_APPURL || inputs.existing_webapp_url }}
+ RESOURCE_GROUP_NAME: ${{ needs.deploy.outputs.RESOURCE_GROUP_NAME }}
+ QUOTA_FAILED: ${{ needs.deploy.outputs.QUOTA_FAILED }}
+ TEST_SUCCESS: ${{ needs.e2e-test.outputs.TEST_SUCCESS }}
+ TEST_REPORT_URL: ${{ needs.e2e-test.outputs.TEST_REPORT_URL }}
+ secrets: inherit
+
+ cleanup-deployment:
+ if: "!cancelled() && needs.deploy.outputs.RESOURCE_GROUP_NAME != '' && inputs.existing_webapp_url == '' && (inputs.trigger_type != 'workflow_dispatch' || inputs.cleanup_resources)"
+ needs: [docker-build, deploy, e2e-test]
+ uses: ./.github/workflows/job-cleanup-deployment.yml
+ with:
+ runner_os: ${{ inputs.runner_os }}
+ trigger_type: ${{ inputs.trigger_type }}
+ cleanup_resources: ${{ inputs.cleanup_resources }}
+ existing_webapp_url: ${{ inputs.existing_webapp_url }}
+ RESOURCE_GROUP_NAME: ${{ needs.deploy.outputs.RESOURCE_GROUP_NAME }}
+ AZURE_LOCATION: ${{ needs.deploy.outputs.AZURE_LOCATION }}
+ AZURE_ENV_OPENAI_LOCATION: ${{ needs.deploy.outputs.AZURE_ENV_OPENAI_LOCATION }}
+ ENV_NAME: ${{ needs.deploy.outputs.ENV_NAME }}
+ IMAGE_TAG: ${{ needs.deploy.outputs.IMAGE_TAG }}
+ secrets: inherit
diff --git a/archive-doc-gen/.github/workflows/deploy-v2.yml b/archive-doc-gen/.github/workflows/deploy-v2.yml
new file mode 100644
index 000000000..555b7614b
--- /dev/null
+++ b/archive-doc-gen/.github/workflows/deploy-v2.yml
@@ -0,0 +1,853 @@
+name: Deploy-Test-Cleanup (v2)
+on:
+ pull_request:
+ branches:
+ - main
+ workflow_run:
+ workflows: ["Build Docker and Optional Push"]
+ types:
+ - completed
+ branches:
+ - main
+ - dev
+ - demo
+ workflow_dispatch:
+ inputs:
+ azure_location:
+ description: 'Azure Location For Deployment'
+ required: false
+ default: 'australiaeast'
+ type: choice
+ options:
+ - 'australiaeast'
+ - 'centralus'
+ - 'eastasia'
+ - 'eastus2'
+ - 'japaneast'
+ - 'northeurope'
+ - 'southeastasia'
+ - 'uksouth'
+ - 'eastus'
+ resource_group_name:
+ description: 'Resource Group Name (Optional)'
+ required: false
+ default: ''
+ type: string
+
+ waf_enabled:
+ description: 'Enable WAF'
+ required: false
+ default: false
+ type: boolean
+ EXP:
+ description: 'Enable EXP'
+ required: false
+ default: false
+ type: boolean
+ build_docker_image:
+ description: 'Build And Push Docker Image (Optional)'
+ required: false
+ default: false
+ type: boolean
+ run_e2e_tests:
+ description: 'Run End-to-End Tests'
+ required: false
+ default: true
+ type: boolean
+ cleanup_resources:
+ description: 'Cleanup Deployed Resources'
+ required: false
+ default: false
+ type: boolean
+
+ AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID:
+ description: 'Log Analytics Workspace ID (Optional)'
+ required: false
+ default: ''
+ type: string
+ AZURE_EXISTING_AI_PROJECT_RESOURCE_ID:
+ description: 'AI Project Resource ID (Optional)'
+ required: false
+ default: ''
+ type: string
+ existing_webapp_url:
+ description: 'Existing WebApp URL (Skips Deployment)'
+ required: false
+ default: ''
+ type: string
+
+ schedule:
+ - cron: '0 9,21 * * *' # Runs at 9:00 AM and 9:00 PM GMT
+env:
+ GPT_MIN_CAPACITY: 150
+ TEXT_EMBEDDING_MIN_CAPACITY: 80
+ BRANCH_NAME: ${{ github.event.workflow_run.head_branch || github.head_ref || github.ref_name }}
+ # For automatic triggers (pull_request, workflow_run, schedule): force Non-WAF + Non-EXP
+ # For manual dispatch: use input values or defaults
+ WAF_ENABLED: ${{ github.event_name == 'workflow_dispatch' && (github.event.inputs.waf_enabled || false) || false }}
+ EXP: ${{ github.event_name == 'workflow_dispatch' && (github.event.inputs.EXP || false) || false }}
+ CLEANUP_RESOURCES: ${{ github.event_name == 'workflow_dispatch' && (github.event.inputs.cleanup_resources || true) || true }}
+ RUN_E2E_TESTS: ${{ github.event_name == 'workflow_dispatch' && (github.event.inputs.run_e2e_tests || true) || true }}
+ BUILD_DOCKER_IMAGE: ${{ github.event_name == 'workflow_dispatch' && (github.event.inputs.build_docker_image || false) || false }}
+ AZURE_DEV_COLLECT_TELEMETRY: ${{ vars.AZURE_DEV_COLLECT_TELEMETRY }}
+
+jobs:
+ docker-build:
+ if: github.event_name == 'workflow_dispatch' && github.event.inputs.build_docker_image == 'true'
+ runs-on: ubuntu-latest
+ outputs:
+ IMAGE_TAG: ${{ steps.generate_docker_tag.outputs.IMAGE_TAG }}
+ steps:
+ - name: Checkout Code
+ uses: actions/checkout@v4
+
+ - name: Generate Unique Docker Image Tag
+ id: generate_docker_tag
+ run: |
+ echo "🔨 Building new Docker image - generating unique tag..."
+ # Generate unique tag for manual deployment runs
+ TIMESTAMP=$(date +%Y%m%d-%H%M%S)
+ RUN_ID="${{ github.run_id }}"
+ BRANCH_NAME="${{ github.head_ref || github.ref_name }}"
+ # Sanitize branch name for Docker tag (replace invalid characters with hyphens)
+ CLEAN_BRANCH_NAME=$(echo "$BRANCH_NAME" | sed 's/[^a-zA-Z0-9._-]/-/g' | sed 's/--*/-/g' | sed 's/^-\|-$//g')
+ UNIQUE_TAG="${CLEAN_BRANCH_NAME}-${TIMESTAMP}-${RUN_ID}"
+ echo "IMAGE_TAG=$UNIQUE_TAG" >> $GITHUB_ENV
+ echo "IMAGE_TAG=$UNIQUE_TAG" >> $GITHUB_OUTPUT
+ echo "Generated unique Docker tag: $UNIQUE_TAG"
+
+ - name: Set up Docker Buildx
+ uses: docker/setup-buildx-action@v3
+
+ - name: Log in to Azure Container Registry
+ uses: azure/docker-login@v2
+ with:
+ login-server: ${{ secrets.ACR_TEST_LOGIN_SERVER }}
+ username: ${{ secrets.ACR_TEST_USERNAME }}
+ password: ${{ secrets.ACR_TEST_PASSWORD }}
+
+ - name: Build and Push Docker Image
+ id: build_push_image
+ uses: docker/build-push-action@v6
+ env:
+ DOCKER_BUILD_SUMMARY: false
+ with:
+ context: ./src
+ file: ./src/WebApp.Dockerfile
+ push: true
+ tags: |
+ ${{ secrets.ACR_TEST_LOGIN_SERVER }}/webapp:${{ steps.generate_docker_tag.outputs.IMAGE_TAG }}
+ ${{ secrets.ACR_TEST_LOGIN_SERVER }}/webapp:${{ steps.generate_docker_tag.outputs.IMAGE_TAG }}_${{ github.run_number }}
+
+ - name: Verify Docker Image Build
+ run: |
+ echo "✅ Docker image successfully built and pushed"
+ echo "Image tag: ${{ steps.generate_docker_tag.outputs.IMAGE_TAG }}"
+ echo "Run number: ${{ github.run_number }}"
+
+ - name: Generate Docker Build Summary
+ if: always()
+ run: |
+ # Extract ACR name from the secret
+ ACR_NAME=$(echo "${{ secrets.ACR_TEST_LOGIN_SERVER }}" | cut -d'.' -f1)
+ echo "## 🐳 Docker Build Job Summary" >> $GITHUB_STEP_SUMMARY
+ echo "" >> $GITHUB_STEP_SUMMARY
+ echo "| Field | Value |" >> $GITHUB_STEP_SUMMARY
+ echo "|-------|--------|" >> $GITHUB_STEP_SUMMARY
+ echo "| **Job Status** | ${{ job.status == 'success' && '✅ Success' || '❌ Failed' }} |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Image Tag** | \`${{ steps.generate_docker_tag.outputs.IMAGE_TAG }}\` |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Registry** | \`${ACR_NAME}.azurecr.io\` |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Full Image Path** | \`${ACR_NAME}.azurecr.io/webapp:${{ steps.generate_docker_tag.outputs.IMAGE_TAG }}\` |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Trigger** | ${{ github.event_name }} |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Branch** | ${{ env.BRANCH_NAME }} |" >> $GITHUB_STEP_SUMMARY
+ echo "" >> $GITHUB_STEP_SUMMARY
+ if [[ "${{ job.status }}" == "success" ]]; then
+ echo "### ✅ Build Details" >> $GITHUB_STEP_SUMMARY
+ echo "- Docker image successfully built and pushed to ACR" >> $GITHUB_STEP_SUMMARY
+ echo "- Generated unique tag: \`${{ steps.generate_docker_tag.outputs.IMAGE_TAG }}\`" >> $GITHUB_STEP_SUMMARY
+ else
+ echo "### ❌ Build Failed" >> $GITHUB_STEP_SUMMARY
+ echo "- Docker build process encountered an error" >> $GITHUB_STEP_SUMMARY
+ echo "- Check the docker-build job for detailed error information" >> $GITHUB_STEP_SUMMARY
+ fi
+
+ deploy:
+ if: always() && (github.event_name != 'workflow_dispatch' || github.event.inputs.existing_webapp_url == '' || github.event.inputs.existing_webapp_url == null)
+ needs: [docker-build]
+ runs-on: ubuntu-latest
+ outputs:
+ RESOURCE_GROUP_NAME: ${{ steps.check_create_rg.outputs.RESOURCE_GROUP_NAME }}
+ WEBAPP_URL: ${{ steps.get_output.outputs.WEBAPP_URL }}
+ ENV_NAME: ${{ steps.generate_env_name.outputs.ENV_NAME }}
+ AZURE_LOCATION: ${{ steps.set_region.outputs.AZURE_LOCATION }}
+ AZURE_ENV_OPENAI_LOCATION: ${{ steps.set_region.outputs.AZURE_ENV_OPENAI_LOCATION }}
+ IMAGE_TAG: ${{ steps.determine_image_tag.outputs.IMAGE_TAG }}
+ QUOTA_FAILED: ${{ steps.quota_failure_output.outputs.QUOTA_FAILED }}
+ env:
+ # For automatic triggers: force Non-WAF + Non-EXP, for manual dispatch: use inputs
+ WAF_ENABLED: ${{ github.event_name == 'workflow_dispatch' && (github.event.inputs.waf_enabled || false) || false }}
+ EXP: ${{ github.event_name == 'workflow_dispatch' && (github.event.inputs.EXP || false) || false }}
+ CLEANUP_RESOURCES: ${{ github.event_name == 'workflow_dispatch' && (github.event.inputs.cleanup_resources || true) || true }}
+
+ steps:
+ - name: Display Workflow Configuration
+ run: |
+ echo "🚀 ==================================="
+ echo "📋 WORKFLOW CONFIGURATION SUMMARY"
+ echo "🚀 ==================================="
+ echo "Trigger Type: ${{ github.event_name }}"
+ echo "Branch: ${{ env.BRANCH_NAME }}"
+ echo ""
+ echo "Configuration Settings:"
+ echo " • WAF Enabled: ${{ env.WAF_ENABLED }}"
+ echo " • EXP Enabled: ${{ env.EXP }}"
+ echo " • Run E2E Tests: ${{ env.RUN_E2E_TESTS }}"
+ echo " • Cleanup Resources: ${{ env.CLEANUP_RESOURCES }}"
+ echo " • Build Docker Image: ${{ env.BUILD_DOCKER_IMAGE }}"
+ if [[ "${{ github.event_name }}" == "workflow_dispatch" && -n "${{ github.event.inputs.azure_location }}" ]]; then
+ echo " • Selected Azure Location: ${{ github.event.inputs.azure_location }}"
+ else
+ echo " • Azure Location: Will be determined by quota check"
+ fi
+ if [[ "${{ github.event.inputs.existing_webapp_url }}" != "" ]]; then
+ echo " • Using Existing Webapp URL: ${{ github.event.inputs.existing_webapp_url }}"
+ echo " • Skip Deployment: Yes"
+ else
+ echo " • Skip Deployment: No"
+ fi
+ echo ""
+ if [[ "${{ github.event_name }}" != "workflow_dispatch" ]]; then
+ echo "ℹ️ Automatic Trigger: Using Non-WAF + Non-EXP configuration"
+ else
+ echo "ℹ️ Manual Trigger: Using user-specified configuration"
+ # Check if EXP was auto-enabled after user input validation
+ if [[ "${{ env.EXP }}" == "true" && "${{ github.event.inputs.EXP }}" != "true" ]]; then
+ echo "🔧 Note: EXP was automatically enabled due to provided parameter values"
+ fi
+ fi
+ echo "🚀 ==================================="
+
+ - name: Validate and Auto-Configure EXP
+ run: |
+ echo "🔍 Validating EXP configuration..."
+
+ # Check if EXP values were provided but EXP is disabled
+ if [[ "${{ github.event.inputs.EXP }}" != "true" ]]; then
+ if [[ -n "${{ github.event.inputs.AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID }}" ]] || [[ -n "${{ github.event.inputs.AZURE_EXISTING_AI_PROJECT_RESOURCE_ID }}" ]]; then
+ echo "🔧 AUTO-ENABLING EXP: EXP parameter values were provided but EXP was not explicitly enabled."
+ echo ""
+ echo "You provided values for:"
+ [[ -n "${{ github.event.inputs.AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID }}" ]] && echo " - Azure Log Analytics Workspace ID: '${{ github.event.inputs.AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID }}'"
+ [[ -n "${{ github.event.inputs.AZURE_EXISTING_AI_PROJECT_RESOURCE_ID }}" ]] && echo " - Azure AI Project Resource ID: '${{ github.event.inputs.AZURE_EXISTING_AI_PROJECT_RESOURCE_ID }}'"
+ echo ""
+ echo "✅ Automatically enabling EXP to use these values."
+ echo "EXP=true" >> $GITHUB_ENV
+ echo "📌 EXP has been automatically enabled for this deployment."
+ fi
+ fi
+
+ - name: Checkout Code
+ uses: actions/checkout@v4
+
+ - name: Setup Azure CLI
+ run: |
+ curl -sL https://aka.ms/InstallAzureCLIDeb | sudo bash
+ az --version # Verify installation
+
+ - name: Run Quota Check
+ id: quota-check
+ run: |
+ export AZURE_CLIENT_ID=${{ secrets.AZURE_CLIENT_ID }}
+ export AZURE_TENANT_ID=${{ secrets.AZURE_TENANT_ID }}
+ export AZURE_CLIENT_SECRET=${{ secrets.AZURE_CLIENT_SECRET }}
+ export AZURE_SUBSCRIPTION_ID="${{ secrets.AZURE_SUBSCRIPTION_ID }}"
+ export GPT_MIN_CAPACITY=${{ env.GPT_MIN_CAPACITY }}
+ export TEXT_EMBEDDING_MIN_CAPACITY=${{ env.TEXT_EMBEDDING_MIN_CAPACITY }}
+ export AZURE_REGIONS="${{ vars.AZURE_REGIONS }}"
+
+ chmod +x scripts/checkquota.sh
+ if ! scripts/checkquota.sh; then
+ # If quota check fails due to insufficient quota, set the flag
+ if grep -q "No region with sufficient quota found" scripts/checkquota.sh; then
+ echo "QUOTA_FAILED=true" >> $GITHUB_ENV
+ fi
+ exit 1 # Fail the pipeline if any other failure occurs
+ fi
+
+
+
+
+ - name: Set Quota Failure Output
+ id: quota_failure_output
+ if: env.QUOTA_FAILED == 'true'
+ run: |
+ echo "QUOTA_FAILED=true" >> $GITHUB_OUTPUT
+ echo "Quota check failed - will notify via separate notification job"
+
+ - name: Fail Pipeline if Quota Check Fails
+ if: env.QUOTA_FAILED == 'true'
+ run: exit 1
+
+ - name: Set Deployment Region
+ id: set_region
+ run: |
+ # Set AZURE_ENV_OPENAI_LOCATION from quota check result
+ echo "Selected Region from Quota Check: $VALID_REGION"
+ echo "AZURE_ENV_OPENAI_LOCATION=$VALID_REGION" >> $GITHUB_ENV
+ echo "AZURE_ENV_OPENAI_LOCATION=$VALID_REGION" >> $GITHUB_OUTPUT
+
+ # Set AZURE_LOCATION from user input (for manual dispatch) or default to quota check result (for automatic triggers)
+ if [[ "${{ github.event_name }}" == "workflow_dispatch" && -n "${{ github.event.inputs.azure_location }}" ]]; then
+ USER_SELECTED_LOCATION="${{ github.event.inputs.azure_location }}"
+ echo "Using user-selected Azure location: $USER_SELECTED_LOCATION"
+ echo "AZURE_LOCATION=$USER_SELECTED_LOCATION" >> $GITHUB_ENV
+ echo "AZURE_LOCATION=$USER_SELECTED_LOCATION" >> $GITHUB_OUTPUT
+ else
+ echo "Using location from quota check for automatic triggers: $VALID_REGION"
+ echo "AZURE_LOCATION=$VALID_REGION" >> $GITHUB_ENV
+ echo "AZURE_LOCATION=$VALID_REGION" >> $GITHUB_OUTPUT
+ fi
+
+ - name: Generate Resource Group Name
+ id: generate_rg_name
+ run: |
+ # Check if a resource group name was provided as input
+ if [[ -n "${{ github.event.inputs.resource_group_name }}" ]]; then
+ echo "Using provided Resource Group name: ${{ github.event.inputs.resource_group_name }}"
+ echo "RESOURCE_GROUP_NAME=${{ github.event.inputs.resource_group_name }}" >> $GITHUB_ENV
+ else
+ echo "Generating a unique resource group name..."
+ ACCL_NAME="docgen" # Account name as specified
+ SHORT_UUID=$(uuidgen | cut -d'-' -f1)
+ UNIQUE_RG_NAME="arg-${ACCL_NAME}-${SHORT_UUID}"
+ echo "RESOURCE_GROUP_NAME=${UNIQUE_RG_NAME}" >> $GITHUB_ENV
+ echo "Generated RESOURCE_GROUP_NAME: ${UNIQUE_RG_NAME}"
+ fi
+
+ - name: Setup Azure Developer CLI
+ run: |
+ curl -fsSL https://aka.ms/install-azd.sh | sudo bash
+ azd version
+
+ - name: Login to Azure
+ id: login-azure
+ run: |
+ az login --service-principal -u ${{ secrets.AZURE_CLIENT_ID }} -p ${{ secrets.AZURE_CLIENT_SECRET }} --tenant ${{ secrets.AZURE_TENANT_ID }}
+ azd auth login --client-id ${{ secrets.AZURE_CLIENT_ID }} --client-secret ${{ secrets.AZURE_CLIENT_SECRET }} --tenant-id ${{ secrets.AZURE_TENANT_ID }}
+
+ - name: Install Bicep CLI
+ run: az bicep install
+
+ - name: Check and Create Resource Group
+ id: check_create_rg
+ run: |
+ set -e
+ echo "🔍 Checking if resource group '$RESOURCE_GROUP_NAME' exists..."
+ rg_exists=$(az group exists --name $RESOURCE_GROUP_NAME)
+ if [ "$rg_exists" = "false" ]; then
+ echo "📦 Resource group does not exist. Creating new resource group '$RESOURCE_GROUP_NAME' in location '$AZURE_LOCATION'..."
+ az group create --name $RESOURCE_GROUP_NAME --location $AZURE_LOCATION || { echo "❌ Error creating resource group"; exit 1; }
+ echo "✅ Resource group '$RESOURCE_GROUP_NAME' created successfully."
+ else
+ echo "✅ Resource group '$RESOURCE_GROUP_NAME' already exists. Deploying to existing resource group."
+ fi
+ echo "RESOURCE_GROUP_NAME=$RESOURCE_GROUP_NAME" >> $GITHUB_OUTPUT
+
+ - name: Generate Unique Solution Prefix
+ id: generate_solution_prefix
+ run: |
+ set -e
+ COMMON_PART="psldg"
+ TIMESTAMP=$(date +%s)
+ UPDATED_TIMESTAMP=$(echo $TIMESTAMP | tail -c 6)
+ UNIQUE_SOLUTION_PREFIX="${COMMON_PART}${UPDATED_TIMESTAMP}"
+ echo "SOLUTION_PREFIX=${UNIQUE_SOLUTION_PREFIX}" >> $GITHUB_ENV
+ echo "Generated SOLUTION_PREFIX: ${UNIQUE_SOLUTION_PREFIX}"
+
+ - name: Determine Docker Image Tag
+ id: determine_image_tag
+ run: |
+ if [[ "${{ env.BUILD_DOCKER_IMAGE }}" == "true" ]]; then
+ # Use the tag from docker-build job if it was built
+ if [[ "${{ needs.docker-build.result }}" == "success" ]]; then
+ IMAGE_TAG="${{ needs.docker-build.outputs.IMAGE_TAG }}"
+ echo "🔗 Using Docker image tag from build job: $IMAGE_TAG"
+ else
+ echo "❌ Docker build job failed or was skipped, but BUILD_DOCKER_IMAGE is true"
+ exit 1
+ fi
+ else
+ echo "🏷️ Using existing Docker image based on branch..."
+ BRANCH_NAME="${{ env.BRANCH_NAME }}"
+ echo "Current branch: $BRANCH_NAME"
+
+ # Determine image tag based on branch
+ if [[ "$BRANCH_NAME" == "main" ]]; then
+ IMAGE_TAG="latest_waf"
+ echo "Using main branch - image tag: latest_waf"
+ elif [[ "$BRANCH_NAME" == "dev" ]]; then
+ IMAGE_TAG="dev"
+ echo "Using dev branch - image tag: dev"
+ elif [[ "$BRANCH_NAME" == "demo" ]]; then
+ IMAGE_TAG="demo"
+ echo "Using demo branch - image tag: demo"
+ else
+ IMAGE_TAG="latest_waf"
+ echo "Using default for branch '$BRANCH_NAME' - image tag: latest_waf"
+ fi
+
+ echo "Using existing Docker image tag: $IMAGE_TAG"
+ fi
+
+ echo "IMAGE_TAG=$IMAGE_TAG" >> $GITHUB_ENV
+ echo "IMAGE_TAG=$IMAGE_TAG" >> $GITHUB_OUTPUT
+
+ - name: Generate Unique Environment Name
+ id: generate_env_name
+ run: |
+ COMMON_PART="pslc"
+ TIMESTAMP=$(date +%s)
+ UPDATED_TIMESTAMP=$(echo $TIMESTAMP | tail -c 6)
+ UNIQUE_ENV_NAME="${COMMON_PART}${UPDATED_TIMESTAMP}"
+ echo "ENV_NAME=${UNIQUE_ENV_NAME}" >> $GITHUB_ENV
+ echo "Generated Environment Name: ${UNIQUE_ENV_NAME}"
+ echo "ENV_NAME=${UNIQUE_ENV_NAME}" >> $GITHUB_OUTPUT
+
+ - name: Configure Parameters Based on WAF Setting
+ run: |
+ if [[ "${{ env.WAF_ENABLED }}" == "true" ]]; then
+ echo "🔧 Configuring WAF deployment - copying main.waf.parameters.json to main.parameters.json..."
+ cp infra/main.waf.parameters.json infra/main.parameters.json
+ echo "✅ Successfully copied WAF parameters to main parameters file"
+ else
+ echo "🔧 Configuring Non-WAF deployment - using default main.parameters.json..."
+ # Ensure we have the original parameters file if it was overwritten
+ if [[ -f infra/main.waf.parameters.json ]] && [[ ! -f infra/main.parameters.json.backup ]]; then
+ echo "Backing up original parameters file..."
+ git checkout HEAD -- infra/main.parameters.json || echo "Using existing main.parameters.json"
+ fi
+ fi
+
+ - name: Display Docker Image Tag
+ run: |
+ echo "=== Docker Image Information ==="
+ echo "Docker Image Tag: ${{ steps.determine_image_tag.outputs.IMAGE_TAG }}"
+ echo "Registry: ${{ secrets.ACR_TEST_LOGIN_SERVER }}"
+ echo "Full Image: ${{ secrets.ACR_TEST_LOGIN_SERVER }}/webapp:${{ steps.determine_image_tag.outputs.IMAGE_TAG }}"
+ echo "================================"
+
+ - name: Deploy using azd up and extract values (${{ github.event.inputs.waf_enabled == 'true' && 'WAF' || 'Non-WAF' }}+${{ (github.event.inputs.EXP == 'true' || github.event.inputs.AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID != '' || github.event.inputs.AZURE_EXISTING_AI_PROJECT_RESOURCE_ID != '') && 'EXP' || 'Non-EXP' }})
+ id: get_output
+ run: |
+ set -e
+ echo "Starting azd deployment..."
+ echo "WAF Enabled: ${{ env.WAF_ENABLED }}"
+ echo "EXP: ${{ env.EXP }}"
+ echo "Using Docker Image Tag: ${{ steps.determine_image_tag.outputs.IMAGE_TAG }}"
+
+ # Install azd (Azure Developer CLI)
+ curl -fsSL https://aka.ms/install-azd.sh | bash
+
+ # Generate current timestamp in desired format: YYYY-MM-DDTHH:MM:SS.SSSSSSSZ
+ current_date=$(date -u +"%Y-%m-%dT%H:%M:%S.%7NZ")
+
+ echo "Creating environment..."
+ azd env new $ENV_NAME --no-prompt
+ echo "Environment created: $ENV_NAME"
+
+ echo "Setting default subscription..."
+ azd config set defaults.subscription ${{ secrets.AZURE_SUBSCRIPTION_ID }}
+
+ # Set additional parameters
+ azd env set AZURE_SUBSCRIPTION_ID="${{ secrets.AZURE_SUBSCRIPTION_ID }}"
+ azd env set AZURE_ENV_OPENAI_LOCATION="$AZURE_ENV_OPENAI_LOCATION"
+ azd env set AZURE_LOCATION="$AZURE_LOCATION"
+ azd env set AZURE_RESOURCE_GROUP="$RESOURCE_GROUP_NAME"
+ azd env set AZURE_ENV_IMAGETAG="${{ steps.determine_image_tag.outputs.IMAGE_TAG }}"
+
+ # Set ACR name only when building Docker image
+ if [[ "${{ env.BUILD_DOCKER_IMAGE }}" == "true" ]]; then
+ # Extract ACR name from login server and set as environment variable
+ ACR_NAME=$(echo "${{ secrets.ACR_TEST_LOGIN_SERVER }}" | cut -d'.' -f1)
+ azd env set AZURE_ENV_ACR_NAME="$ACR_NAME"
+ echo "Set ACR name to: $ACR_NAME"
+ else
+ echo "Skipping ACR name configuration (using existing image)"
+ fi
+
+ if [[ "${{ env.EXP }}" == "true" ]]; then
+ echo "✅ EXP ENABLED - Setting EXP parameters..."
+
+ # Set EXP variables dynamically
+ if [[ -n "${{ github.event.inputs.AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID }}" ]]; then
+ EXP_LOG_ANALYTICS_ID="${{ github.event.inputs.AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID }}"
+ else
+ EXP_LOG_ANALYTICS_ID="${{ secrets.EXP_LOG_ANALYTICS_WORKSPACE_ID }}"
+ fi
+
+ if [[ -n "${{ github.event.inputs.AZURE_EXISTING_AI_PROJECT_RESOURCE_ID }}" ]]; then
+ EXP_AI_PROJECT_ID="${{ github.event.inputs.AZURE_EXISTING_AI_PROJECT_RESOURCE_ID }}"
+ else
+ EXP_AI_PROJECT_ID="${{ secrets.EXP_AI_PROJECT_RESOURCE_ID }}"
+ fi
+
+ echo "AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID: $EXP_LOG_ANALYTICS_ID"
+ echo "AZURE_EXISTING_AI_PROJECT_RESOURCE_ID: $EXP_AI_PROJECT_ID"
+ azd env set AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID="$EXP_LOG_ANALYTICS_ID"
+ azd env set AZURE_EXISTING_AI_PROJECT_RESOURCE_ID="$EXP_AI_PROJECT_ID"
+ else
+ echo "❌ EXP DISABLED - Skipping EXP parameters"
+ if [[ -n "${{ github.event.inputs.AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID }}" ]] || [[ -n "${{ github.event.inputs.AZURE_EXISTING_AI_PROJECT_RESOURCE_ID }}" ]]; then
+ echo "⚠️ Warning: EXP parameter values provided but EXP is disabled. These values will be ignored."
+ fi
+ fi
+
+ # Deploy using azd up
+ azd up --no-prompt
+
+ # Get deployment outputs using azd
+ echo "Extracting deployment outputs..."
+ DEPLOY_OUTPUT=$(azd env get-values --output json)
+ echo "Deployment output: $DEPLOY_OUTPUT"
+
+ if [[ -z "$DEPLOY_OUTPUT" ]]; then
+ echo "Error: Deployment output is empty. Please check the deployment logs."
+ exit 1
+ fi
+
+ # Extract values from azd output (adjust these based on actual output variable names)
+ export AI_FOUNDRY_RESOURCE_ID=$(echo "$DEPLOY_OUTPUT" | jq -r '.AI_FOUNDRY_RESOURCE_ID // empty')
+ echo "AI_FOUNDRY_RESOURCE_ID=$AI_FOUNDRY_RESOURCE_ID" >> $GITHUB_ENV
+ export AI_SEARCH_SERVICE_NAME=$(echo "$DEPLOY_OUTPUT" | jq -r '.AI_SEARCH_SERVICE_NAME // empty')
+ echo "AI_SEARCH_SERVICE_NAME=$AI_SEARCH_SERVICE_NAME" >> $GITHUB_ENV
+ export AZURE_COSMOSDB_ACCOUNT=$(echo "$DEPLOY_OUTPUT" | jq -r '.AZURE_COSMOSDB_ACCOUNT // empty')
+ echo "AZURE_COSMOSDB_ACCOUNT=$AZURE_COSMOSDB_ACCOUNT" >> $GITHUB_ENV
+ export STORAGE_ACCOUNT_NAME=$(echo "$DEPLOY_OUTPUT" | jq -r '.STORAGE_ACCOUNT_NAME // empty')
+ echo "STORAGE_ACCOUNT_NAME=$STORAGE_ACCOUNT_NAME" >> $GITHUB_ENV
+ export STORAGE_CONTAINER_NAME=$(echo "$DEPLOY_OUTPUT" | jq -r '.STORAGE_CONTAINER_NAME // empty')
+ echo "STORAGE_CONTAINER_NAME=$STORAGE_CONTAINER_NAME" >> $GITHUB_ENV
+ export KEY_VAULT_NAME=$(echo "$DEPLOY_OUTPUT" | jq -r '.KEY_VAULT_NAME // empty')
+ echo "KEY_VAULT_NAME=$KEY_VAULT_NAME" >> $GITHUB_ENV
+ export RESOURCE_GROUP_NAME=$(echo "$DEPLOY_OUTPUT" | jq -r '.RESOURCE_GROUP_NAME // .AZURE_RESOURCE_GROUP // empty')
+ [[ -z "$RESOURCE_GROUP_NAME" ]] && export RESOURCE_GROUP_NAME="$RESOURCE_GROUP_NAME"
+ echo "RESOURCE_GROUP_NAME=$RESOURCE_GROUP_NAME" >> $GITHUB_ENV
+ WEBAPP_URL=$(echo "$DEPLOY_OUTPUT" | jq -r '.WEB_APP_URL // .SERVICE_BACKEND_ENDPOINT_URL // empty')
+ echo "WEBAPP_URL=$WEBAPP_URL" >> $GITHUB_OUTPUT
+ sleep 30
+
+ - name: Run Post-Deployment Script
+ id: post_deploy
+ env:
+ AZURE_SUBSCRIPTION_ID: ${{ secrets.AZURE_SUBSCRIPTION_ID }}
+ run: |
+ set -e
+ az account set --subscription "${{ secrets.AZURE_SUBSCRIPTION_ID }}"
+
+ echo "Running post-deployment script..."
+
+ bash ./infra/scripts/process_sample_data.sh \
+ "$STORAGE_ACCOUNT_NAME" \
+ "$STORAGE_CONTAINER_NAME" \
+ "$KEY_VAULT_NAME" \
+ "$AZURE_COSMOSDB_ACCOUNT" \
+ "$RESOURCE_GROUP_NAME" \
+ "$AI_SEARCH_SERVICE_NAME" \
+ "${{ secrets.AZURE_CLIENT_ID }}" \
+ "$AI_FOUNDRY_RESOURCE_ID"
+
+ - name: Logout from Azure
+ if: always()
+ run: |
+ az logout
+ echo "Logged out from Azure."
+
+
+
+ - name: Generate Deploy Job Summary
+ if: always()
+ run: |
+ echo "## 🚀 Deploy Job Summary" >> $GITHUB_STEP_SUMMARY
+ echo "" >> $GITHUB_STEP_SUMMARY
+ echo "| Field | Value |" >> $GITHUB_STEP_SUMMARY
+ echo "|-------|--------|" >> $GITHUB_STEP_SUMMARY
+ echo "| **Job Status** | ${{ job.status == 'success' && '✅ Success' || '❌ Failed' }} |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Environment Name** | \`${{ steps.generate_env_name.outputs.ENV_NAME }}\` |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Resource Group** | \`${{ steps.check_create_rg.outputs.RESOURCE_GROUP_NAME }}\` |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Azure Region (Infrastructure)** | \`${{ steps.set_region.outputs.AZURE_LOCATION }}\` |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Azure OpenAI Region** | \`${{ steps.set_region.outputs.AZURE_ENV_OPENAI_LOCATION }}\` |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Docker Image Tag** | \`${{ steps.determine_image_tag.outputs.IMAGE_TAG }}\` |" >> $GITHUB_STEP_SUMMARY
+ echo "| **WAF Enabled** | ${{ env.WAF_ENABLED == 'true' && '✅ Yes' || '❌ No' }} |" >> $GITHUB_STEP_SUMMARY
+ echo "| **EXP Enabled** | ${{ env.EXP == 'true' && '✅ Yes' || '❌ No' }} |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Trigger** | ${{ github.event_name }} |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Branch** | ${{ env.BRANCH_NAME }} |" >> $GITHUB_STEP_SUMMARY
+ echo "" >> $GITHUB_STEP_SUMMARY
+ if [[ "${{ job.status }}" == "success" ]]; then
+ echo "### ✅ Deployment Details" >> $GITHUB_STEP_SUMMARY
+ echo "- **Web App URL**: [${{ steps.get_output.outputs.WEBAPP_URL }}](${{ steps.get_output.outputs.WEBAPP_URL }})" >> $GITHUB_STEP_SUMMARY
+ echo "- **Configuration**: ${{ env.WAF_ENABLED == 'true' && 'WAF' || 'Non-WAF' }}+${{ env.EXP == 'true' && 'EXP' || 'Non-EXP' }}" >> $GITHUB_STEP_SUMMARY
+ echo "- Successfully deployed to Azure with all resources configured" >> $GITHUB_STEP_SUMMARY
+ echo "- Post-deployment scripts executed successfully" >> $GITHUB_STEP_SUMMARY
+ else
+ echo "### ❌ Deployment Failed" >> $GITHUB_STEP_SUMMARY
+ echo "- Deployment process encountered an error" >> $GITHUB_STEP_SUMMARY
+ echo "- Check the deploy job for detailed error information" >> $GITHUB_STEP_SUMMARY
+ fi
+
+ e2e-test:
+ if: always() && ((needs.deploy.result == 'success' && needs.deploy.outputs.WEBAPP_URL != '') || (github.event.inputs.existing_webapp_url != '' && github.event.inputs.existing_webapp_url != null)) && (github.event_name != 'workflow_dispatch' || github.event.inputs.run_e2e_tests == 'true' || github.event.inputs.run_e2e_tests == null)
+ needs: [docker-build, deploy]
+ uses: ./.github/workflows/test-automation.yml
+ with:
+ DOCGEN_URL: ${{ github.event.inputs.existing_webapp_url || needs.deploy.outputs.WEBAPP_URL }}
+ secrets: inherit
+
+ cleanup-deployment:
+ if: always() && needs.deploy.result == 'success' && needs.deploy.outputs.RESOURCE_GROUP_NAME != '' && github.event.inputs.existing_webapp_url == '' && (github.event_name != 'workflow_dispatch' || github.event.inputs.cleanup_resources == 'true' || github.event.inputs.cleanup_resources == null)
+ needs: [docker-build, deploy, e2e-test]
+ runs-on: ubuntu-latest
+ env:
+ RESOURCE_GROUP_NAME: ${{ needs.deploy.outputs.RESOURCE_GROUP_NAME }}
+ AZURE_LOCATION: ${{ needs.deploy.outputs.AZURE_LOCATION }}
+ AZURE_ENV_OPENAI_LOCATION: ${{ needs.deploy.outputs.AZURE_ENV_OPENAI_LOCATION }}
+ ENV_NAME: ${{ needs.deploy.outputs.ENV_NAME }}
+ IMAGE_TAG: ${{ needs.deploy.outputs.IMAGE_TAG }}
+ steps:
+ - name: Checkout Code
+ uses: actions/checkout@v4
+
+ - name: Setup Azure Developer CLI
+ run: |
+ curl -fsSL https://aka.ms/install-azd.sh | sudo bash
+ azd version
+
+ - name: Login to Azure
+ run: |
+ azd auth login --client-id ${{ secrets.AZURE_CLIENT_ID }} --client-secret ${{ secrets.AZURE_CLIENT_SECRET }} --tenant-id ${{ secrets.AZURE_TENANT_ID }}
+ azd config set defaults.subscription ${{ secrets.AZURE_SUBSCRIPTION_ID }}
+
+ - name: Setup Azure CLI for Docker cleanup
+ run: |
+ curl -sL https://aka.ms/InstallAzureCLIDeb | sudo bash
+ az --version
+
+ - name: Login to Azure CLI for Docker cleanup
+ run: |
+ az login --service-principal -u ${{ secrets.AZURE_CLIENT_ID }} -p ${{ secrets.AZURE_CLIENT_SECRET }} --tenant ${{ secrets.AZURE_TENANT_ID }}
+
+ - name: Delete Docker Images from ACR
+ if: github.event.inputs.existing_webapp_url == ''
+ run: |
+ set -e
+ echo "🗑️ Cleaning up Docker images from Azure Container Registry..."
+
+ # Determine the image tag to delete - check if docker-build job ran
+ if [[ "${{ needs.docker-build.result }}" == "success" ]]; then
+ IMAGE_TAG="${{ needs.docker-build.outputs.IMAGE_TAG }}"
+ echo "Using image tag from docker-build job: $IMAGE_TAG"
+ else
+ IMAGE_TAG="${{ needs.deploy.outputs.IMAGE_TAG }}"
+ echo "Using image tag from deploy job: $IMAGE_TAG"
+ fi
+
+ if [[ -n "$IMAGE_TAG" && "$IMAGE_TAG" != "latest_waf" && "$IMAGE_TAG" != "dev" && "$IMAGE_TAG" != "demo" ]]; then
+ echo "Deleting Docker images with tag: $IMAGE_TAG"
+
+ # Delete the main image
+ echo "Deleting image: ${{ secrets.ACR_TEST_LOGIN_SERVER }}/webapp:$IMAGE_TAG"
+ az acr repository delete --name $(echo "${{ secrets.ACR_TEST_LOGIN_SERVER }}" | cut -d'.' -f1) \
+ --image webapp:$IMAGE_TAG --yes || echo "Warning: Failed to delete main image or image not found"
+
+ echo "✅ Docker images cleanup completed"
+ else
+ echo "⚠️ Skipping Docker image cleanup (using standard branch image: $IMAGE_TAG)"
+ fi
+
+ - name: Select Environment and Delete deployment using azd
+ run: |
+ set -e
+ # Try to select the environment if it exists, otherwise create a minimal environment for cleanup
+ azd env list
+ if azd env list | grep -q "${{ env.ENV_NAME }}"; then
+ echo "Environment ${{ env.ENV_NAME }} found, selecting it..."
+ azd env select ${{ env.ENV_NAME }}
+ else
+ echo "Environment ${{ env.ENV_NAME }} not found, creating minimal environment for cleanup..."
+ azd env new ${{ env.ENV_NAME }} --no-prompt
+ azd env set AZURE_RESOURCE_GROUP "${{ env.RESOURCE_GROUP_NAME }}"
+ azd env set AZURE_SUBSCRIPTION_ID "${{ secrets.AZURE_SUBSCRIPTION_ID }}"
+ azd env set AZURE_ENV_OPENAI_LOCATION="${{ env.AZURE_ENV_OPENAI_LOCATION }}"
+ azd env set AZURE_LOCATION="${{ env.AZURE_LOCATION }}"
+ fi
+
+ echo "Deleting deployment..."
+ azd down --purge --force --no-prompt
+ echo "Deployment deleted successfully."
+
+
+
+ - name: Logout from Azure
+ if: always()
+ run: |
+ azd auth logout
+ az logout || echo "Warning: Failed to logout from Azure CLI"
+ echo "Logged out from Azure."
+ - name: Generate Cleanup Job Summary
+ if: always()
+ run: |
+ echo "## 🧹 Cleanup Job Summary" >> $GITHUB_STEP_SUMMARY
+ echo "" >> $GITHUB_STEP_SUMMARY
+ echo "| Field | Value |" >> $GITHUB_STEP_SUMMARY
+ echo "|-------|--------|" >> $GITHUB_STEP_SUMMARY
+ echo "| **Job Status** | ${{ job.status == 'success' && '✅ Success' || '❌ Failed' }} |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Resource Group** | \`${{ env.RESOURCE_GROUP_NAME }}\` |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Environment Name** | \`${{ env.ENV_NAME }}\` |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Azure Region (Infrastructure)** | \`${{ env.AZURE_LOCATION }}\` |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Azure OpenAI Region** | \`${{ env.AZURE_ENV_OPENAI_LOCATION }}\` |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Docker Image Tag** | \`${{ env.IMAGE_TAG }}\` |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Trigger** | ${{ github.event_name }} |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Branch** | ${{ env.BRANCH_NAME }} |" >> $GITHUB_STEP_SUMMARY
+ echo "" >> $GITHUB_STEP_SUMMARY
+ if [[ "${{ job.status }}" == "success" ]]; then
+ echo "### ✅ Cleanup Details" >> $GITHUB_STEP_SUMMARY
+ echo "- Successfully deleted Azure resource group: \`${{ env.RESOURCE_GROUP_NAME }}\`" >> $GITHUB_STEP_SUMMARY
+ if [[ "${{ env.IMAGE_TAG }}" != "latest_waf" && "${{ env.IMAGE_TAG }}" != "dev" && "${{ env.IMAGE_TAG }}" != "demo" ]]; then
+ echo "- Removed custom Docker images from ACR with tag: \`${{ env.IMAGE_TAG }}\`" >> $GITHUB_STEP_SUMMARY
+ else
+ echo "- Preserved standard Docker image (using branch tag: \`${{ env.IMAGE_TAG }}\`)" >> $GITHUB_STEP_SUMMARY
+ fi
+ echo "- All deployed resources have been successfully cleaned up" >> $GITHUB_STEP_SUMMARY
+ else
+ echo "### ❌ Cleanup Failed" >> $GITHUB_STEP_SUMMARY
+ echo "- Cleanup process encountered an error" >> $GITHUB_STEP_SUMMARY
+ echo "- Manual cleanup may be required" >> $GITHUB_STEP_SUMMARY
+ echo "- ⬇️ Check the cleanup-deployment job for detailed error information" >> $GITHUB_STEP_SUMMARY
+
+ fi
+
+ send-notification:
+ if: always()
+ needs: [docker-build, deploy, e2e-test]
+ runs-on: ubuntu-latest
+ steps:
+ - name: Send Quota Failure Notification
+ if: needs.deploy.result == 'failure' && needs.deploy.outputs.QUOTA_FAILED == 'true'
+ run: |
+ RUN_URL="https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}"
+ EMAIL_BODY=$(cat <Dear Team,We would like to inform you that the DocGen deployment has failed due to insufficient quota in the requested regions.
Issue Details:
• Quota check failed for GPT and Text Embedding models
• Required GPT Capacity: ${{ env.GPT_MIN_CAPACITY }}
• Required Text Embedding Capacity: ${{ env.TEXT_EMBEDDING_MIN_CAPACITY }}
• Checked Regions: ${{ vars.AZURE_REGIONS }}
Run URL: ${RUN_URL}
Please resolve the quota issue and retry the deployment.
Best regards,
Your Automation Team
",
+ "subject": "DocGen Pipeline - Failed (Insufficient Quota)"
+ }
+ EOF
+ )
+
+ curl -X POST "${{ secrets.EMAILNOTIFICATION_LOGICAPP_URL_TA }}" \
+ -H "Content-Type: application/json" \
+ -d "$EMAIL_BODY" || echo "Failed to send quota failure notification"
+
+ - name: Send Deployment Failure Notification
+ if: needs.deploy.result == 'failure' && needs.deploy.outputs.QUOTA_FAILED != 'true'
+ run: |
+ RUN_URL="https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}"
+ RESOURCE_GROUP="${{ needs.deploy.outputs.RESOURCE_GROUP_NAME }}"
+
+ EMAIL_BODY=$(cat <Dear Team,We would like to inform you that the DocGen deployment process has encountered an issue and has failed to complete successfully.
Deployment Details:
• Resource Group: ${RESOURCE_GROUP}
• WAF Enabled: ${{ env.WAF_ENABLED }}
• EXP Enabled: ${{ env.EXP }}
Run URL: ${RUN_URL}
Please investigate the deployment failure at your earliest convenience.
Best regards,
Your Automation Team
",
+ "subject": "DocGen Pipeline - Failed"
+ }
+ EOF
+ )
+
+ curl -X POST "${{ secrets.EMAILNOTIFICATION_LOGICAPP_URL_TA }}" \
+ -H "Content-Type: application/json" \
+ -d "$EMAIL_BODY" || echo "Failed to send deployment failure notification"
+
+ - name: Send Success Notification
+ if: needs.deploy.result == 'success' && (needs.e2e-test.result == 'skipped' || needs.e2e-test.outputs.TEST_SUCCESS == 'true')
+ run: |
+ RUN_URL="https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}"
+ WEBAPP_URL="${{ needs.deploy.outputs.WEBAPP_URL || github.event.inputs.existing_webapp_url }}"
+ RESOURCE_GROUP="${{ needs.deploy.outputs.RESOURCE_GROUP_NAME }}"
+ TEST_REPORT_URL="${{ needs.e2e-test.outputs.TEST_REPORT_URL }}"
+
+ # Create email body based on test result
+ if [ "${{ needs.e2e-test.result }}" = "skipped" ]; then
+ EMAIL_BODY=$(cat <Dear Team,We would like to inform you that the DocGen deployment has completed successfully.
Deployment Details:
• Resource Group: ${RESOURCE_GROUP}
• Web App URL: ${WEBAPP_URL}
• E2E Tests: Skipped (as configured)
Configuration:
• WAF Enabled: ${{ env.WAF_ENABLED }}
• EXP Enabled: ${{ env.EXP }}
Run URL: ${RUN_URL}
Best regards,
Your Automation Team
",
+ "subject": "DocGen Pipeline - Deployment Success"
+ }
+ EOF
+ )
+ else
+ EMAIL_BODY=$(cat <Dear Team,We would like to inform you that the DocGen deployment and testing process has completed successfully.
Deployment Details:
• Resource Group: ${RESOURCE_GROUP}
• Web App URL: ${WEBAPP_URL}
• E2E Tests: Passed
• Test Report: View Report
Configuration:
• WAF Enabled: ${{ env.WAF_ENABLED }}
• EXP Enabled: ${{ env.EXP }}
Run URL: ${RUN_URL}
Best regards,
Your Automation Team
",
+ "subject": "DocGen Pipeline - Test Automation - Success"
+ }
+ EOF
+ )
+ fi
+
+ curl -X POST "${{ secrets.EMAILNOTIFICATION_LOGICAPP_URL_TA }}" \
+ -H "Content-Type: application/json" \
+ -d "$EMAIL_BODY" || echo "Failed to send success notification"
+
+ - name: Send Test Failure Notification
+ if: needs.deploy.result == 'success' && needs.e2e-test.result != 'skipped' && needs.e2e-test.outputs.TEST_SUCCESS != 'true'
+ run: |
+ RUN_URL="https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}"
+ TEST_REPORT_URL="${{ needs.e2e-test.outputs.TEST_REPORT_URL }}"
+ WEBAPP_URL="${{ needs.deploy.outputs.WEBAPP_URL || github.event.inputs.existing_webapp_url }}"
+ RESOURCE_GROUP="${{ needs.deploy.outputs.RESOURCE_GROUP_NAME }}"
+
+ EMAIL_BODY=$(cat <Dear Team,We would like to inform you that test automation process has encountered issues and failed to complete successfully.
Deployment Details:
• Resource Group: ${RESOURCE_GROUP}
• Web App URL: ${WEBAPP_URL}
• Deployment Status: ✅ Success
• E2E Tests: ❌ Failed
Test Details:
• Test Report: View Report
Run URL: ${RUN_URL}
Please investigate the matter at your earliest convenience.
Best regards,
Your Automation Team
",
+ "subject": "DocGen Pipeline - Test Automation - Failed"
+ }
+ EOF
+ )
+
+ curl -X POST "${{ secrets.EMAILNOTIFICATION_LOGICAPP_URL_TA }}" \
+ -H "Content-Type: application/json" \
+ -d "$EMAIL_BODY" || echo "Failed to send test failure notification"
+
+ - name: Send Existing URL Success Notification
+ # Scenario: Deployment skipped (existing URL provided) AND e2e tests passed
+ if: needs.deploy.result == 'skipped' && github.event.inputs.existing_webapp_url != '' && needs.e2e-test.result == 'success' && (needs.e2e-test.outputs.TEST_SUCCESS == 'true' || needs.e2e-test.outputs.TEST_SUCCESS == '')
+ run: |
+ RUN_URL="https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}"
+ EXISTING_URL="${{ github.event.inputs.existing_webapp_url }}"
+ TEST_REPORT_URL="${{ needs.e2e-test.outputs.TEST_REPORT_URL }}"
+ EMAIL_BODY=$(cat <Dear Team,The DocGen pipeline executed against the existing WebApp URL and testing process has completed successfully.
Test Results:
• Status: ✅ Passed
${TEST_REPORT_URL:+• Test Report: View Report}
• Target URL: ${EXISTING_URL}
Deployment: Skipped
Run URL: ${RUN_URL}
Best regards,
Your Automation Team
",
+ "subject": "DocGen Pipeline - Test Automation Passed (Existing URL)"
+ }
+ EOF
+ )
+
+ curl -X POST "${{ secrets.EMAILNOTIFICATION_LOGICAPP_URL_TA }}" \
+ -H "Content-Type: application/json" \
+ -d "$EMAIL_BODY" || echo "Failed to send existing URL success notification"
+
+ - name: Send Existing URL Test Failure Notification
+ # Scenario: Deployment skipped (existing URL provided) AND e2e tests failed
+ if: needs.deploy.result == 'skipped' && github.event.inputs.existing_webapp_url != '' && needs.e2e-test.result == 'failure'
+ run: |
+ RUN_URL="https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}"
+ EXISTING_URL="${{ github.event.inputs.existing_webapp_url }}"
+ TEST_REPORT_URL="${{ needs.e2e-test.outputs.TEST_REPORT_URL }}"
+ EMAIL_BODY=$(cat <Dear Team,The DocGen pipeline executed against the existing WebApp URL and the test automation has encountered issues and failed to complete successfully.
Failure Details:
• Target URL: ${EXISTING_URL}
${TEST_REPORT_URL:+• Test Report: View Report}
• Deployment: Skipped
Run URL: ${RUN_URL}
Best regards,
Your Automation Team
",
+ "subject": "DocGen Pipeline - Test Automation Failed (Existing URL)"
+ }
+ EOF
+ )
+
+ curl -X POST "${{ secrets.EMAILNOTIFICATION_LOGICAPP_URL_TA }}" \
+ -H "Content-Type: application/json" \
+ -d "$EMAIL_BODY" || echo "Failed to send existing URL test failure notification"
\ No newline at end of file
diff --git a/archive-doc-gen/.github/workflows/deploy-windows.yml b/archive-doc-gen/.github/workflows/deploy-windows.yml
new file mode 100644
index 000000000..9aec336a2
--- /dev/null
+++ b/archive-doc-gen/.github/workflows/deploy-windows.yml
@@ -0,0 +1,274 @@
+name: Deploy-Test-Cleanup (v2) Windows
+on:
+ # pull_request:
+ # branches:
+ # - main
+ # workflow_run:
+ # workflows: ["Build Docker and Optional Push"]
+ # types:
+ # - completed
+ # branches:
+ # - main
+ # - dev
+ # - demo
+ workflow_dispatch:
+ inputs:
+ azure_location:
+ description: 'Azure Location For Deployment'
+ required: false
+ default: 'australiaeast'
+ type: choice
+ options:
+ - 'australiaeast'
+ - 'centralus'
+ - 'eastasia'
+ - 'eastus2'
+ - 'japaneast'
+ - 'northeurope'
+ - 'southeastasia'
+ - 'uksouth'
+ resource_group_name:
+ description: 'Resource Group Name (Optional)'
+ required: false
+ default: ''
+ type: string
+
+ waf_enabled:
+ description: 'Enable WAF'
+ required: false
+ default: false
+ type: boolean
+ EXP:
+ description: 'Enable EXP'
+ required: false
+ default: false
+ type: boolean
+ build_docker_image:
+ description: 'Build And Push Docker Image (Optional)'
+ required: false
+ default: false
+ type: boolean
+
+ cleanup_resources:
+ description: 'Cleanup Deployed Resources'
+ required: false
+ default: false
+ type: boolean
+
+ run_e2e_tests:
+ description: 'Run End-to-End Tests'
+ required: false
+ default: 'GoldenPath-Testing'
+ type: choice
+ options:
+ - 'GoldenPath-Testing'
+ - 'Smoke-Testing'
+ - 'None'
+
+ AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID:
+ description: 'Log Analytics Workspace ID (Optional)'
+ required: false
+ default: ''
+ type: string
+ AZURE_EXISTING_AI_PROJECT_RESOURCE_ID:
+ description: 'AI Project Resource ID (Optional)'
+ required: false
+ default: ''
+ type: string
+ existing_webapp_url:
+ description: 'Existing WebApp URL (Skips Deployment)'
+ required: false
+ default: ''
+ type: string
+
+ # schedule:
+ # - cron: '0 9,21 * * *' # Runs at 9:00 AM and 9:00 PM GMT
+permissions:
+ contents: read
+ actions: read
+
+jobs:
+ validate-inputs:
+ runs-on: ubuntu-latest
+ outputs:
+ validation_passed: ${{ steps.validate.outputs.passed }}
+ azure_location: ${{ steps.validate.outputs.azure_location }}
+ resource_group_name: ${{ steps.validate.outputs.resource_group_name }}
+ waf_enabled: ${{ steps.validate.outputs.waf_enabled }}
+ exp: ${{ steps.validate.outputs.exp }}
+ build_docker_image: ${{ steps.validate.outputs.build_docker_image }}
+ cleanup_resources: ${{ steps.validate.outputs.cleanup_resources }}
+ run_e2e_tests: ${{ steps.validate.outputs.run_e2e_tests }}
+ azure_env_log_analytics_workspace_id: ${{ steps.validate.outputs.azure_env_log_analytics_workspace_id }}
+ azure_existing_ai_project_resource_id: ${{ steps.validate.outputs.azure_existing_ai_project_resource_id }}
+ existing_webapp_url: ${{ steps.validate.outputs.existing_webapp_url }}
+ steps:
+ - name: Validate Workflow Input Parameters
+ id: validate
+ shell: bash
+ env:
+ INPUT_AZURE_LOCATION: ${{ github.event.inputs.azure_location }}
+ INPUT_RESOURCE_GROUP_NAME: ${{ github.event.inputs.resource_group_name }}
+ INPUT_WAF_ENABLED: ${{ github.event.inputs.waf_enabled }}
+ INPUT_EXP: ${{ github.event.inputs.EXP }}
+ INPUT_BUILD_DOCKER_IMAGE: ${{ github.event.inputs.build_docker_image }}
+ INPUT_CLEANUP_RESOURCES: ${{ github.event.inputs.cleanup_resources }}
+ INPUT_RUN_E2E_TESTS: ${{ github.event.inputs.run_e2e_tests }}
+ INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID: ${{ github.event.inputs.AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID }}
+ INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID: ${{ github.event.inputs.AZURE_EXISTING_AI_PROJECT_RESOURCE_ID }}
+ INPUT_EXISTING_WEBAPP_URL: ${{ github.event.inputs.existing_webapp_url }}
+ run: |
+ echo "🔍 Validating workflow input parameters..."
+ VALIDATION_FAILED=false
+
+ # Validate azure_location (Azure region format)
+ LOCATION="${INPUT_AZURE_LOCATION:-australiaeast}"
+
+ if [[ ! "$LOCATION" =~ ^[a-z0-9]+$ ]]; then
+ echo "❌ ERROR: azure_location '$LOCATION' is invalid. Must contain only lowercase letters and numbers"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ azure_location: '$LOCATION' is valid"
+ fi
+
+ # Validate resource_group_name (Azure naming convention, optional)
+ if [[ -n "$INPUT_RESOURCE_GROUP_NAME" ]]; then
+ if [[ ! "$INPUT_RESOURCE_GROUP_NAME" =~ ^[a-zA-Z0-9._\(\)-]+$ ]] || [[ "$INPUT_RESOURCE_GROUP_NAME" =~ \.$ ]]; then
+ echo "❌ ERROR: resource_group_name '$INPUT_RESOURCE_GROUP_NAME' is invalid. Must contain only alphanumerics, periods, underscores, hyphens, and parentheses. Cannot end with period."
+ VALIDATION_FAILED=true
+ elif [[ ${#INPUT_RESOURCE_GROUP_NAME} -gt 90 ]]; then
+ echo "❌ ERROR: resource_group_name '$INPUT_RESOURCE_GROUP_NAME' exceeds 90 characters (length: ${#INPUT_RESOURCE_GROUP_NAME})"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ resource_group_name: '$INPUT_RESOURCE_GROUP_NAME' is valid"
+ fi
+ else
+ echo "✅ resource_group_name: Not provided (will be auto-generated)"
+ fi
+
+ # Validate waf_enabled (boolean)
+ WAF_ENABLED="${INPUT_WAF_ENABLED:-false}"
+ if [[ "$WAF_ENABLED" != "true" && "$WAF_ENABLED" != "false" ]]; then
+ echo "❌ ERROR: waf_enabled must be 'true' or 'false', got: '$WAF_ENABLED'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ waf_enabled: '$WAF_ENABLED' is valid"
+ fi
+
+ # Validate EXP (boolean)
+ EXP_ENABLED="${INPUT_EXP:-false}"
+ if [[ "$EXP_ENABLED" != "true" && "$EXP_ENABLED" != "false" ]]; then
+ echo "❌ ERROR: EXP must be 'true' or 'false', got: '$EXP_ENABLED'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ EXP: '$EXP_ENABLED' is valid"
+ fi
+
+ # Validate build_docker_image (boolean)
+ BUILD_DOCKER="${INPUT_BUILD_DOCKER_IMAGE:-false}"
+ if [[ "$BUILD_DOCKER" != "true" && "$BUILD_DOCKER" != "false" ]]; then
+ echo "❌ ERROR: build_docker_image must be 'true' or 'false', got: '$BUILD_DOCKER'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ build_docker_image: '$BUILD_DOCKER' is valid"
+ fi
+
+ # Validate cleanup_resources (boolean)
+ CLEANUP_RESOURCES="${INPUT_CLEANUP_RESOURCES:-false}"
+ if [[ "$CLEANUP_RESOURCES" != "true" && "$CLEANUP_RESOURCES" != "false" ]]; then
+ echo "❌ ERROR: cleanup_resources must be 'true' or 'false', got: '$CLEANUP_RESOURCES'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ cleanup_resources: '$CLEANUP_RESOURCES' is valid"
+ fi
+
+ # Validate run_e2e_tests (specific allowed values)
+ TEST_OPTION="${INPUT_RUN_E2E_TESTS:-GoldenPath-Testing}"
+ if [[ "$TEST_OPTION" != "GoldenPath-Testing" && "$TEST_OPTION" != "Smoke-Testing" && "$TEST_OPTION" != "None" ]]; then
+ echo "❌ ERROR: run_e2e_tests must be one of: GoldenPath-Testing, Smoke-Testing, None, got: '$TEST_OPTION'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ run_e2e_tests: '$TEST_OPTION' is valid"
+ fi
+
+ # Validate AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID (optional, Azure Resource ID format)
+ if [[ -n "$INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID" ]]; then
+ if [[ ! "$INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID" =~ ^/subscriptions/[a-fA-F0-9-]+/[Rr]esource[Gg]roups/[^/]+/providers/[Mm]icrosoft\.[Oo]perational[Ii]nsights/[Ww]orkspaces/[^/]+$ ]]; then
+ echo "❌ ERROR: AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID is invalid. Must be a valid Azure Resource ID format:"
+ echo " /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}"
+ echo " Got: '$INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID: Valid Resource ID format"
+ fi
+ else
+ echo "✅ AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID: Not provided (optional)"
+ fi
+
+ # Validate AZURE_EXISTING_AI_PROJECT_RESOURCE_ID (optional, Azure Resource ID format)
+ if [[ -n "$INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID" ]]; then
+ if [[ ! "$INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID" =~ ^/subscriptions/[a-fA-F0-9-]+/[Rr]esource[Gg]roups/[^/]+/providers/([Mm]icrosoft\.[Mm]achine[Ll]earning[Ss]ervices/([Ww]orkspaces|[Pp]rojects)/[^/]+|[Mm]icrosoft\.[Cc]ognitive[Ss]ervices/[Aa]ccounts/[^/]+/[Pp]rojects/[^/]+)$ ]]; then
+ echo "❌ ERROR: AZURE_EXISTING_AI_PROJECT_RESOURCE_ID is invalid. Must be a valid Azure Resource ID format:"
+ echo " /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}"
+ echo " Got: '$INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ AZURE_EXISTING_AI_PROJECT_RESOURCE_ID: Valid Resource ID format"
+ fi
+ else
+ echo "✅ AZURE_EXISTING_AI_PROJECT_RESOURCE_ID: Not provided (optional)"
+ fi
+
+ # Validate existing_webapp_url (optional, must start with https)
+ if [[ -n "$INPUT_EXISTING_WEBAPP_URL" ]]; then
+ if [[ ! "$INPUT_EXISTING_WEBAPP_URL" =~ ^https:// ]]; then
+ echo "❌ ERROR: existing_webapp_url must start with 'https://', got: '$INPUT_EXISTING_WEBAPP_URL'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ existing_webapp_url: '$INPUT_EXISTING_WEBAPP_URL' is valid"
+ fi
+ else
+ echo "✅ existing_webapp_url: Not provided (will perform deployment)"
+ fi
+
+ # Fail workflow if any validation failed
+ if [[ "$VALIDATION_FAILED" == "true" ]]; then
+ echo ""
+ echo "❌ Parameter validation failed. Please correct the errors above and try again."
+ exit 1
+ fi
+
+ echo ""
+ echo "✅ All input parameters validated successfully!"
+
+ # Output validated values
+ echo "passed=true" >> $GITHUB_OUTPUT
+ echo "azure_location=$LOCATION" >> $GITHUB_OUTPUT
+ echo "resource_group_name=$INPUT_RESOURCE_GROUP_NAME" >> $GITHUB_OUTPUT
+ echo "waf_enabled=$WAF_ENABLED" >> $GITHUB_OUTPUT
+ echo "exp=$EXP_ENABLED" >> $GITHUB_OUTPUT
+ echo "build_docker_image=$BUILD_DOCKER" >> $GITHUB_OUTPUT
+ echo "cleanup_resources=$CLEANUP_RESOURCES" >> $GITHUB_OUTPUT
+ echo "run_e2e_tests=$TEST_OPTION" >> $GITHUB_OUTPUT
+ echo "azure_env_log_analytics_workspace_id=$INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID" >> $GITHUB_OUTPUT
+ echo "azure_existing_ai_project_resource_id=$INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID" >> $GITHUB_OUTPUT
+ echo "existing_webapp_url=$INPUT_EXISTING_WEBAPP_URL" >> $GITHUB_OUTPUT
+
+ Run:
+ needs: validate-inputs
+ if: needs.validate-inputs.outputs.validation_passed == 'true'
+ uses: ./.github/workflows/deploy-orchestrator.yml
+ with:
+ runner_os: windows-latest
+ azure_location: ${{ needs.validate-inputs.outputs.azure_location || 'australiaeast' }}
+ resource_group_name: ${{ needs.validate-inputs.outputs.resource_group_name || '' }}
+ waf_enabled: ${{ needs.validate-inputs.outputs.waf_enabled == 'true' }}
+ EXP: ${{ needs.validate-inputs.outputs.exp == 'true' }}
+ build_docker_image: ${{ needs.validate-inputs.outputs.build_docker_image == 'true' }}
+ cleanup_resources: ${{ needs.validate-inputs.outputs.cleanup_resources == 'true' }}
+ run_e2e_tests: ${{ needs.validate-inputs.outputs.run_e2e_tests || 'GoldenPath-Testing' }}
+ AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID: ${{ needs.validate-inputs.outputs.azure_env_log_analytics_workspace_id || '' }}
+ AZURE_EXISTING_AI_PROJECT_RESOURCE_ID: ${{ needs.validate-inputs.outputs.azure_existing_ai_project_resource_id || '' }}
+ existing_webapp_url: ${{ needs.validate-inputs.outputs.existing_webapp_url || '' }}
+ trigger_type: ${{ github.event_name }}
+ secrets: inherit
diff --git a/.github/workflows/deploy.yml b/archive-doc-gen/.github/workflows/deploy.yml
similarity index 94%
rename from .github/workflows/deploy.yml
rename to archive-doc-gen/.github/workflows/deploy.yml
index 56910420f..ab8bf299a 100644
--- a/.github/workflows/deploy.yml
+++ b/archive-doc-gen/.github/workflows/deploy.yml
@@ -20,7 +20,10 @@ env:
GPT_MIN_CAPACITY: 150
TEXT_EMBEDDING_MIN_CAPACITY: 80
BRANCH_NAME: ${{ github.event.workflow_run.head_branch || github.head_ref || github.ref_name }}
-
+permissions:
+ contents: read
+ actions: read
+
jobs:
deploy:
runs-on: ubuntu-latest
@@ -31,26 +34,21 @@ jobs:
- name: Checkout Code
uses: actions/checkout@v6
- - name: Setup Azure CLI
- run: |
- curl -sL https://aka.ms/InstallAzureCLIDeb | sudo bash
- az --version # Verify installation
-
- name: Login to Azure
run: |
az login --service-principal -u ${{ secrets.AZURE_CLIENT_ID }} -p ${{ secrets.AZURE_CLIENT_SECRET }} --tenant ${{ secrets.AZURE_TENANT_ID }}
- name: Run Quota Check
id: quota-check
+ env:
+ AZURE_CLIENT_ID: ${{ secrets.AZURE_CLIENT_ID }}
+ AZURE_TENANT_ID: ${{ secrets.AZURE_TENANT_ID }}
+ AZURE_CLIENT_SECRET: ${{ secrets.AZURE_CLIENT_SECRET }}
+ AZURE_SUBSCRIPTION_ID: ${{ secrets.AZURE_SUBSCRIPTION_ID }}
+ GPT_MIN_CAPACITY: ${{ env.GPT_MIN_CAPACITY }}
+ TEXT_EMBEDDING_MIN_CAPACITY: ${{ env.TEXT_EMBEDDING_MIN_CAPACITY }}
+ AZURE_REGIONS: ${{ vars.AZURE_REGIONS }}
run: |
- export AZURE_CLIENT_ID=${{ secrets.AZURE_CLIENT_ID }}
- export AZURE_TENANT_ID=${{ secrets.AZURE_TENANT_ID }}
- export AZURE_CLIENT_SECRET=${{ secrets.AZURE_CLIENT_SECRET }}
- export AZURE_SUBSCRIPTION_ID="${{ secrets.AZURE_SUBSCRIPTION_ID }}"
- export GPT_MIN_CAPACITY=${{ env.GPT_MIN_CAPACITY }}
- export TEXT_EMBEDDING_MIN_CAPACITY=${{ env.TEXT_EMBEDDING_MIN_CAPACITY }}
- export AZURE_REGIONS="${{ vars.AZURE_REGIONS }}"
-
chmod +x scripts/checkquota.sh
if ! scripts/checkquota.sh; then
# If quota check fails due to insufficient quota, set the flag
@@ -158,7 +156,7 @@ jobs:
azureAiServiceLocation=${{ env.AZURE_AI_LOCATION }} \
imageTag="${IMAGE_TAG}"\
createdBy="Pipeline" \
- tags="{'SecurityControl':'Ignore','Purpose':'Deploying and Cleaning Up Resources for Validation','CreatedDate':'$current_date'}"
+ tags="{'Purpose':'Deploying and Cleaning Up Resources for Validation','CreatedDate':'$current_date'}"
- name: Get Deployment Output and extract Values
id: get_output
@@ -224,11 +222,6 @@ jobs:
env:
RESOURCE_GROUP_NAME: ${{ needs.deploy.outputs.RESOURCE_GROUP_NAME }}
steps:
- - name: Setup Azure CLI
- run: |
- curl -sL https://aka.ms/InstallAzureCLIDeb | sudo bash
- az --version # Verify installation
-
- name: Login to Azure
run: |
az login --service-principal -u ${{ secrets.AZURE_CLIENT_ID }} -p ${{ secrets.AZURE_CLIENT_SECRET }} --tenant ${{ secrets.AZURE_TENANT_ID }}
diff --git a/.github/workflows/docker-build-and-push.yml b/archive-doc-gen/.github/workflows/docker-build-and-push.yml
similarity index 98%
rename from .github/workflows/docker-build-and-push.yml
rename to archive-doc-gen/.github/workflows/docker-build-and-push.yml
index b04d18ea6..07fe2858d 100644
--- a/.github/workflows/docker-build-and-push.yml
+++ b/archive-doc-gen/.github/workflows/docker-build-and-push.yml
@@ -26,7 +26,10 @@ on:
- '!src/tests/**'
merge_group:
workflow_dispatch:
-
+permissions:
+ contents: read
+ actions: read
+
jobs:
build-and-push:
runs-on: ubuntu-latest
diff --git a/archive-doc-gen/.github/workflows/job-cleanup-deployment.yml b/archive-doc-gen/.github/workflows/job-cleanup-deployment.yml
new file mode 100644
index 000000000..0e8aef426
--- /dev/null
+++ b/archive-doc-gen/.github/workflows/job-cleanup-deployment.yml
@@ -0,0 +1,109 @@
+name: Cleanup Deployment Job
+on:
+ workflow_call:
+ inputs:
+ runner_os:
+ description: 'Runner OS (ubuntu-latest or windows-latest)'
+ required: true
+ type: string
+ trigger_type:
+ description: 'Trigger type (workflow_dispatch, pull_request, schedule)'
+ required: true
+ type: string
+ cleanup_resources:
+ description: 'Cleanup Deployed Resources'
+ required: false
+ default: false
+ type: boolean
+ existing_webapp_url:
+ description: 'Existing Container WebApp URL (Skips Deployment)'
+ required: false
+ default: ''
+ type: string
+ RESOURCE_GROUP_NAME:
+ description: 'Resource Group Name to cleanup'
+ required: true
+ type: string
+ AZURE_LOCATION:
+ description: 'Azure Location'
+ required: true
+ type: string
+ AZURE_ENV_OPENAI_LOCATION:
+ description: 'Azure OpenAI Location'
+ required: true
+ type: string
+ ENV_NAME:
+ description: 'Environment Name'
+ required: true
+ type: string
+ IMAGE_TAG:
+ description: 'Docker Image Tag'
+ required: true
+ type: string
+permissions:
+ contents: read
+ actions: read
+
+jobs:
+ cleanup-deployment:
+ runs-on: ${{ inputs.runner_os }}
+ continue-on-error: true
+ env:
+ RESOURCE_GROUP_NAME: ${{ inputs.RESOURCE_GROUP_NAME }}
+ AZURE_LOCATION: ${{ inputs.AZURE_LOCATION }}
+ AZURE_ENV_OPENAI_LOCATION: ${{ inputs.AZURE_ENV_OPENAI_LOCATION }}
+ ENV_NAME: ${{ inputs.ENV_NAME }}
+ IMAGE_TAG: ${{ inputs.IMAGE_TAG }}
+ steps:
+ - name: Login to Azure
+ shell: bash
+ run: |
+ az login --service-principal -u ${{ secrets.AZURE_CLIENT_ID }} -p ${{ secrets.AZURE_CLIENT_SECRET }} --tenant ${{ secrets.AZURE_TENANT_ID }}
+ az account set --subscription ${{ secrets.AZURE_SUBSCRIPTION_ID }}
+
+ - name: Delete Resource Group (Optimized Cleanup)
+ id: delete_rg
+ shell: bash
+ run: |
+ set -e
+ echo "🗑️ Starting optimized resource cleanup..."
+ echo "Deleting resource group: ${{ env.RESOURCE_GROUP_NAME }}"
+
+ az group delete \
+ --name "${{ env.RESOURCE_GROUP_NAME }}" \
+ --yes \
+ --no-wait
+
+ echo "✅ Resource group deletion initiated (running asynchronously)"
+ echo "Note: Resources will be cleaned up in the background"
+
+ - name: Logout from Azure
+ if: always()
+ shell: bash
+ run: |
+ azd auth logout || true
+ az logout || echo "Warning: Failed to logout from Azure CLI"
+ echo "Logged out from Azure."
+
+ - name: Generate Cleanup Job Summary
+ if: always()
+ shell: bash
+ run: |
+ echo "## 🧹 Cleanup Job Summary" >> $GITHUB_STEP_SUMMARY
+ echo "" >> $GITHUB_STEP_SUMMARY
+ echo "| Field | Value |" >> $GITHUB_STEP_SUMMARY
+ echo "|-------|--------|" >> $GITHUB_STEP_SUMMARY
+ echo "| **Resource Group deletion Status** | ${{ steps.delete_rg.outcome == 'success' && '✅ Initiated' || '❌ Failed' }} |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Resource Group** | \`${{ env.RESOURCE_GROUP_NAME }}\` |" >> $GITHUB_STEP_SUMMARY
+ echo "" >> $GITHUB_STEP_SUMMARY
+ if [[ "${{ steps.delete_rg.outcome }}" == "success" ]]; then
+ echo "### ✅ Cleanup Details" >> $GITHUB_STEP_SUMMARY
+ echo "- Successfully initiated deletion for Resource Group \`${{ env.RESOURCE_GROUP_NAME }}\`" >> $GITHUB_STEP_SUMMARY
+ echo "" >> $GITHUB_STEP_SUMMARY
+ else
+ echo "### ❌ Cleanup Failed" >> $GITHUB_STEP_SUMMARY
+ echo "- Cleanup process encountered an error" >> $GITHUB_STEP_SUMMARY
+ echo "- Manual cleanup may be required for:" >> $GITHUB_STEP_SUMMARY
+ echo " - Resource Group: \`${{ env.RESOURCE_GROUP_NAME }}\`" >> $GITHUB_STEP_SUMMARY
+ echo "- Check the cleanup-deployment job logs for detailed error information" >> $GITHUB_STEP_SUMMARY
+ fi
diff --git a/archive-doc-gen/.github/workflows/job-deploy-linux.yml b/archive-doc-gen/.github/workflows/job-deploy-linux.yml
new file mode 100644
index 000000000..37d1b82a2
--- /dev/null
+++ b/archive-doc-gen/.github/workflows/job-deploy-linux.yml
@@ -0,0 +1,403 @@
+name: Deploy Steps - Linux
+
+on:
+ workflow_call:
+ inputs:
+ ENV_NAME:
+ required: true
+ type: string
+ AZURE_ENV_OPENAI_LOCATION:
+ required: true
+ type: string
+ AZURE_LOCATION:
+ required: true
+ type: string
+ RESOURCE_GROUP_NAME:
+ required: true
+ type: string
+ IMAGE_TAG:
+ required: true
+ type: string
+ BUILD_DOCKER_IMAGE:
+ required: true
+ type: string
+ EXP:
+ required: true
+ type: string
+ WAF_ENABLED:
+ required: false
+ type: string
+ default: 'false'
+ AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID:
+ required: false
+ type: string
+ AZURE_EXISTING_AI_PROJECT_RESOURCE_ID:
+ required: false
+ type: string
+ outputs:
+ WEB_APPURL:
+ description: "Container Web App URL"
+ value: ${{ jobs.deploy-linux.outputs.WEB_APPURL }}
+permissions:
+ contents: read
+ actions: read
+
+jobs:
+ deploy-linux:
+ runs-on: ubuntu-latest
+ env:
+ AZURE_DEV_COLLECT_TELEMETRY: ${{ vars.AZURE_DEV_COLLECT_TELEMETRY }}
+ outputs:
+ WEB_APPURL: ${{ steps.get_output_linux.outputs.WEB_APPURL }}
+ steps:
+ - name: Validate Workflow Input Parameters
+ shell: bash
+ env:
+ INPUT_ENV_NAME: ${{ inputs.ENV_NAME }}
+ INPUT_AZURE_ENV_OPENAI_LOCATION: ${{ inputs.AZURE_ENV_OPENAI_LOCATION }}
+ INPUT_AZURE_LOCATION: ${{ inputs.AZURE_LOCATION }}
+ INPUT_RESOURCE_GROUP_NAME: ${{ inputs.RESOURCE_GROUP_NAME }}
+ INPUT_IMAGE_TAG: ${{ inputs.IMAGE_TAG }}
+ INPUT_BUILD_DOCKER_IMAGE: ${{ inputs.BUILD_DOCKER_IMAGE }}
+ INPUT_EXP: ${{ inputs.EXP }}
+ INPUT_WAF_ENABLED: ${{ inputs.WAF_ENABLED }}
+ INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID: ${{ inputs.AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID }}
+ INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID: ${{ inputs.AZURE_EXISTING_AI_PROJECT_RESOURCE_ID }}
+ run: |
+ echo "🔍 Validating workflow input parameters..."
+ VALIDATION_FAILED=false
+
+ # Validate ENV_NAME (required, alphanumeric and hyphens)
+ if [[ -z "$INPUT_ENV_NAME" ]]; then
+ echo "❌ ERROR: ENV_NAME is required but not provided"
+ VALIDATION_FAILED=true
+ elif [[ ! "$INPUT_ENV_NAME" =~ ^[a-zA-Z0-9-]+$ ]]; then
+ echo "❌ ERROR: ENV_NAME '$INPUT_ENV_NAME' is invalid. Must contain only alphanumerics and hyphens"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ ENV_NAME: '$INPUT_ENV_NAME' is valid"
+ fi
+
+ # Validate AZURE_ENV_OPENAI_LOCATION (required, Azure region format)
+ if [[ -z "$INPUT_AZURE_ENV_OPENAI_LOCATION" ]]; then
+ echo "❌ ERROR: AZURE_ENV_OPENAI_LOCATION is required but not provided"
+ VALIDATION_FAILED=true
+ elif [[ ! "$INPUT_AZURE_ENV_OPENAI_LOCATION" =~ ^[a-z0-9]+$ ]]; then
+ echo "❌ ERROR: AZURE_ENV_OPENAI_LOCATION '$INPUT_AZURE_ENV_OPENAI_LOCATION' is invalid. Must contain only lowercase letters and numbers"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ AZURE_ENV_OPENAI_LOCATION: '$INPUT_AZURE_ENV_OPENAI_LOCATION' is valid"
+ fi
+
+ # Validate AZURE_LOCATION (required, Azure region format)
+ if [[ -z "$INPUT_AZURE_LOCATION" ]]; then
+ echo "❌ ERROR: AZURE_LOCATION is required but not provided"
+ VALIDATION_FAILED=true
+ elif [[ ! "$INPUT_AZURE_LOCATION" =~ ^[a-z0-9]+$ ]]; then
+ echo "❌ ERROR: AZURE_LOCATION '$INPUT_AZURE_LOCATION' is invalid. Must contain only lowercase letters and numbers"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ AZURE_LOCATION: '$INPUT_AZURE_LOCATION' is valid"
+ fi
+
+ # Validate RESOURCE_GROUP_NAME (required, Azure naming convention)
+ if [[ -z "$INPUT_RESOURCE_GROUP_NAME" ]]; then
+ echo "❌ ERROR: RESOURCE_GROUP_NAME is required but not provided"
+ VALIDATION_FAILED=true
+ elif [[ ! "$INPUT_RESOURCE_GROUP_NAME" =~ ^[a-zA-Z0-9._\(\)-]+$ ]] || [[ "$INPUT_RESOURCE_GROUP_NAME" =~ \.$ ]]; then
+ echo "❌ ERROR: RESOURCE_GROUP_NAME '$INPUT_RESOURCE_GROUP_NAME' is invalid. Must contain only alphanumerics, periods, underscores, hyphens, and parentheses. Cannot end with period."
+ VALIDATION_FAILED=true
+ elif [[ ${#INPUT_RESOURCE_GROUP_NAME} -gt 90 ]]; then
+ echo "❌ ERROR: RESOURCE_GROUP_NAME '$INPUT_RESOURCE_GROUP_NAME' exceeds 90 characters"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ RESOURCE_GROUP_NAME: '$INPUT_RESOURCE_GROUP_NAME' is valid"
+ fi
+
+ # Validate IMAGE_TAG (required, Docker tag pattern)
+ if [[ -z "$INPUT_IMAGE_TAG" ]]; then
+ echo "❌ ERROR: IMAGE_TAG is required but not provided"
+ VALIDATION_FAILED=true
+ elif [[ ! "$INPUT_IMAGE_TAG" =~ ^[a-zA-Z0-9_][a-zA-Z0-9._-]{0,127}$ ]]; then
+ echo "❌ ERROR: IMAGE_TAG '$INPUT_IMAGE_TAG' is invalid. Must start with alphanumeric or underscore, max 128 characters"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ IMAGE_TAG: '$INPUT_IMAGE_TAG' is valid"
+ fi
+
+ # Validate BUILD_DOCKER_IMAGE (required, must be 'true' or 'false')
+ if [[ "$INPUT_BUILD_DOCKER_IMAGE" != "true" && "$INPUT_BUILD_DOCKER_IMAGE" != "false" ]]; then
+ echo "❌ ERROR: BUILD_DOCKER_IMAGE must be 'true' or 'false', got: '$INPUT_BUILD_DOCKER_IMAGE'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ BUILD_DOCKER_IMAGE: '$INPUT_BUILD_DOCKER_IMAGE' is valid"
+ fi
+
+ # Validate EXP (required, must be 'true' or 'false')
+ if [[ "$INPUT_EXP" != "true" && "$INPUT_EXP" != "false" ]]; then
+ echo "❌ ERROR: EXP must be 'true' or 'false', got: '$INPUT_EXP'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ EXP: '$INPUT_EXP' is valid"
+ fi
+
+ # Validate WAF_ENABLED (must be 'true' or 'false')
+ if [[ "$INPUT_WAF_ENABLED" != "true" && "$INPUT_WAF_ENABLED" != "false" ]]; then
+ echo "❌ ERROR: WAF_ENABLED must be 'true' or 'false', got: '$INPUT_WAF_ENABLED'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ WAF_ENABLED: '$INPUT_WAF_ENABLED' is valid"
+ fi
+
+ # Validate AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID (optional, if provided must be valid Resource ID)
+ if [[ -n "$INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID" ]]; then
+ if [[ ! "$INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID" =~ ^/subscriptions/[a-fA-F0-9-]+/[Rr]esource[Gg]roups/[^/]+/providers/[Mm]icrosoft\.[Oo]perational[Ii]nsights/[Ww]orkspaces/[^/]+$ ]]; then
+ echo "❌ ERROR: AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID is invalid. Must be a valid Azure Resource ID format:"
+ echo " /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}"
+ echo " Got: '$INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID: Valid Resource ID format"
+ fi
+ fi
+
+ # Validate AZURE_EXISTING_AI_PROJECT_RESOURCE_ID (optional, if provided must be valid Resource ID)
+ if [[ -n "$INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID" ]]; then
+ if [[ ! "$INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID" =~ ^/subscriptions/[a-fA-F0-9-]+/[Rr]esource[Gg]roups/[^/]+/providers/([Mm]icrosoft\.[Mm]achine[Ll]earning[Ss]ervices/([Ww]orkspaces|[Pp]rojects)/[^/]+|[Mm]icrosoft\.[Cc]ognitive[Ss]ervices/[Aa]ccounts/[^/]+/[Pp]rojects/[^/]+)$ ]]; then
+ echo "❌ ERROR: AZURE_EXISTING_AI_PROJECT_RESOURCE_ID is invalid. Must be a valid Azure Resource ID format:"
+ echo " /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}"
+ echo " Got: '$INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ AZURE_EXISTING_AI_PROJECT_RESOURCE_ID: Valid Resource ID format"
+ fi
+ fi
+
+ # Fail workflow if any validation failed
+ if [[ "$VALIDATION_FAILED" == "true" ]]; then
+ echo ""
+ echo "❌ Parameter validation failed. Please correct the errors above and try again."
+ exit 1
+ fi
+
+ echo ""
+ echo "✅ All input parameters validated successfully!"
+ - name: Checkout Code
+ uses: actions/checkout@v4
+
+ - name: Configure Parameters Based on WAF Setting
+ shell: bash
+ env:
+ WAF_ENABLED: ${{ inputs.WAF_ENABLED }}
+ run: |
+ if [[ "$WAF_ENABLED" == "true" ]]; then
+ cp infra/main.waf.parameters.json infra/main.parameters.json
+ echo "✅ Successfully copied WAF parameters to main parameters file"
+ else
+ echo "🔧 Configuring Non-WAF deployment - using default main.parameters.json..."
+ fi
+
+ - name: Install azd
+ uses: Azure/setup-azd@v2
+
+ - name: Login to AZD
+ id: login-azure
+ shell: bash
+ run: |
+ az login --service-principal -u ${{ secrets.AZURE_CLIENT_ID }} -p ${{ secrets.AZURE_CLIENT_SECRET }} --tenant ${{ secrets.AZURE_TENANT_ID }}
+ az account set --subscription ${{ secrets.AZURE_SUBSCRIPTION_ID }}
+ azd auth login --client-id ${{ secrets.AZURE_CLIENT_ID }} --client-secret ${{ secrets.AZURE_CLIENT_SECRET }} --tenant-id ${{ secrets.AZURE_TENANT_ID }}
+
+ - name: Deploy using azd up and extract values (Linux)
+ id: get_output_linux
+ shell: bash
+ env:
+ ENV_NAME: ${{ inputs.ENV_NAME }}
+ AZURE_ENV_OPENAI_LOCATION: ${{ inputs.AZURE_ENV_OPENAI_LOCATION }}
+ AZURE_LOCATION: ${{ inputs.AZURE_LOCATION }}
+ RESOURCE_GROUP_NAME: ${{ inputs.RESOURCE_GROUP_NAME }}
+ IMAGE_TAG: ${{ inputs.IMAGE_TAG }}
+ BUILD_DOCKER_IMAGE: ${{ inputs.BUILD_DOCKER_IMAGE }}
+ EXP: ${{ inputs.EXP }}
+ INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID: ${{ inputs.AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID }}
+ INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID: ${{ inputs.AZURE_EXISTING_AI_PROJECT_RESOURCE_ID }}
+ run: |
+ set -e
+
+ echo "Creating environment..."
+ azd env new "$ENV_NAME" --no-prompt
+ echo "Environment created: $ENV_NAME"
+
+ echo "Setting default subscription..."
+ azd config set defaults.subscription "${{ secrets.AZURE_SUBSCRIPTION_ID }}"
+
+ # Set additional parameters
+ azd env set AZURE_SUBSCRIPTION_ID="${{ secrets.AZURE_SUBSCRIPTION_ID }}"
+ azd env set AZURE_ENV_OPENAI_LOCATION="$AZURE_ENV_OPENAI_LOCATION"
+ azd env set AZURE_LOCATION="$AZURE_LOCATION"
+ azd env set AZURE_RESOURCE_GROUP="$RESOURCE_GROUP_NAME"
+ azd env set AZURE_ENV_IMAGETAG="$IMAGE_TAG"
+
+ # Set ACR name only when building Docker image
+ if [[ "$BUILD_DOCKER_IMAGE" == "true" ]]; then
+ # Extract ACR name from login server and set as environment variable
+ ACR_NAME="${{ secrets.ACR_TEST_USERNAME }}"
+ azd env set AZURE_ENV_ACR_NAME="$ACR_NAME"
+ echo "Set ACR name to: $ACR_NAME"
+ else
+ echo "Skipping ACR name configuration (using existing image)"
+ fi
+
+ if [[ "$EXP" == "true" ]]; then
+ echo "✅ EXP ENABLED - Setting EXP parameters..."
+
+ # Set EXP variables dynamically
+ if [[ -n "$INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID" ]]; then
+ EXP_LOG_ANALYTICS_ID="$INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID"
+ else
+ EXP_LOG_ANALYTICS_ID="${{ secrets.AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID }}"
+ fi
+
+ if [[ -n "$INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID" ]]; then
+ EXP_AI_PROJECT_ID="$INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID"
+ else
+ EXP_AI_PROJECT_ID="${{ secrets.AZURE_EXISTING_AI_PROJECT_RESOURCE_ID }}"
+ fi
+
+ echo "AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID: $EXP_LOG_ANALYTICS_ID"
+ echo "AZURE_EXISTING_AI_PROJECT_RESOURCE_ID: $EXP_AI_PROJECT_ID"
+ azd env set AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID="$EXP_LOG_ANALYTICS_ID"
+ azd env set AZURE_EXISTING_AI_PROJECT_RESOURCE_ID="$EXP_AI_PROJECT_ID"
+ else
+ echo "❌ EXP DISABLED - Skipping EXP parameters"
+ if [[ -n "$INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID" ]] || [[ -n "$INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID" ]]; then
+ echo "⚠️ Warning: EXP parameter values provided but EXP is disabled. These values will be ignored."
+ fi
+ fi
+
+ # Deploy using azd up
+ azd up --no-prompt
+
+ # Get deployment outputs using azd
+ echo "Extracting deployment outputs..."
+ DEPLOY_OUTPUT=$(azd env get-values --output json)
+ echo "Deployment output: $DEPLOY_OUTPUT"
+
+ if [[ -z "$DEPLOY_OUTPUT" ]]; then
+ echo "Error: Deployment output is empty. Please check the deployment logs."
+ exit 1
+ fi
+
+ # Extract values from azd output (adjust these based on actual output variable names)
+ AI_FOUNDRY_RESOURCE_ID=$(echo "$DEPLOY_OUTPUT" | jq -r '.AI_FOUNDRY_RESOURCE_ID // empty')
+ echo "AI_FOUNDRY_RESOURCE_ID=$AI_FOUNDRY_RESOURCE_ID" >> $GITHUB_ENV
+
+ AI_SEARCH_SERVICE_NAME=$(echo "$DEPLOY_OUTPUT" | jq -r '.AI_SEARCH_SERVICE_NAME // empty')
+ echo "AI_SEARCH_SERVICE_NAME=$AI_SEARCH_SERVICE_NAME" >> $GITHUB_ENV
+
+ AZURE_COSMOSDB_ACCOUNT=$(echo "$DEPLOY_OUTPUT" | jq -r '.AZURE_COSMOSDB_ACCOUNT // empty')
+ echo "AZURE_COSMOSDB_ACCOUNT=$AZURE_COSMOSDB_ACCOUNT" >> $GITHUB_ENV
+
+ STORAGE_ACCOUNT_NAME=$(echo "$DEPLOY_OUTPUT" | jq -r '.STORAGE_ACCOUNT_NAME // empty')
+ echo "STORAGE_ACCOUNT_NAME=$STORAGE_ACCOUNT_NAME" >> $GITHUB_ENV
+
+ STORAGE_CONTAINER_NAME=$(echo "$DEPLOY_OUTPUT" | jq -r '.STORAGE_CONTAINER_NAME // empty')
+ echo "STORAGE_CONTAINER_NAME=$STORAGE_CONTAINER_NAME" >> $GITHUB_ENV
+
+ KEY_VAULT_NAME=$(echo "$DEPLOY_OUTPUT" | jq -r '.KEY_VAULT_NAME // empty')
+ echo "KEY_VAULT_NAME=$KEY_VAULT_NAME" >> $GITHUB_ENV
+
+ RESOURCE_GROUP_NAME=$(echo "$DEPLOY_OUTPUT" | jq -r '.RESOURCE_GROUP_NAME // empty')
+ echo "RESOURCE_GROUP_NAME=$RESOURCE_GROUP_NAME" >> $GITHUB_ENV
+
+ WEB_APPURL=$(echo "$DEPLOY_OUTPUT" | jq -r '.WEB_APP_URL // .SERVICE_BACKEND_ENDPOINT_URL // empty')
+ echo "WEB_APPURL=$WEB_APPURL" >> $GITHUB_OUTPUT
+ sleep 30
+
+ - name: Run Post-Deployment Script
+ id: post_deploy
+ env:
+ AZURE_SUBSCRIPTION_ID: ${{ secrets.AZURE_SUBSCRIPTION_ID }}
+ AZURE_CLIENT_ID: ${{ secrets.AZURE_CLIENT_ID }}
+ STORAGE_ACCOUNT_NAME: ${{ env.STORAGE_ACCOUNT_NAME }}
+ STORAGE_CONTAINER_NAME: ${{ env.STORAGE_CONTAINER_NAME }}
+ KEY_VAULT_NAME: ${{ env.KEY_VAULT_NAME }}
+ AZURE_COSMOSDB_ACCOUNT: ${{ env.AZURE_COSMOSDB_ACCOUNT }}
+ RESOURCE_GROUP_NAME: ${{ env.RESOURCE_GROUP_NAME }}
+ AI_SEARCH_SERVICE_NAME: ${{ env.AI_SEARCH_SERVICE_NAME }}
+ AI_FOUNDRY_RESOURCE_ID: ${{ env.AI_FOUNDRY_RESOURCE_ID }}
+ run: |
+ set -e
+ az account set --subscription "$AZURE_SUBSCRIPTION_ID"
+
+ echo "Running post-deployment script..."
+
+ bash ./infra/scripts/process_sample_data.sh \
+ "$STORAGE_ACCOUNT_NAME" \
+ "$STORAGE_CONTAINER_NAME" \
+ "$KEY_VAULT_NAME" \
+ "$AZURE_COSMOSDB_ACCOUNT" \
+ "$RESOURCE_GROUP_NAME" \
+ "$AI_SEARCH_SERVICE_NAME" \
+ "$AZURE_CLIENT_ID" \
+ "$AI_FOUNDRY_RESOURCE_ID"
+
+ - name: Generate Deploy Job Summary
+ if: always()
+ env:
+ RESOURCE_GROUP_NAME: ${{ inputs.RESOURCE_GROUP_NAME }}
+ WAF_ENABLED: ${{ inputs.WAF_ENABLED }}
+ EXP: ${{ inputs.EXP }}
+ AZURE_LOCATION: ${{ inputs.AZURE_LOCATION }}
+ AZURE_ENV_OPENAI_LOCATION: ${{ inputs.AZURE_ENV_OPENAI_LOCATION }}
+ IMAGE_TAG: ${{ inputs.IMAGE_TAG }}
+ JOB_STATUS: ${{ job.status }}
+ WEB_APPURL: ${{ steps.get_output_linux.outputs.WEB_APPURL }}
+ run: |
+ echo "## 🚀 Deploy Job Summary (Linux)" >> $GITHUB_STEP_SUMMARY
+ echo "" >> $GITHUB_STEP_SUMMARY
+ echo "| Field | Value |" >> $GITHUB_STEP_SUMMARY
+ echo "|-------|--------|" >> $GITHUB_STEP_SUMMARY
+
+ if [[ "$JOB_STATUS" == "success" ]]; then
+ echo "| **Job Status** | ✅ Success |" >> $GITHUB_STEP_SUMMARY
+ else
+ echo "| **Job Status** | ❌ Failed |" >> $GITHUB_STEP_SUMMARY
+ fi
+
+ echo "| **Resource Group** | \`$RESOURCE_GROUP_NAME\` |" >> $GITHUB_STEP_SUMMARY
+
+ # Determine configuration type
+ if [[ "$WAF_ENABLED" == "true" && "$EXP" == "true" ]]; then
+ CONFIG_TYPE="WAF + EXP"
+ elif [[ "$WAF_ENABLED" == "true" && "$EXP" != "true" ]]; then
+ CONFIG_TYPE="WAF + Non-EXP"
+ elif [[ "$WAF_ENABLED" != "true" && "$EXP" == "true" ]]; then
+ CONFIG_TYPE="Non-WAF + EXP"
+ else
+ CONFIG_TYPE="Non-WAF + Non-EXP"
+ fi
+ echo "| **Configuration Type** | \`$CONFIG_TYPE\` |" >> $GITHUB_STEP_SUMMARY
+
+ echo "| **Azure Region (Infrastructure)** | \`$AZURE_LOCATION\` |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Azure OpenAI Region** | \`$AZURE_ENV_OPENAI_LOCATION\` |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Docker Image Tag** | \`$IMAGE_TAG\` |" >> $GITHUB_STEP_SUMMARY
+ echo "" >> $GITHUB_STEP_SUMMARY
+
+ if [[ "$JOB_STATUS" == "success" ]]; then
+ echo "### ✅ Deployment Details" >> $GITHUB_STEP_SUMMARY
+ echo "- **Web App URL**: [$WEB_APPURL]($WEB_APPURL)" >> $GITHUB_STEP_SUMMARY
+ echo "- Successfully deployed to Azure with all resources configured" >> $GITHUB_STEP_SUMMARY
+ echo "- Post-deployment scripts executed successfully" >> $GITHUB_STEP_SUMMARY
+ else
+ echo "### ❌ Deployment Failed" >> $GITHUB_STEP_SUMMARY
+ echo "- Deployment process encountered an error" >> $GITHUB_STEP_SUMMARY
+ echo "- Check the deploy job for detailed error information" >> $GITHUB_STEP_SUMMARY
+ fi
+
+ - name: Logout from Azure
+ if: always()
+ shell: bash
+ run: |
+ az logout || true
+ echo "Logged out from Azure."
diff --git a/archive-doc-gen/.github/workflows/job-deploy-windows.yml b/archive-doc-gen/.github/workflows/job-deploy-windows.yml
new file mode 100644
index 000000000..e9dda12d4
--- /dev/null
+++ b/archive-doc-gen/.github/workflows/job-deploy-windows.yml
@@ -0,0 +1,394 @@
+name: Deploy Steps - Windows
+
+on:
+ workflow_call:
+ inputs:
+ ENV_NAME:
+ required: true
+ type: string
+ AZURE_ENV_OPENAI_LOCATION:
+ required: true
+ type: string
+ AZURE_LOCATION:
+ required: true
+ type: string
+ RESOURCE_GROUP_NAME:
+ required: true
+ type: string
+ IMAGE_TAG:
+ required: true
+ type: string
+ BUILD_DOCKER_IMAGE:
+ required: true
+ type: string
+ EXP:
+ required: true
+ type: string
+ WAF_ENABLED:
+ required: false
+ type: string
+ default: 'false'
+ AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID:
+ required: false
+ type: string
+ AZURE_EXISTING_AI_PROJECT_RESOURCE_ID:
+ required: false
+ type: string
+ outputs:
+ WEB_APPURL:
+ description: "Container Web App URL"
+ value: ${{ jobs.deploy-windows.outputs.WEB_APPURL }}
+permissions:
+ contents: read
+ actions: read
+
+jobs:
+ deploy-windows:
+ runs-on: windows-latest
+ env:
+ AZURE_DEV_COLLECT_TELEMETRY: ${{ vars.AZURE_DEV_COLLECT_TELEMETRY }}
+ outputs:
+ WEB_APPURL: ${{ steps.get_output_windows.outputs.WEB_APPURL }}
+ steps:
+ - name: Validate Workflow Input Parameters
+ shell: bash
+ env:
+ INPUT_ENV_NAME: ${{ inputs.ENV_NAME }}
+ INPUT_AZURE_ENV_OPENAI_LOCATION: ${{ inputs.AZURE_ENV_OPENAI_LOCATION }}
+ INPUT_AZURE_LOCATION: ${{ inputs.AZURE_LOCATION }}
+ INPUT_RESOURCE_GROUP_NAME: ${{ inputs.RESOURCE_GROUP_NAME }}
+ INPUT_IMAGE_TAG: ${{ inputs.IMAGE_TAG }}
+ INPUT_BUILD_DOCKER_IMAGE: ${{ inputs.BUILD_DOCKER_IMAGE }}
+ INPUT_EXP: ${{ inputs.EXP }}
+ INPUT_WAF_ENABLED: ${{ inputs.WAF_ENABLED }}
+ INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID: ${{ inputs.AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID }}
+ INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID: ${{ inputs.AZURE_EXISTING_AI_PROJECT_RESOURCE_ID }}
+ run: |
+ echo "🔍 Validating workflow input parameters..."
+ VALIDATION_FAILED=false
+
+ # Validate ENV_NAME (required, alphanumeric and hyphens)
+ if [[ -z "$INPUT_ENV_NAME" ]]; then
+ echo "❌ ERROR: ENV_NAME is required but not provided"
+ VALIDATION_FAILED=true
+ elif [[ ! "$INPUT_ENV_NAME" =~ ^[a-zA-Z0-9-]+$ ]]; then
+ echo "❌ ERROR: ENV_NAME '$INPUT_ENV_NAME' is invalid. Must contain only alphanumerics and hyphens"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ ENV_NAME: '$INPUT_ENV_NAME' is valid"
+ fi
+
+ # Validate AZURE_ENV_OPENAI_LOCATION (required, Azure region format)
+ if [[ -z "$INPUT_AZURE_ENV_OPENAI_LOCATION" ]]; then
+ echo "❌ ERROR: AZURE_ENV_OPENAI_LOCATION is required but not provided"
+ VALIDATION_FAILED=true
+ elif [[ ! "$INPUT_AZURE_ENV_OPENAI_LOCATION" =~ ^[a-z0-9]+$ ]]; then
+ echo "❌ ERROR: AZURE_ENV_OPENAI_LOCATION '$INPUT_AZURE_ENV_OPENAI_LOCATION' is invalid. Must contain only lowercase letters and numbers"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ AZURE_ENV_OPENAI_LOCATION: '$INPUT_AZURE_ENV_OPENAI_LOCATION' is valid"
+ fi
+
+ # Validate AZURE_LOCATION (required, Azure region format)
+ if [[ -z "$INPUT_AZURE_LOCATION" ]]; then
+ echo "❌ ERROR: AZURE_LOCATION is required but not provided"
+ VALIDATION_FAILED=true
+ elif [[ ! "$INPUT_AZURE_LOCATION" =~ ^[a-z0-9]+$ ]]; then
+ echo "❌ ERROR: AZURE_LOCATION '$INPUT_AZURE_LOCATION' is invalid. Must contain only lowercase letters and numbers"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ AZURE_LOCATION: '$INPUT_AZURE_LOCATION' is valid"
+ fi
+
+ # Validate RESOURCE_GROUP_NAME (required, Azure naming convention)
+ if [[ -z "$INPUT_RESOURCE_GROUP_NAME" ]]; then
+ echo "❌ ERROR: RESOURCE_GROUP_NAME is required but not provided"
+ VALIDATION_FAILED=true
+ elif [[ ! "$INPUT_RESOURCE_GROUP_NAME" =~ ^[a-zA-Z0-9._\(\)-]+$ ]] || [[ "$INPUT_RESOURCE_GROUP_NAME" =~ \.$ ]]; then
+ echo "❌ ERROR: RESOURCE_GROUP_NAME '$INPUT_RESOURCE_GROUP_NAME' is invalid. Must contain only alphanumerics, periods, underscores, hyphens, and parentheses. Cannot end with period."
+ VALIDATION_FAILED=true
+ elif [[ ${#INPUT_RESOURCE_GROUP_NAME} -gt 90 ]]; then
+ echo "❌ ERROR: RESOURCE_GROUP_NAME '$INPUT_RESOURCE_GROUP_NAME' exceeds 90 characters"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ RESOURCE_GROUP_NAME: '$INPUT_RESOURCE_GROUP_NAME' is valid"
+ fi
+
+ # Validate IMAGE_TAG (required, Docker tag pattern)
+ if [[ -z "$INPUT_IMAGE_TAG" ]]; then
+ echo "❌ ERROR: IMAGE_TAG is required but not provided"
+ VALIDATION_FAILED=true
+ elif [[ ! "$INPUT_IMAGE_TAG" =~ ^[a-zA-Z0-9_][a-zA-Z0-9._-]{0,127}$ ]]; then
+ echo "❌ ERROR: IMAGE_TAG '$INPUT_IMAGE_TAG' is invalid. Must start with alphanumeric or underscore, max 128 characters"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ IMAGE_TAG: '$INPUT_IMAGE_TAG' is valid"
+ fi
+
+ # Validate BUILD_DOCKER_IMAGE (required, must be 'true' or 'false')
+ if [[ "$INPUT_BUILD_DOCKER_IMAGE" != "true" && "$INPUT_BUILD_DOCKER_IMAGE" != "false" ]]; then
+ echo "❌ ERROR: BUILD_DOCKER_IMAGE must be 'true' or 'false', got: '$INPUT_BUILD_DOCKER_IMAGE'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ BUILD_DOCKER_IMAGE: '$INPUT_BUILD_DOCKER_IMAGE' is valid"
+ fi
+
+ # Validate EXP (required, must be 'true' or 'false')
+ if [[ "$INPUT_EXP" != "true" && "$INPUT_EXP" != "false" ]]; then
+ echo "❌ ERROR: EXP must be 'true' or 'false', got: '$INPUT_EXP'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ EXP: '$INPUT_EXP' is valid"
+ fi
+
+ # Validate WAF_ENABLED (must be 'true' or 'false')
+ if [[ "$INPUT_WAF_ENABLED" != "true" && "$INPUT_WAF_ENABLED" != "false" ]]; then
+ echo "❌ ERROR: WAF_ENABLED must be 'true' or 'false', got: '$INPUT_WAF_ENABLED'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ WAF_ENABLED: '$INPUT_WAF_ENABLED' is valid"
+ fi
+
+ # Validate AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID (optional, if provided must be valid Resource ID)
+ if [[ -n "$INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID" ]]; then
+ if [[ ! "$INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID" =~ ^/subscriptions/[a-fA-F0-9-]+/[Rr]esource[Gg]roups/[^/]+/providers/[Mm]icrosoft\.[Oo]perational[Ii]nsights/[Ww]orkspaces/[^/]+$ ]]; then
+ echo "❌ ERROR: AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID is invalid. Must be a valid Azure Resource ID format:"
+ echo " /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}"
+ echo " Got: '$INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID: Valid Resource ID format"
+ fi
+ fi
+
+ # Validate AZURE_EXISTING_AI_PROJECT_RESOURCE_ID (optional, if provided must be valid Resource ID)
+ if [[ -n "$INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID" ]]; then
+ if [[ ! "$INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID" =~ ^/subscriptions/[a-fA-F0-9-]+/[Rr]esource[Gg]roups/[^/]+/providers/([Mm]icrosoft\.[Mm]achine[Ll]earning[Ss]ervices/([Ww]orkspaces|[Pp]rojects)/[^/]+|[Mm]icrosoft\.[Cc]ognitive[Ss]ervices/[Aa]ccounts/[^/]+/[Pp]rojects/[^/]+)$ ]]; then
+ echo "❌ ERROR: AZURE_EXISTING_AI_PROJECT_RESOURCE_ID is invalid. Must be a valid Azure Resource ID format:"
+ echo " /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}"
+ echo " Got: '$INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ AZURE_EXISTING_AI_PROJECT_RESOURCE_ID: Valid Resource ID format"
+ fi
+ fi
+
+ # Fail workflow if any validation failed
+ if [[ "$VALIDATION_FAILED" == "true" ]]; then
+ echo ""
+ echo "❌ Parameter validation failed. Please correct the errors above and try again."
+ exit 1
+ fi
+
+ echo ""
+ echo "✅ All input parameters validated successfully!"
+
+ - name: Checkout Code
+ uses: actions/checkout@v4
+
+ - name: Configure Parameters Based on WAF Setting
+ shell: bash
+ env:
+ WAF_ENABLED: ${{ inputs.WAF_ENABLED }}
+ run: |
+ if [[ "$WAF_ENABLED" == "true" ]]; then
+ cp infra/main.waf.parameters.json infra/main.parameters.json
+ echo "✅ Successfully copied WAF parameters to main parameters file"
+ else
+ echo "🔧 Configuring Non-WAF deployment - using default main.parameters.json..."
+ fi
+
+ - name: Setup Azure Developer CLI (Windows)
+ uses: Azure/setup-azd@v2
+
+ - name: Login to AZD
+ id: login-azure
+ shell: bash
+ run: |
+ az login --service-principal -u ${{ secrets.AZURE_CLIENT_ID }} -p ${{ secrets.AZURE_CLIENT_SECRET }} --tenant ${{ secrets.AZURE_TENANT_ID }}
+ az account set --subscription ${{ secrets.AZURE_SUBSCRIPTION_ID }}
+ azd auth login --client-id ${{ secrets.AZURE_CLIENT_ID }} --client-secret ${{ secrets.AZURE_CLIENT_SECRET }} --tenant-id ${{ secrets.AZURE_TENANT_ID }}
+
+
+ - name: Deploy using azd up and extract values (Windows)
+ id: get_output_windows
+ shell: pwsh
+ env:
+ ENV_NAME: ${{ inputs.ENV_NAME }}
+ AZURE_ENV_OPENAI_LOCATION: ${{ inputs.AZURE_ENV_OPENAI_LOCATION }}
+ AZURE_LOCATION: ${{ inputs.AZURE_LOCATION }}
+ RESOURCE_GROUP_NAME: ${{ inputs.RESOURCE_GROUP_NAME }}
+ IMAGE_TAG: ${{ inputs.IMAGE_TAG }}
+ BUILD_DOCKER_IMAGE: ${{ inputs.BUILD_DOCKER_IMAGE }}
+ EXP: ${{ inputs.EXP }}
+ INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID: ${{ inputs.AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID }}
+ INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID: ${{ inputs.AZURE_EXISTING_AI_PROJECT_RESOURCE_ID }}
+ run: |
+ $ErrorActionPreference = "Stop"
+
+ Write-Host "Creating environment..."
+ azd env new $env:ENV_NAME --no-prompt
+ Write-Host "Environment created: $env:ENV_NAME"
+
+ Write-Host "Setting default subscription..."
+ azd config set defaults.subscription ${{ secrets.AZURE_SUBSCRIPTION_ID }}
+
+ # Set additional parameters
+ azd env set AZURE_SUBSCRIPTION_ID="${{ secrets.AZURE_SUBSCRIPTION_ID }}"
+ azd env set AZURE_ENV_OPENAI_LOCATION="$env:AZURE_ENV_OPENAI_LOCATION"
+ azd env set AZURE_LOCATION="$env:AZURE_LOCATION"
+ azd env set AZURE_RESOURCE_GROUP="$env:RESOURCE_GROUP_NAME"
+ azd env set AZURE_ENV_IMAGETAG="$env:IMAGE_TAG"
+
+ # Set ACR name only when building Docker image
+ if ($env:BUILD_DOCKER_IMAGE -eq "true") {
+ $ACR_NAME = "${{ secrets.ACR_TEST_USERNAME }}"
+ azd env set AZURE_ENV_ACR_NAME="$ACR_NAME"
+ Write-Host "Set ACR name to: $ACR_NAME"
+ } else {
+ Write-Host "Skipping ACR name configuration (using existing image)"
+ }
+
+ if ($env:EXP -eq "true") {
+ Write-Host "✅ EXP ENABLED - Setting EXP parameters..."
+
+ # Set EXP variables dynamically
+ if ($env:INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID -ne "") {
+ $EXP_LOG_ANALYTICS_ID = $env:INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID
+ } else {
+ $EXP_LOG_ANALYTICS_ID = "${{ secrets.AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID }}"
+ }
+
+ if ($env:INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID -ne "") {
+ $EXP_AI_PROJECT_ID = $env:INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID
+ } else {
+ $EXP_AI_PROJECT_ID = "${{ secrets.AZURE_EXISTING_AI_PROJECT_RESOURCE_ID }}"
+ }
+
+ Write-Host "AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID: $EXP_LOG_ANALYTICS_ID"
+ Write-Host "AZURE_EXISTING_AI_PROJECT_RESOURCE_ID: $EXP_AI_PROJECT_ID"
+ azd env set AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID="$EXP_LOG_ANALYTICS_ID"
+ azd env set AZURE_EXISTING_AI_PROJECT_RESOURCE_ID="$EXP_AI_PROJECT_ID"
+ } else {
+ Write-Host "❌ EXP DISABLED - Skipping EXP parameters"
+ }
+
+ # Deploy using azd up
+ azd up --no-prompt
+
+ Write-Host "✅ Deployment succeeded."
+
+ # Get deployment outputs using azd
+ Write-Host "Extracting deployment outputs..."
+ $DEPLOY_OUTPUT = azd env get-values --output json | ConvertFrom-Json
+ Write-Host "Deployment output: $($DEPLOY_OUTPUT | ConvertTo-Json -Depth 10)"
+
+ if (-not $DEPLOY_OUTPUT) {
+ Write-Host "Error: Deployment output is empty. Please check the deployment logs."
+ exit 1
+ }
+
+
+ $AI_FOUNDRY_RESOURCE_ID = $DEPLOY_OUTPUT.AI_FOUNDRY_RESOURCE_ID
+ "AI_FOUNDRY_RESOURCE_ID=$AI_FOUNDRY_RESOURCE_ID" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
+
+ $AI_SEARCH_SERVICE_NAME = $DEPLOY_OUTPUT.AI_SEARCH_SERVICE_NAME
+ "AI_SEARCH_SERVICE_NAME=$AI_SEARCH_SERVICE_NAME" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
+
+ $AZURE_COSMOSDB_ACCOUNT = $DEPLOY_OUTPUT.AZURE_COSMOSDB_ACCOUNT
+ "AZURE_COSMOSDB_ACCOUNT=$AZURE_COSMOSDB_ACCOUNT" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
+
+ $STORAGE_ACCOUNT_NAME = $DEPLOY_OUTPUT.STORAGE_ACCOUNT_NAME
+ "STORAGE_ACCOUNT_NAME=$STORAGE_ACCOUNT_NAME" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
+
+ $STORAGE_CONTAINER_NAME = $DEPLOY_OUTPUT.STORAGE_CONTAINER_NAME
+ "STORAGE_CONTAINER_NAME=$STORAGE_CONTAINER_NAME" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
+
+ $KEY_VAULT_NAME = $DEPLOY_OUTPUT.KEY_VAULT_NAME
+ "KEY_VAULT_NAME=$KEY_VAULT_NAME" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
+
+ $RESOURCE_GROUP_NAME = $DEPLOY_OUTPUT.RESOURCE_GROUP_NAME
+ "RESOURCE_GROUP_NAME=$RESOURCE_GROUP_NAME" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
+
+ $WEB_APP_URL = $DEPLOY_OUTPUT.WEB_APP_URL
+ "WEB_APPURL=$WEB_APP_URL" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
+ "WEB_APPURL=$WEB_APP_URL" | Out-File -FilePath $env:GITHUB_OUTPUT -Encoding utf8 -Append
+
+ - name: Run Post-Deployment Script
+ id: post_deploy
+ env:
+ AZURE_SUBSCRIPTION_ID: ${{ secrets.AZURE_SUBSCRIPTION_ID }}
+ shell: bash
+ run: |
+ set -e
+ az account set --subscription "${{ secrets.AZURE_SUBSCRIPTION_ID }}"
+
+ echo "Running post-deployment script..."
+
+ bash ./infra/scripts/process_sample_data.sh \
+ "${{ env.STORAGE_ACCOUNT_NAME }}" \
+ "${{ env.STORAGE_CONTAINER_NAME }}" \
+ "${{ env.KEY_VAULT_NAME }}" \
+ "${{ env.AZURE_COSMOSDB_ACCOUNT }}" \
+ "${{ env.RESOURCE_GROUP_NAME }}" \
+ "${{ env.AI_SEARCH_SERVICE_NAME }}" \
+ "${{ secrets.AZURE_CLIENT_ID }}" \
+ "${{ env.AI_FOUNDRY_RESOURCE_ID }}"
+
+ - name: Generate Deploy Job Summary
+ if: always()
+ shell: bash
+ env:
+ RESOURCE_GROUP_NAME: ${{ inputs.RESOURCE_GROUP_NAME }}
+ WAF_ENABLED: ${{ inputs.WAF_ENABLED }}
+ EXP: ${{ inputs.EXP }}
+ AZURE_LOCATION: ${{ inputs.AZURE_LOCATION }}
+ AZURE_ENV_OPENAI_LOCATION: ${{ inputs.AZURE_ENV_OPENAI_LOCATION }}
+ IMAGE_TAG: ${{ inputs.IMAGE_TAG }}
+ JOB_STATUS: ${{ job.status }}
+ WEB_APPURL: ${{ steps.get_output_windows.outputs.WEB_APPURL }}
+ run: |
+ echo "## 🚀 Deploy Job Summary (Windows)" >> $GITHUB_STEP_SUMMARY
+ echo "" >> $GITHUB_STEP_SUMMARY
+ echo "| Field | Value |" >> $GITHUB_STEP_SUMMARY
+ echo "|-------|--------|" >> $GITHUB_STEP_SUMMARY
+ if [[ "$JOB_STATUS" == "success" ]]; then
+ echo "| **Job Status** | ✅ Success |" >> $GITHUB_STEP_SUMMARY
+ else
+ echo "| **Job Status** | ❌ Failed |" >> $GITHUB_STEP_SUMMARY
+ fi
+ echo "| **Resource Group** | \`$RESOURCE_GROUP_NAME\` |" >> $GITHUB_STEP_SUMMARY
+
+ # Determine configuration type
+ if [[ "$WAF_ENABLED" == "true" && "$EXP" == "true" ]]; then
+ CONFIG_TYPE="WAF + EXP"
+ elif [[ "$WAF_ENABLED" == "true" && "$EXP" != "true" ]]; then
+ CONFIG_TYPE="WAF + Non-EXP"
+ elif [[ "$WAF_ENABLED" != "true" && "$EXP" == "true" ]]; then
+ CONFIG_TYPE="Non-WAF + EXP"
+ else
+ CONFIG_TYPE="Non-WAF + Non-EXP"
+ fi
+ echo "| **Configuration Type** | \`$CONFIG_TYPE\` |" >> $GITHUB_STEP_SUMMARY
+
+ echo "| **Azure Region (Infrastructure)** | \`$AZURE_LOCATION\` |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Azure OpenAI Region** | \`$AZURE_ENV_OPENAI_LOCATION\` |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Docker Image Tag** | \`$IMAGE_TAG\` |" >> $GITHUB_STEP_SUMMARY
+ echo "" >> $GITHUB_STEP_SUMMARY
+ if [[ "$JOB_STATUS" == "success" ]]; then
+ echo "### ✅ Deployment Details" >> $GITHUB_STEP_SUMMARY
+ echo "- **Web App URL**: [$WEB_APPURL]($WEB_APPURL)" >> $GITHUB_STEP_SUMMARY
+ echo "- Successfully deployed to Azure with all resources configured" >> $GITHUB_STEP_SUMMARY
+ echo "- Post-deployment scripts executed successfully" >> $GITHUB_STEP_SUMMARY
+ else
+ echo "### ❌ Deployment Failed" >> $GITHUB_STEP_SUMMARY
+ echo "- Deployment process encountered an error" >> $GITHUB_STEP_SUMMARY
+ echo "- Check the deploy job for detailed error information" >> $GITHUB_STEP_SUMMARY
+ fi
+
+ - name: Logout from Azure
+ if: always()
+ shell: bash
+ run: |
+ az logout || true
+ echo "Logged out from Azure."
diff --git a/archive-doc-gen/.github/workflows/job-deploy.yml b/archive-doc-gen/.github/workflows/job-deploy.yml
new file mode 100644
index 000000000..a54023768
--- /dev/null
+++ b/archive-doc-gen/.github/workflows/job-deploy.yml
@@ -0,0 +1,554 @@
+name: Deploy Job
+
+on:
+ workflow_call:
+ inputs:
+ trigger_type:
+ description: 'Trigger type (workflow_dispatch, pull_request, schedule)'
+ required: true
+ type: string
+ runner_os:
+ description: 'Runner OS (ubuntu-latest or windows-latest)'
+ required: true
+ type: string
+ azure_location:
+ description: 'Azure Location For Deployment'
+ required: false
+ default: 'australiaeast'
+ type: string
+ resource_group_name:
+ description: 'Resource Group Name (Optional)'
+ required: false
+ default: ''
+ type: string
+ waf_enabled:
+ description: 'Enable WAF'
+ required: false
+ default: false
+ type: boolean
+ EXP:
+ description: 'Enable EXP'
+ required: false
+ default: false
+ type: boolean
+ build_docker_image:
+ description: 'Build And Push Docker Image (Optional)'
+ required: false
+ default: false
+ type: boolean
+ cleanup_resources:
+ description: 'Cleanup Deployed Resources'
+ required: false
+ default: false
+ type: boolean
+ run_e2e_tests:
+ description: 'Run End-to-End Tests'
+ required: false
+ default: 'GoldenPath-Testing'
+ type: string
+ existing_webapp_url:
+ description: 'Existing Container WebApp URL (Skips Deployment)'
+ required: false
+ default: ''
+ type: string
+ AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID:
+ description: 'Log Analytics Workspace ID (Optional)'
+ required: false
+ default: ''
+ type: string
+ AZURE_EXISTING_AI_PROJECT_RESOURCE_ID:
+ description: 'AI Project Resource ID (Optional)'
+ required: false
+ default: ''
+ type: string
+ docker_image_tag:
+ description: 'Docker Image Tag from build job'
+ required: false
+ default: ''
+ type: string
+ outputs:
+ RESOURCE_GROUP_NAME:
+ description: "Resource Group Name"
+ value: ${{ jobs.azure-setup.outputs.RESOURCE_GROUP_NAME }}
+ WEB_APPURL:
+ description: "Container Web App URL"
+ value: ${{ jobs.deploy-linux.outputs.WEB_APPURL || jobs.deploy-windows.outputs.WEB_APPURL }}
+ ENV_NAME:
+ description: "Environment Name"
+ value: ${{ jobs.azure-setup.outputs.ENV_NAME }}
+ AZURE_LOCATION:
+ description: "Azure Location"
+ value: ${{ jobs.azure-setup.outputs.AZURE_LOCATION }}
+ AZURE_ENV_OPENAI_LOCATION:
+ description: "Azure OpenAI Location"
+ value: ${{ jobs.azure-setup.outputs.AZURE_ENV_OPENAI_LOCATION }}
+ IMAGE_TAG:
+ description: "Docker Image Tag Used"
+ value: ${{ jobs.azure-setup.outputs.IMAGE_TAG }}
+ QUOTA_FAILED:
+ description: "Quota Check Failed Flag"
+ value: ${{ jobs.azure-setup.outputs.QUOTA_FAILED || 'false' }}
+
+env:
+ GPT_MIN_CAPACITY: 150
+ TEXT_EMBEDDING_MIN_CAPACITY: 80
+ BRANCH_NAME: ${{ github.event.workflow_run.head_branch || github.head_ref || github.ref_name }}
+ WAF_ENABLED: ${{ inputs.trigger_type == 'workflow_dispatch' && (inputs.waf_enabled || false) || false }}
+ EXP: ${{ inputs.trigger_type == 'workflow_dispatch' && (inputs.EXP || false) || false }}
+ CLEANUP_RESOURCES: ${{ inputs.trigger_type != 'workflow_dispatch' || inputs.cleanup_resources }}
+ RUN_E2E_TESTS: ${{ inputs.trigger_type == 'workflow_dispatch' && (inputs.run_e2e_tests || 'GoldenPath-Testing') || 'GoldenPath-Testing' }}
+ BUILD_DOCKER_IMAGE: ${{ inputs.trigger_type == 'workflow_dispatch' && (inputs.build_docker_image || false) || false }}
+permissions:
+ contents: read
+ actions: read
+
+jobs:
+ azure-setup:
+ name: Azure Setup
+ if: inputs.trigger_type != 'workflow_dispatch' || inputs.existing_webapp_url == '' || inputs.existing_webapp_url == null
+ runs-on: ubuntu-latest
+ outputs:
+ RESOURCE_GROUP_NAME: ${{ steps.check_create_rg.outputs.RESOURCE_GROUP_NAME }}
+ ENV_NAME: ${{ steps.generate_env_name.outputs.ENV_NAME }}
+ AZURE_LOCATION: ${{ steps.set_region.outputs.AZURE_LOCATION }}
+ AZURE_ENV_OPENAI_LOCATION: ${{ steps.set_region.outputs.AZURE_ENV_OPENAI_LOCATION }}
+ IMAGE_TAG: ${{ steps.determine_image_tag.outputs.IMAGE_TAG }}
+ QUOTA_FAILED: ${{ steps.quota_failure_output.outputs.QUOTA_FAILED }}
+ EXP_ENABLED: ${{ steps.configure_exp.outputs.EXP_ENABLED }}
+
+ steps:
+ - name: Validate Workflow Input Parameters
+ shell: bash
+ env:
+ INPUT_TRIGGER_TYPE: ${{ inputs.trigger_type }}
+ INPUT_RUNNER_OS: ${{ inputs.runner_os }}
+ INPUT_BUILD_DOCKER_IMAGE: ${{ inputs.build_docker_image }}
+ INPUT_AZURE_LOCATION: ${{ inputs.azure_location }}
+ INPUT_RESOURCE_GROUP_NAME: ${{ inputs.resource_group_name }}
+ INPUT_WAF_ENABLED: ${{ inputs.waf_enabled }}
+ INPUT_EXP: ${{ inputs.EXP }}
+ INPUT_CLEANUP_RESOURCES: ${{ inputs.cleanup_resources }}
+ INPUT_RUN_E2E_TESTS: ${{ inputs.run_e2e_tests }}
+ INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID: ${{ inputs.AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID }}
+ INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID: ${{ inputs.AZURE_EXISTING_AI_PROJECT_RESOURCE_ID }}
+ INPUT_EXISTING_WEBAPP_URL: ${{ inputs.existing_webapp_url }}
+ INPUT_DOCKER_IMAGE_TAG: ${{ inputs.docker_image_tag }}
+ run: |
+ echo "🔍 Validating workflow input parameters..."
+ VALIDATION_FAILED=false
+
+ # Validate trigger_type (required - alphanumeric with underscores)
+ if [[ -z "$INPUT_TRIGGER_TYPE" ]]; then
+ echo "❌ ERROR: trigger_type is required but was not provided"
+ VALIDATION_FAILED=true
+ elif [[ ! "$INPUT_TRIGGER_TYPE" =~ ^[a-zA-Z0-9_]+$ ]]; then
+ echo "❌ ERROR: trigger_type '$INPUT_TRIGGER_TYPE' is invalid. Must contain only alphanumeric characters and underscores"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ trigger_type: '$INPUT_TRIGGER_TYPE' is valid"
+ fi
+
+ # Validate runner_os (required - must be specific values)
+ ALLOWED_RUNNER_OS=("ubuntu-latest" "windows-latest")
+ if [[ -z "$INPUT_RUNNER_OS" ]]; then
+ echo "❌ ERROR: runner_os is required but was not provided"
+ VALIDATION_FAILED=true
+ elif [[ ! " ${ALLOWED_RUNNER_OS[@]} " =~ " ${INPUT_RUNNER_OS} " ]]; then
+ echo "❌ ERROR: runner_os '$INPUT_RUNNER_OS' is invalid. Allowed values: ${ALLOWED_RUNNER_OS[*]}"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ runner_os: '$INPUT_RUNNER_OS' is valid"
+ fi
+
+ # Validate build_docker_image (boolean)
+ if [[ "$INPUT_BUILD_DOCKER_IMAGE" != "true" && "$INPUT_BUILD_DOCKER_IMAGE" != "false" ]]; then
+ echo "❌ ERROR: build_docker_image must be 'true' or 'false', got: '$INPUT_BUILD_DOCKER_IMAGE'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ build_docker_image: '$INPUT_BUILD_DOCKER_IMAGE' is valid"
+ fi
+
+ # Validate azure_location (Azure region format)
+ if [[ -n "$INPUT_AZURE_LOCATION" ]]; then
+ if [[ ! "$INPUT_AZURE_LOCATION" =~ ^[a-z0-9]+$ ]]; then
+ echo "❌ ERROR: azure_location '$INPUT_AZURE_LOCATION' is invalid. Must contain only lowercase letters and numbers (e.g., 'australiaeast', 'westus2')"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ azure_location: '$INPUT_AZURE_LOCATION' is valid"
+ fi
+ fi
+
+ # Validate resource_group_name (Azure resource group naming convention)
+ if [[ -n "$INPUT_RESOURCE_GROUP_NAME" ]]; then
+ if [[ ! "$INPUT_RESOURCE_GROUP_NAME" =~ ^[a-zA-Z0-9._\(\)-]+$ ]] || [[ "$INPUT_RESOURCE_GROUP_NAME" =~ \.$ ]]; then
+ echo "❌ ERROR: resource_group_name '$INPUT_RESOURCE_GROUP_NAME' is invalid. Must contain only alphanumerics, periods, underscores, hyphens, and parentheses. Cannot end with period."
+ VALIDATION_FAILED=true
+ elif [[ ${#INPUT_RESOURCE_GROUP_NAME} -gt 90 ]]; then
+ echo "❌ ERROR: resource_group_name '$INPUT_RESOURCE_GROUP_NAME' exceeds 90 characters"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ resource_group_name: '$INPUT_RESOURCE_GROUP_NAME' is valid"
+ fi
+ fi
+
+ # Validate waf_enabled (boolean)
+ if [[ "$INPUT_WAF_ENABLED" != "true" && "$INPUT_WAF_ENABLED" != "false" ]]; then
+ echo "❌ ERROR: waf_enabled must be 'true' or 'false', got: '$INPUT_WAF_ENABLED'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ waf_enabled: '$INPUT_WAF_ENABLED' is valid"
+ fi
+
+ # Validate EXP (boolean)
+ if [[ "$INPUT_EXP" != "true" && "$INPUT_EXP" != "false" ]]; then
+ echo "❌ ERROR: EXP must be 'true' or 'false', got: '$INPUT_EXP'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ EXP: '$INPUT_EXP' is valid"
+ fi
+
+ # Validate cleanup_resources (boolean)
+ if [[ "$INPUT_CLEANUP_RESOURCES" != "true" && "$INPUT_CLEANUP_RESOURCES" != "false" ]]; then
+ echo "❌ ERROR: cleanup_resources must be 'true' or 'false', got: '$INPUT_CLEANUP_RESOURCES'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ cleanup_resources: '$INPUT_CLEANUP_RESOURCES' is valid"
+ fi
+
+ # Validate run_e2e_tests (specific allowed values)
+ if [[ -n "$INPUT_RUN_E2E_TESTS" ]]; then
+ ALLOWED_VALUES=("None" "GoldenPath-Testing" "Smoke-Testing")
+ if [[ ! " ${ALLOWED_VALUES[@]} " =~ " ${INPUT_RUN_E2E_TESTS} " ]]; then
+ echo "❌ ERROR: run_e2e_tests '$INPUT_RUN_E2E_TESTS' is invalid. Allowed values: ${ALLOWED_VALUES[*]}"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ run_e2e_tests: '$INPUT_RUN_E2E_TESTS' is valid"
+ fi
+ fi
+
+ # Validate AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID (Azure Resource ID format)
+ if [[ -n "$INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID" ]]; then
+ if [[ ! "$INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID" =~ ^/subscriptions/[a-fA-F0-9-]+/[Rr]esource[Gg]roups/[^/]+/providers/[Mm]icrosoft\.[Oo]perational[Ii]nsights/[Ww]orkspaces/[^/]+$ ]]; then
+ echo "❌ ERROR: AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID is invalid. Must be a valid Azure Resource ID format:"
+ echo " /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}"
+ echo " Got: '$INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID: Valid Resource ID format"
+ fi
+ fi
+
+ # Validate AZURE_EXISTING_AI_PROJECT_RESOURCE_ID (Azure Resource ID format)
+ if [[ -n "$INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID" ]]; then
+ if [[ ! "$INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID" =~ ^/subscriptions/[a-fA-F0-9-]+/[Rr]esource[Gg]roups/[^/]+/providers/([Mm]icrosoft\.[Mm]achine[Ll]earning[Ss]ervices/([Ww]orkspaces|[Pp]rojects)/[^/]+|[Mm]icrosoft\.[Cc]ognitive[Ss]ervices/[Aa]ccounts/[^/]+/[Pp]rojects/[^/]+)$ ]]; then
+ echo "❌ ERROR: AZURE_EXISTING_AI_PROJECT_RESOURCE_ID is invalid. Must be a valid Azure Resource ID format:"
+ echo " /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}"
+ echo " Got: '$INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ AZURE_EXISTING_AI_PROJECT_RESOURCE_ID: Valid Resource ID format"
+ fi
+ fi
+
+ # Validate existing_webapp_url (must start with https)
+ if [[ -n "$INPUT_EXISTING_WEBAPP_URL" ]]; then
+ if [[ ! "$INPUT_EXISTING_WEBAPP_URL" =~ ^https:// ]]; then
+ echo "❌ ERROR: existing_webapp_url must start with 'https://', got: '$INPUT_EXISTING_WEBAPP_URL'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ existing_webapp_url: '$INPUT_EXISTING_WEBAPP_URL' is valid"
+ fi
+ fi
+
+ # Validate docker_image_tag (Docker tag pattern)
+ if [[ -n "$INPUT_DOCKER_IMAGE_TAG" ]]; then
+ # Docker tags: lowercase and uppercase letters, digits, underscores, periods, and hyphens
+ # Cannot start with period or hyphen, max 128 characters
+ if [[ ! "$INPUT_DOCKER_IMAGE_TAG" =~ ^[a-zA-Z0-9_][a-zA-Z0-9._-]{0,127}$ ]]; then
+ echo "❌ ERROR: docker_image_tag '$INPUT_DOCKER_IMAGE_TAG' is invalid. Must:"
+ echo " - Start with alphanumeric or underscore"
+ echo " - Contain only alphanumerics, underscores, periods, hyphens"
+ echo " - Be max 128 characters"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ docker_image_tag: '$INPUT_DOCKER_IMAGE_TAG' is valid"
+ fi
+ fi
+
+ # Fail workflow if any validation failed
+ if [[ "$VALIDATION_FAILED" == "true" ]]; then
+ echo ""
+ echo "❌ Parameter validation failed. Please correct the errors above and try again."
+ exit 1
+ fi
+
+ echo ""
+ echo "✅ All input parameters validated successfully!"
+
+ - name: Validate and Auto-Configure EXP
+ id: configure_exp
+ shell: bash
+ env:
+ INPUT_EXP: ${{ inputs.EXP }}
+ INPUT_LOG_ANALYTICS_WORKSPACE_ID: ${{ inputs.AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID }}
+ INPUT_AI_PROJECT_RESOURCE_ID: ${{ inputs.AZURE_EXISTING_AI_PROJECT_RESOURCE_ID }}
+ run: |
+ echo "🔍 Validating EXP configuration..."
+
+ EXP_ENABLED="false"
+
+ if [[ "$INPUT_EXP" == "true" ]]; then
+ EXP_ENABLED="true"
+ echo "✅ EXP explicitly enabled by user input"
+ elif [[ -n "$INPUT_LOG_ANALYTICS_WORKSPACE_ID" ]] || [[ -n "$INPUT_AI_PROJECT_RESOURCE_ID" ]]; then
+ echo "🔧 AUTO-ENABLING EXP: EXP parameter values were provided but EXP was not explicitly enabled."
+ echo ""
+ echo "You provided values for:"
+ [[ -n "$INPUT_LOG_ANALYTICS_WORKSPACE_ID" ]] && echo " - Azure Log Analytics Workspace ID: '$INPUT_LOG_ANALYTICS_WORKSPACE_ID'"
+ [[ -n "$INPUT_AI_PROJECT_RESOURCE_ID" ]] && echo " - Azure AI Project Resource ID: '$INPUT_AI_PROJECT_RESOURCE_ID'"
+ echo ""
+ echo "✅ Automatically enabling EXP to use these values."
+ EXP_ENABLED="true"
+ fi
+
+ echo "EXP_ENABLED=$EXP_ENABLED" >> $GITHUB_ENV
+ echo "EXP_ENABLED=$EXP_ENABLED" >> $GITHUB_OUTPUT
+ echo "Final EXP status: $EXP_ENABLED"
+
+
+ - name: Checkout Code
+ uses: actions/checkout@v4
+
+ - name: Login to Azure
+ shell: bash
+ run: |
+ az login --service-principal -u ${{ secrets.AZURE_CLIENT_ID }} -p ${{ secrets.AZURE_CLIENT_SECRET }} --tenant ${{ secrets.AZURE_TENANT_ID }}
+ az account set --subscription ${{ secrets.AZURE_SUBSCRIPTION_ID }}
+
+ - name: Run Quota Check
+ id: quota-check
+ env:
+ AZURE_CLIENT_ID: ${{ secrets.AZURE_CLIENT_ID }}
+ AZURE_TENANT_ID: ${{ secrets.AZURE_TENANT_ID }}
+ AZURE_CLIENT_SECRET: ${{ secrets.AZURE_CLIENT_SECRET }}
+ AZURE_SUBSCRIPTION_ID: ${{ secrets.AZURE_SUBSCRIPTION_ID }}
+ GPT_MIN_CAPACITY: ${{ env.GPT_MIN_CAPACITY }}
+ TEXT_EMBEDDING_MIN_CAPACITY: ${{ env.TEXT_EMBEDDING_MIN_CAPACITY }}
+ AZURE_REGIONS: ${{ vars.AZURE_REGIONS }}
+ run: |
+ chmod +x scripts/checkquota.sh
+ if ! scripts/checkquota.sh; then
+ # If quota check fails due to insufficient quota, set the flag
+ if grep -q "No region with sufficient quota found" scripts/checkquota.sh; then
+ echo "QUOTA_FAILED=true" >> $GITHUB_ENV
+ fi
+ exit 1 # Fail the pipeline if any other failure occurs
+ fi
+
+ - name: Set Quota Failure Output
+ id: quota_failure_output
+ if: env.QUOTA_FAILED == 'true'
+ shell: bash
+ run: |
+ echo "QUOTA_FAILED=true" >> $GITHUB_OUTPUT
+ echo "Quota check failed - will notify via separate notification job"
+
+ - name: Fail Pipeline if Quota Check Fails
+ if: env.QUOTA_FAILED == 'true'
+ shell: bash
+ run: exit 1
+
+ - name: Set Deployment Region
+ id: set_region
+ shell: bash
+ env:
+ INPUT_AZURE_LOCATION: ${{ inputs.azure_location }}
+ run: |
+ echo "Selected Region from Quota Check: $VALID_REGION"
+ echo "AZURE_ENV_OPENAI_LOCATION=$VALID_REGION" >> $GITHUB_ENV
+ echo "AZURE_ENV_OPENAI_LOCATION=$VALID_REGION" >> $GITHUB_OUTPUT
+
+ if [[ "${{ inputs.trigger_type }}" == "workflow_dispatch" && -n "$INPUT_AZURE_LOCATION" ]]; then
+ USER_SELECTED_LOCATION="$INPUT_AZURE_LOCATION"
+ echo "Using user-selected Azure location: $USER_SELECTED_LOCATION"
+ echo "AZURE_LOCATION=$USER_SELECTED_LOCATION" >> $GITHUB_ENV
+ echo "AZURE_LOCATION=$USER_SELECTED_LOCATION" >> $GITHUB_OUTPUT
+ else
+ echo "Using location from quota check for automatic triggers: $VALID_REGION"
+ echo "AZURE_LOCATION=$VALID_REGION" >> $GITHUB_ENV
+ echo "AZURE_LOCATION=$VALID_REGION" >> $GITHUB_OUTPUT
+ fi
+
+ - name: Generate Resource Group Name
+ id: generate_rg_name
+ shell: bash
+ env:
+ INPUT_RESOURCE_GROUP_NAME: ${{ inputs.resource_group_name }}
+ run: |
+ # Check if a resource group name was provided as input
+ if [[ -n "$INPUT_RESOURCE_GROUP_NAME" ]]; then
+ echo "Using provided Resource Group name: $INPUT_RESOURCE_GROUP_NAME"
+ echo "RESOURCE_GROUP_NAME=$INPUT_RESOURCE_GROUP_NAME" >> $GITHUB_ENV
+ else
+ echo "Generating a unique resource group name..."
+ ACCL_NAME="docgen" # Account name as specified
+ SHORT_UUID=$(uuidgen | cut -d'-' -f1)
+ UNIQUE_RG_NAME="arg-${ACCL_NAME}-${SHORT_UUID}"
+ echo "RESOURCE_GROUP_NAME=${UNIQUE_RG_NAME}" >> $GITHUB_ENV
+ echo "Generated RESOURCE_GROUP_NAME: ${UNIQUE_RG_NAME}"
+ fi
+
+ - name: Install Bicep CLI
+ shell: bash
+ run: az bicep install
+
+ - name: Check and Create Resource Group
+ id: check_create_rg
+ shell: bash
+ run: |
+ set -e
+ echo "🔍 Checking if resource group '$RESOURCE_GROUP_NAME' exists..."
+ rg_exists=$(az group exists --name $RESOURCE_GROUP_NAME)
+ if [ "$rg_exists" = "false" ]; then
+ echo "📦 Resource group does not exist. Creating new resource group '$RESOURCE_GROUP_NAME' in location '$AZURE_LOCATION'..."
+ az group create --name $RESOURCE_GROUP_NAME --location $AZURE_LOCATION || { echo "❌ Error creating resource group"; exit 1; }
+ echo "✅ Resource group '$RESOURCE_GROUP_NAME' created successfully."
+ else
+ echo "✅ Resource group '$RESOURCE_GROUP_NAME' already exists. Deploying to existing resource group."
+ fi
+ echo "RESOURCE_GROUP_NAME=$RESOURCE_GROUP_NAME" >> $GITHUB_OUTPUT
+ echo "RESOURCE_GROUP_NAME=$RESOURCE_GROUP_NAME" >> $GITHUB_ENV
+
+ - name: Generate Unique Solution Prefix
+ id: generate_solution_prefix
+ shell: bash
+ run: |
+ set -e
+ COMMON_PART="psldg"
+ TIMESTAMP=$(date +%s)
+ UPDATED_TIMESTAMP=$(echo $TIMESTAMP | tail -c 6)
+ UNIQUE_SOLUTION_PREFIX="${COMMON_PART}${UPDATED_TIMESTAMP}"
+ echo "SOLUTION_PREFIX=${UNIQUE_SOLUTION_PREFIX}" >> $GITHUB_ENV
+ echo "Generated SOLUTION_PREFIX: ${UNIQUE_SOLUTION_PREFIX}"
+
+ - name: Determine Docker Image Tag
+ id: determine_image_tag
+ env:
+ INPUT_DOCKER_IMAGE_TAG: ${{ inputs.docker_image_tag }}
+ run: |
+ if [[ "${{ env.BUILD_DOCKER_IMAGE }}" == "true" ]]; then
+ if [[ -n "$INPUT_DOCKER_IMAGE_TAG" ]]; then
+ IMAGE_TAG="$INPUT_DOCKER_IMAGE_TAG"
+ echo "🔗 Using Docker image tag from build job: $IMAGE_TAG"
+ else
+ echo "❌ Docker build job failed or was skipped, but BUILD_DOCKER_IMAGE is true"
+ exit 1
+ fi
+ else
+ echo "🏷️ Using existing Docker image based on branch..."
+ BRANCH_NAME="${{ env.BRANCH_NAME }}"
+ echo "Current branch: $BRANCH_NAME"
+
+ # Determine image tag based on branch
+ if [[ "$BRANCH_NAME" == "main" ]]; then
+ IMAGE_TAG="latest_waf"
+ echo "Using main branch - image tag: latest_waf"
+ elif [[ "$BRANCH_NAME" == "dev" ]]; then
+ IMAGE_TAG="dev"
+ echo "Using dev branch - image tag: dev"
+ elif [[ "$BRANCH_NAME" == "demo" ]]; then
+ IMAGE_TAG="demo"
+ echo "Using demo branch - image tag: demo"
+ else
+ IMAGE_TAG="latest_waf"
+ echo "Using default for branch '$BRANCH_NAME' - image tag: latest_waf"
+ fi
+
+ echo "Using existing Docker image tag: $IMAGE_TAG"
+ fi
+
+ echo "IMAGE_TAG=$IMAGE_TAG" >> $GITHUB_ENV
+ echo "IMAGE_TAG=$IMAGE_TAG" >> $GITHUB_OUTPUT
+
+ - name: Generate Unique Environment Name
+ id: generate_env_name
+ shell: bash
+ run: |
+ COMMON_PART="pslc"
+ TIMESTAMP=$(date +%s)
+ UPDATED_TIMESTAMP=$(echo $TIMESTAMP | tail -c 6)
+ UNIQUE_ENV_NAME="${COMMON_PART}${UPDATED_TIMESTAMP}"
+ echo "ENV_NAME=${UNIQUE_ENV_NAME}" >> $GITHUB_ENV
+ echo "Generated Environment Name: ${UNIQUE_ENV_NAME}"
+ echo "ENV_NAME=${UNIQUE_ENV_NAME}" >> $GITHUB_OUTPUT
+
+ - name: Display Workflow Configuration to GitHub Summary
+ shell: bash
+ env:
+ INPUT_AZURE_LOCATION: ${{ inputs.azure_location }}
+ INPUT_RESOURCE_GROUP_NAME: ${{ inputs.resource_group_name }}
+ run: |
+ echo "## 📋 Workflow Configuration Summary" >> $GITHUB_STEP_SUMMARY
+ echo "" >> $GITHUB_STEP_SUMMARY
+ echo "| Configuration | Value |" >> $GITHUB_STEP_SUMMARY
+ echo "|---------------|-------|" >> $GITHUB_STEP_SUMMARY
+ echo "| **Branch** | \`${{ env.BRANCH_NAME }}\` |" >> $GITHUB_STEP_SUMMARY
+ echo "| **WAF Enabled** | ${{ env.WAF_ENABLED == 'true' && '✅ Yes' || '❌ No' }} |" >> $GITHUB_STEP_SUMMARY
+ echo "| **EXP Enabled** | ${{ steps.configure_exp.outputs.EXP_ENABLED == 'true' && '✅ Yes' || '❌ No' }} |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Run E2E Tests** | \`${{ env.RUN_E2E_TESTS }}\` |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Cleanup Resources** | ${{ env.CLEANUP_RESOURCES == 'true' && '✅ Yes' || '❌ No' }} |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Build Docker Image** | ${{ env.BUILD_DOCKER_IMAGE == 'true' && '✅ Yes' || '❌ No' }} |" >> $GITHUB_STEP_SUMMARY
+
+ if [[ "${{ inputs.trigger_type }}" == "workflow_dispatch" && -n "$INPUT_AZURE_LOCATION" ]]; then
+ echo "| **Azure Location** | \`$INPUT_AZURE_LOCATION\` (User Selected) |" >> $GITHUB_STEP_SUMMARY
+ fi
+
+ if [[ -n "$INPUT_RESOURCE_GROUP_NAME" ]]; then
+ echo "| **Resource Group** | \`$INPUT_RESOURCE_GROUP_NAME\` (Pre-specified) |" >> $GITHUB_STEP_SUMMARY
+ else
+ echo "| **Resource Group** | \`${{ env.RESOURCE_GROUP_NAME }}\` (Auto-generated) |" >> $GITHUB_STEP_SUMMARY
+ fi
+
+ echo "" >> $GITHUB_STEP_SUMMARY
+
+ if [[ "${{ inputs.trigger_type }}" != "workflow_dispatch" ]]; then
+ echo "ℹ️ **Note:** Automatic Trigger - Using Non-WAF + Non-EXP configuration" >> $GITHUB_STEP_SUMMARY
+ else
+ echo "ℹ️ **Note:** Manual Trigger - Using user-specified configuration" >> $GITHUB_STEP_SUMMARY
+ fi
+
+ deploy-linux:
+ name: Deploy on Linux
+ needs: azure-setup
+ if: inputs.runner_os == 'ubuntu-latest' && !cancelled() && needs.azure-setup.result == 'success'
+ uses: ./.github/workflows/job-deploy-linux.yml
+ with:
+ ENV_NAME: ${{ needs.azure-setup.outputs.ENV_NAME }}
+ AZURE_ENV_OPENAI_LOCATION: ${{ needs.azure-setup.outputs.AZURE_ENV_OPENAI_LOCATION }}
+ AZURE_LOCATION: ${{ needs.azure-setup.outputs.AZURE_LOCATION }}
+ RESOURCE_GROUP_NAME: ${{ needs.azure-setup.outputs.RESOURCE_GROUP_NAME }}
+ IMAGE_TAG: ${{ needs.azure-setup.outputs.IMAGE_TAG }}
+ BUILD_DOCKER_IMAGE: ${{ inputs.build_docker_image || 'false' }}
+ EXP: ${{ needs.azure-setup.outputs.EXP_ENABLED }}
+ WAF_ENABLED: ${{ inputs.waf_enabled == true && 'true' || 'false' }}
+ AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID: ${{ inputs.AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID }}
+ AZURE_EXISTING_AI_PROJECT_RESOURCE_ID: ${{ inputs.AZURE_EXISTING_AI_PROJECT_RESOURCE_ID }}
+ secrets: inherit
+
+ deploy-windows:
+ name: Deploy on Windows
+ needs: azure-setup
+ if: inputs.runner_os == 'windows-latest' && !cancelled() && needs.azure-setup.result == 'success'
+ uses: ./.github/workflows/job-deploy-windows.yml
+ with:
+ ENV_NAME: ${{ needs.azure-setup.outputs.ENV_NAME }}
+ AZURE_ENV_OPENAI_LOCATION: ${{ needs.azure-setup.outputs.AZURE_ENV_OPENAI_LOCATION }}
+ AZURE_LOCATION: ${{ needs.azure-setup.outputs.AZURE_LOCATION }}
+ RESOURCE_GROUP_NAME: ${{ needs.azure-setup.outputs.RESOURCE_GROUP_NAME }}
+ IMAGE_TAG: ${{ needs.azure-setup.outputs.IMAGE_TAG }}
+ BUILD_DOCKER_IMAGE: ${{ inputs.build_docker_image || 'false' }}
+ EXP: ${{ needs.azure-setup.outputs.EXP_ENABLED }}
+ WAF_ENABLED: ${{ inputs.waf_enabled == true && 'true' || 'false' }}
+ AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID: ${{ inputs.AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID }}
+ AZURE_EXISTING_AI_PROJECT_RESOURCE_ID: ${{ inputs.AZURE_EXISTING_AI_PROJECT_RESOURCE_ID }}
+ secrets: inherit
diff --git a/archive-doc-gen/.github/workflows/job-docker-build.yml b/archive-doc-gen/.github/workflows/job-docker-build.yml
new file mode 100644
index 000000000..fc564ea3f
--- /dev/null
+++ b/archive-doc-gen/.github/workflows/job-docker-build.yml
@@ -0,0 +1,102 @@
+name: Docker Build Job
+
+on:
+ workflow_call:
+ inputs:
+ trigger_type:
+ description: 'Trigger type (workflow_dispatch, pull_request, schedule)'
+ required: true
+ type: string
+ build_docker_image:
+ description: 'Build And Push Docker Image (Optional)'
+ required: false
+ default: false
+ type: boolean
+ outputs:
+ IMAGE_TAG:
+ description: "Generated Docker Image Tag"
+ value: ${{ jobs.docker-build.outputs.IMAGE_TAG }}
+
+env:
+ BRANCH_NAME: ${{ github.event.workflow_run.head_branch || github.head_ref || github.ref_name }}
+permissions:
+ contents: read
+ actions: read
+
+jobs:
+ docker-build:
+ if: inputs.trigger_type == 'workflow_dispatch' && inputs.build_docker_image == true
+ runs-on: ubuntu-latest
+ outputs:
+ IMAGE_TAG: ${{ steps.generate_docker_tag.outputs.IMAGE_TAG }}
+ steps:
+ - name: Checkout Code
+ uses: actions/checkout@v4
+
+ - name: Generate Unique Docker Image Tag
+ id: generate_docker_tag
+ shell: bash
+ run: |
+ echo "🔨 Building new Docker image - generating unique tag..."
+ TIMESTAMP=$(date +%Y%m%d-%H%M%S)
+ RUN_ID="${{ github.run_id }}"
+ BRANCH_NAME="${{ github.head_ref || github.ref_name }}"
+ CLEAN_BRANCH_NAME=$(echo "$BRANCH_NAME" | sed 's/[^a-zA-Z0-9._-]/-/g' | sed 's/--*/-/g' | sed 's/^-\|-$//g')
+ UNIQUE_TAG="${CLEAN_BRANCH_NAME}-${TIMESTAMP}-${RUN_ID}"
+ echo "IMAGE_TAG=$UNIQUE_TAG" >> $GITHUB_ENV
+ echo "IMAGE_TAG=$UNIQUE_TAG" >> $GITHUB_OUTPUT
+ echo "Generated unique Docker tag: $UNIQUE_TAG"
+
+ - name: Set up Docker Buildx
+ uses: docker/setup-buildx-action@v3
+
+ - name: Log in to Azure Container Registry
+ uses: azure/docker-login@v2
+ with:
+ login-server: ${{ secrets.ACR_TEST_LOGIN_SERVER }}
+ username: ${{ secrets.ACR_TEST_USERNAME }}
+ password: ${{ secrets.ACR_TEST_PASSWORD }}
+
+ - name: Build and Push Docker Image
+ id: build_push_image
+ uses: docker/build-push-action@v6
+ env:
+ DOCKER_BUILD_SUMMARY: false
+ with:
+ context: ./src
+ file: ./src/WebApp.Dockerfile
+ push: true
+ tags: |
+ ${{ secrets.ACR_TEST_LOGIN_SERVER }}/webapp:${{ steps.generate_docker_tag.outputs.IMAGE_TAG }}
+ ${{ secrets.ACR_TEST_LOGIN_SERVER }}/webapp:${{ steps.generate_docker_tag.outputs.IMAGE_TAG }}_${{ github.run_number }}
+
+ - name: Verify Docker Image Build
+ shell: bash
+ run: |
+ echo "✅ Docker image successfully built and pushed"
+ echo "Image tag: ${{ steps.generate_docker_tag.outputs.IMAGE_TAG }}"
+
+ - name: Generate Docker Build Summary
+ if: always()
+ shell: bash
+ run: |
+ ACR_NAME=$(echo "${{ secrets.ACR_TEST_LOGIN_SERVER }}")
+ echo "## 🐳 Docker Build Job Summary" >> $GITHUB_STEP_SUMMARY
+ echo "" >> $GITHUB_STEP_SUMMARY
+ echo "| Field | Value |" >> $GITHUB_STEP_SUMMARY
+ echo "|-------|--------|" >> $GITHUB_STEP_SUMMARY
+ echo "| **Job Status** | ${{ job.status == 'success' && '✅ Success' || '❌ Failed' }} |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Image Tag** | \`${{ steps.generate_docker_tag.outputs.IMAGE_TAG }}\` |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Branch** | ${{ env.BRANCH_NAME }} |" >> $GITHUB_STEP_SUMMARY
+ echo "" >> $GITHUB_STEP_SUMMARY
+ if [[ "${{ job.status }}" == "success" ]]; then
+ echo "### ✅ Build Details" >> $GITHUB_STEP_SUMMARY
+ echo "Successfully built and pushed one Docker image to ACR:" >> $GITHUB_STEP_SUMMARY
+ echo "" >> $GITHUB_STEP_SUMMARY
+ echo "**Built Images:**" >> $GITHUB_STEP_SUMMARY
+ echo "- \`${ACR_NAME}.azurecr.io/webapp:${{ steps.generate_docker_tag.outputs.IMAGE_TAG }}\`" >> $GITHUB_STEP_SUMMARY
+ else
+ echo "### ❌ Build Failed" >> $GITHUB_STEP_SUMMARY
+ echo "- Docker build process encountered an error" >> $GITHUB_STEP_SUMMARY
+ echo "- Check the docker-build job for detailed error information" >> $GITHUB_STEP_SUMMARY
+ fi
diff --git a/archive-doc-gen/.github/workflows/job-send-notification.yml b/archive-doc-gen/.github/workflows/job-send-notification.yml
new file mode 100644
index 000000000..e5c833a33
--- /dev/null
+++ b/archive-doc-gen/.github/workflows/job-send-notification.yml
@@ -0,0 +1,419 @@
+name: Send Notification Job
+
+on:
+ workflow_call:
+ inputs:
+ trigger_type:
+ description: 'Trigger type (workflow_dispatch, pull_request, schedule)'
+ required: true
+ type: string
+ waf_enabled:
+ description: 'Enable WAF'
+ required: false
+ default: false
+ type: boolean
+ EXP:
+ description: 'Enable EXP'
+ required: false
+ default: false
+ type: boolean
+ run_e2e_tests:
+ description: 'Run End-to-End Tests'
+ required: false
+ default: 'GoldenPath-Testing'
+ type: string
+ existing_webapp_url:
+ description: 'Existing Container WebApp URL (Skips Deployment)'
+ required: false
+ default: ''
+ type: string
+ deploy_result:
+ description: 'Deploy job result (success, failure, skipped)'
+ required: true
+ type: string
+ e2e_test_result:
+ description: 'E2E test job result (success, failure, skipped)'
+ required: true
+ type: string
+ WEB_APPURL:
+ description: 'Container Web App URL'
+ required: false
+ default: ''
+ type: string
+ RESOURCE_GROUP_NAME:
+ description: 'Resource Group Name'
+ required: false
+ default: ''
+ type: string
+ QUOTA_FAILED:
+ description: 'Quota Check Failed Flag'
+ required: false
+ default: 'false'
+ type: string
+ TEST_SUCCESS:
+ description: 'Test Success Flag'
+ required: false
+ default: ''
+ type: string
+ TEST_REPORT_URL:
+ description: 'Test Report URL'
+ required: false
+ default: ''
+ type: string
+
+env:
+ GPT_MIN_CAPACITY: 100
+ BRANCH_NAME: ${{ github.event.workflow_run.head_branch || github.head_ref || github.ref_name }}
+ WAF_ENABLED: ${{ inputs.trigger_type == 'workflow_dispatch' && (inputs.waf_enabled || false) || false }}
+ EXP: ${{ inputs.trigger_type == 'workflow_dispatch' && (inputs.EXP || false) || false }}
+ RUN_E2E_TESTS: ${{ inputs.trigger_type == 'workflow_dispatch' && (inputs.run_e2e_tests || 'GoldenPath-Testing') || 'GoldenPath-Testing' }}
+permissions:
+ contents: read
+ actions: read
+
+jobs:
+ send-notification:
+ runs-on: ubuntu-latest
+ continue-on-error: true
+ env:
+ accelerator_name: "DocGen"
+ steps:
+ - name: Validate Workflow Input Parameters
+ shell: bash
+ env:
+ INPUT_TRIGGER_TYPE: ${{ inputs.trigger_type }}
+ INPUT_WAF_ENABLED: ${{ inputs.waf_enabled }}
+ INPUT_EXP: ${{ inputs.EXP }}
+ INPUT_RUN_E2E_TESTS: ${{ inputs.run_e2e_tests }}
+ INPUT_EXISTING_WEBAPP_URL: ${{ inputs.existing_webapp_url }}
+ INPUT_DEPLOY_RESULT: ${{ inputs.deploy_result }}
+ INPUT_E2E_TEST_RESULT: ${{ inputs.e2e_test_result }}
+ INPUT_WEB_APPURL: ${{ inputs.WEB_APPURL }}
+ INPUT_RESOURCE_GROUP_NAME: ${{ inputs.RESOURCE_GROUP_NAME }}
+ INPUT_QUOTA_FAILED: ${{ inputs.QUOTA_FAILED }}
+ INPUT_TEST_SUCCESS: ${{ inputs.TEST_SUCCESS }}
+ INPUT_TEST_REPORT_URL: ${{ inputs.TEST_REPORT_URL }}
+ run: |
+ echo "🔍 Validating workflow input parameters..."
+ VALIDATION_FAILED=false
+
+ # Validate trigger_type (required - alphanumeric with underscores)
+ if [[ -z "$INPUT_TRIGGER_TYPE" ]]; then
+ echo "❌ ERROR: trigger_type is required but was not provided"
+ VALIDATION_FAILED=true
+ elif [[ ! "$INPUT_TRIGGER_TYPE" =~ ^[a-zA-Z0-9_]+$ ]]; then
+ echo "❌ ERROR: trigger_type '$INPUT_TRIGGER_TYPE' is invalid. Must contain only alphanumeric characters and underscores"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ trigger_type: '$INPUT_TRIGGER_TYPE' is valid"
+ fi
+
+ # Validate waf_enabled (boolean)
+ if [[ "$INPUT_WAF_ENABLED" != "true" && "$INPUT_WAF_ENABLED" != "false" ]]; then
+ echo "❌ ERROR: waf_enabled must be 'true' or 'false', got: '$INPUT_WAF_ENABLED'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ waf_enabled: '$INPUT_WAF_ENABLED' is valid"
+ fi
+
+ # Validate EXP (boolean)
+ if [[ "$INPUT_EXP" != "true" && "$INPUT_EXP" != "false" ]]; then
+ echo "❌ ERROR: EXP must be 'true' or 'false', got: '$INPUT_EXP'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ EXP: '$INPUT_EXP' is valid"
+ fi
+
+ # Validate run_e2e_tests (specific allowed values)
+ if [[ -n "$INPUT_RUN_E2E_TESTS" ]]; then
+ ALLOWED_VALUES=("None" "GoldenPath-Testing" "Smoke-Testing")
+ if [[ ! " ${ALLOWED_VALUES[@]} " =~ " ${INPUT_RUN_E2E_TESTS} " ]]; then
+ echo "❌ ERROR: run_e2e_tests '$INPUT_RUN_E2E_TESTS' is invalid. Allowed values: ${ALLOWED_VALUES[*]}"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ run_e2e_tests: '$INPUT_RUN_E2E_TESTS' is valid"
+ fi
+ fi
+
+ # Validate existing_webapp_url (must start with https if provided)
+ if [[ -n "$INPUT_EXISTING_WEBAPP_URL" ]]; then
+ if [[ ! "$INPUT_EXISTING_WEBAPP_URL" =~ ^https:// ]]; then
+ echo "❌ ERROR: existing_webapp_url must start with 'https://', got: '$INPUT_EXISTING_WEBAPP_URL'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ existing_webapp_url: '$INPUT_EXISTING_WEBAPP_URL' is valid"
+ fi
+ fi
+
+ # Validate deploy_result (required, must be specific values)
+ if [[ -z "$INPUT_DEPLOY_RESULT" ]]; then
+ echo "❌ ERROR: deploy_result is required but not provided"
+ VALIDATION_FAILED=true
+ else
+ ALLOWED_DEPLOY_RESULTS=("success" "failure" "skipped")
+ if [[ ! " ${ALLOWED_DEPLOY_RESULTS[@]} " =~ " ${INPUT_DEPLOY_RESULT} " ]]; then
+ echo "❌ ERROR: deploy_result '$INPUT_DEPLOY_RESULT' is invalid. Allowed values: ${ALLOWED_DEPLOY_RESULTS[*]}"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ deploy_result: '$INPUT_DEPLOY_RESULT' is valid"
+ fi
+ fi
+
+ # Validate e2e_test_result (required, must be specific values)
+ if [[ -z "$INPUT_E2E_TEST_RESULT" ]]; then
+ echo "❌ ERROR: e2e_test_result is required but not provided"
+ VALIDATION_FAILED=true
+ else
+ ALLOWED_TEST_RESULTS=("success" "failure" "skipped")
+ if [[ ! " ${ALLOWED_TEST_RESULTS[@]} " =~ " ${INPUT_E2E_TEST_RESULT} " ]]; then
+ echo "❌ ERROR: e2e_test_result '$INPUT_E2E_TEST_RESULT' is invalid. Allowed values: ${ALLOWED_TEST_RESULTS[*]}"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ e2e_test_result: '$INPUT_E2E_TEST_RESULT' is valid"
+ fi
+ fi
+
+ # Validate WEB_APPURL (must start with https if provided)
+ if [[ -n "$INPUT_WEB_APPURL" ]]; then
+ if [[ ! "$INPUT_WEB_APPURL" =~ ^https:// ]]; then
+ echo "❌ ERROR: WEB_APPURL must start with 'https://', got: '$INPUT_WEB_APPURL'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ WEB_APPURL: '$INPUT_WEB_APPURL' is valid"
+ fi
+ fi
+
+ # Validate RESOURCE_GROUP_NAME (Azure resource group naming convention if provided)
+ if [[ -n "$INPUT_RESOURCE_GROUP_NAME" ]]; then
+ if [[ ! "$INPUT_RESOURCE_GROUP_NAME" =~ ^[a-zA-Z0-9._\(\)-]+$ ]] || [[ "$INPUT_RESOURCE_GROUP_NAME" =~ \.$ ]]; then
+ echo "❌ ERROR: RESOURCE_GROUP_NAME '$INPUT_RESOURCE_GROUP_NAME' is invalid. Must contain only alphanumerics, periods, underscores, hyphens, and parentheses. Cannot end with period."
+ VALIDATION_FAILED=true
+ elif [[ ${#INPUT_RESOURCE_GROUP_NAME} -gt 90 ]]; then
+ echo "❌ ERROR: RESOURCE_GROUP_NAME '$INPUT_RESOURCE_GROUP_NAME' exceeds 90 characters"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ RESOURCE_GROUP_NAME: '$INPUT_RESOURCE_GROUP_NAME' is valid"
+ fi
+ fi
+
+ # Validate QUOTA_FAILED (must be 'true', 'false', or empty string)
+ if [[ "$INPUT_QUOTA_FAILED" != "true" && "$INPUT_QUOTA_FAILED" != "false" && "$INPUT_QUOTA_FAILED" != "" ]]; then
+ echo "❌ ERROR: QUOTA_FAILED must be 'true', 'false', or empty string, got: '$INPUT_QUOTA_FAILED'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ QUOTA_FAILED: '$INPUT_QUOTA_FAILED' is valid"
+ fi
+
+ # Validate TEST_SUCCESS (must be 'true' or 'false' or empty)
+ if [[ -n "$INPUT_TEST_SUCCESS" ]]; then
+ if [[ "$INPUT_TEST_SUCCESS" != "true" && "$INPUT_TEST_SUCCESS" != "false" ]]; then
+ echo "❌ ERROR: TEST_SUCCESS must be 'true', 'false', or empty, got: '$INPUT_TEST_SUCCESS'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ TEST_SUCCESS: '$INPUT_TEST_SUCCESS' is valid"
+ fi
+ fi
+
+ # Validate TEST_REPORT_URL (must start with https if provided)
+ if [[ -n "$INPUT_TEST_REPORT_URL" ]]; then
+ if [[ ! "$INPUT_TEST_REPORT_URL" =~ ^https:// ]]; then
+ echo "❌ ERROR: TEST_REPORT_URL must start with 'https://', got: '$INPUT_TEST_REPORT_URL'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ TEST_REPORT_URL: '$INPUT_TEST_REPORT_URL' is valid"
+ fi
+ fi
+
+ # Fail workflow if any validation failed
+ if [[ "$VALIDATION_FAILED" == "true" ]]; then
+ echo ""
+ echo "❌ Parameter validation failed. Please correct the errors above and try again."
+ exit 1
+ fi
+
+ echo ""
+ echo "✅ All input parameters validated successfully!"
+
+ - name: Determine Test Suite Display Name
+ id: test_suite
+ shell: bash
+ env:
+ RUN_E2E_TESTS_INPUT: ${{ inputs.run_e2e_tests }}
+ run: |
+ if [ "$RUN_E2E_TESTS_INPUT" = "GoldenPath-Testing" ]; then
+ TEST_SUITE_NAME="Golden Path Testing"
+ elif [ "$RUN_E2E_TESTS_INPUT" = "Smoke-Testing" ]; then
+ TEST_SUITE_NAME="Smoke Testing"
+ elif [ "$RUN_E2E_TESTS_INPUT" = "None" ]; then
+ TEST_SUITE_NAME="None"
+ else
+ TEST_SUITE_NAME="$RUN_E2E_TESTS_INPUT"
+ fi
+ echo "TEST_SUITE_NAME=$TEST_SUITE_NAME" >> $GITHUB_OUTPUT
+ echo "Test Suite: $TEST_SUITE_NAME"
+
+ - name: Send Quota Failure Notification
+ if: inputs.deploy_result == 'failure' && inputs.QUOTA_FAILED == 'true'
+ shell: bash
+ env:
+ INPUT_DEPLOY_RESULT: ${{ inputs.deploy_result }}
+ INPUT_QUOTA_FAILED: ${{ inputs.QUOTA_FAILED }}
+ run: |
+ RUN_URL="https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}"
+ EMAIL_BODY=$(cat <Dear Team,We would like to inform you that the ${{ env.accelerator_name }} deployment has failed due to insufficient quota in the requested regions.
Issue Details:
• Quota check failed for GPT model
• Required GPT Capacity: ${{ env.GPT_MIN_CAPACITY }}
• Checked Regions: ${{ vars.AZURE_REGIONS }}
Run URL: ${RUN_URL}
Please resolve the quota issue and retry the deployment.
Best regards,
Your Automation Team
",
+ "subject": "${{ env.accelerator_name }} Pipeline - Failed (Insufficient Quota)"
+ }
+ EOF
+ )
+
+ curl -X POST "${{ secrets.EMAILNOTIFICATION_LOGICAPP_URL_TA }}" \
+ -H "Content-Type: application/json" \
+ -d "$EMAIL_BODY" || echo "Failed to send quota failure notification"
+
+ - name: Send Deployment Failure Notification
+ if: inputs.deploy_result == 'failure' && inputs.QUOTA_FAILED != 'true'
+ shell: bash
+ env:
+ INPUT_DEPLOY_RESULT: ${{ inputs.deploy_result }}
+ INPUT_QUOTA_FAILED: ${{ inputs.QUOTA_FAILED }}
+ INPUT_RESOURCE_GROUP_NAME: ${{ inputs.RESOURCE_GROUP_NAME }}
+ run: |
+ RUN_URL="https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}"
+ RESOURCE_GROUP="$INPUT_RESOURCE_GROUP_NAME"
+
+ EMAIL_BODY=$(cat <Dear Team,We would like to inform you that the ${{ env.accelerator_name }} deployment process has encountered an issue and has failed to complete successfully.
Deployment Details:
• Resource Group: ${RESOURCE_GROUP}
• WAF Enabled: ${{ env.WAF_ENABLED }}
• EXP Enabled: ${{ env.EXP }}
Run URL: ${RUN_URL}
Please investigate the deployment failure at your earliest convenience.
Best regards,
Your Automation Team
",
+ "subject": "${{ env.accelerator_name }} Pipeline - Failed"
+ }
+ EOF
+ )
+
+ curl -X POST "${{ secrets.EMAILNOTIFICATION_LOGICAPP_URL_TA }}" \
+ -H "Content-Type: application/json" \
+ -d "$EMAIL_BODY" || echo "Failed to send deployment failure notification"
+
+ - name: Send Success Notification
+ if: inputs.deploy_result == 'success' && (inputs.e2e_test_result == 'skipped' || inputs.TEST_SUCCESS == 'true')
+ shell: bash
+ env:
+ INPUT_DEPLOY_RESULT: ${{ inputs.deploy_result }}
+ INPUT_E2E_TEST_RESULT: ${{ inputs.e2e_test_result }}
+ INPUT_TEST_SUCCESS: ${{ inputs.TEST_SUCCESS }}
+ INPUT_WEB_APPURL: ${{ inputs.WEB_APPURL }}
+ INPUT_EXISTING_WEBAPP_URL: ${{ inputs.existing_webapp_url }}
+ INPUT_RESOURCE_GROUP_NAME: ${{ inputs.RESOURCE_GROUP_NAME }}
+ INPUT_TEST_REPORT_URL: ${{ inputs.TEST_REPORT_URL }}
+ run: |
+ RUN_URL="https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}"
+ WEBAPP_URL="${INPUT_WEB_APPURL:-$INPUT_EXISTING_WEBAPP_URL}"
+ RESOURCE_GROUP="$INPUT_RESOURCE_GROUP_NAME"
+ TEST_REPORT_URL="$INPUT_TEST_REPORT_URL"
+ TEST_SUITE_NAME="${{ steps.test_suite.outputs.TEST_SUITE_NAME }}"
+
+ if [ "$INPUT_E2E_TEST_RESULT" = "skipped" ]; then
+ EMAIL_BODY=$(cat <Dear Team,We would like to inform you that the ${{ env.accelerator_name }} deployment has completed successfully.
Deployment Details:
• Resource Group: ${RESOURCE_GROUP}
• Web App URL: ${WEBAPP_URL}
• E2E Tests: Skipped (as configured)
Configuration:
• WAF Enabled: ${{ env.WAF_ENABLED }}
• EXP Enabled: ${{ env.EXP }}
Run URL: ${RUN_URL}
Best regards,
Your Automation Team
",
+ "subject": "${{ env.accelerator_name }} Pipeline - Deployment Success"
+ }
+ EOF
+ )
+ else
+ EMAIL_BODY=$(cat <Dear Team,We would like to inform you that the ${{ env.accelerator_name }} deployment and testing process has completed successfully.
Deployment Details:
• Resource Group: ${RESOURCE_GROUP}
• Web App URL: ${WEBAPP_URL}
• E2E Tests: Passed ✅
• Test Suite: ${TEST_SUITE_NAME}
• Test Report: View Report
Configuration:
• WAF Enabled: ${{ env.WAF_ENABLED }}
• EXP Enabled: ${{ env.EXP }}
Run URL: ${RUN_URL}
Best regards,
Your Automation Team
",
+ "subject": "${{ env.accelerator_name }} Pipeline - Test Automation - Success"
+ }
+ EOF
+ )
+ fi
+
+ curl -X POST "${{ secrets.EMAILNOTIFICATION_LOGICAPP_URL_TA }}" \
+ -H "Content-Type: application/json" \
+ -d "$EMAIL_BODY" || echo "Failed to send success notification"
+
+ - name: Send Test Failure Notification
+ if: inputs.deploy_result == 'success' && inputs.e2e_test_result != 'skipped' && inputs.TEST_SUCCESS != 'true'
+ shell: bash
+ env:
+ INPUT_DEPLOY_RESULT: ${{ inputs.deploy_result }}
+ INPUT_E2E_TEST_RESULT: ${{ inputs.e2e_test_result }}
+ INPUT_TEST_SUCCESS: ${{ inputs.TEST_SUCCESS }}
+ INPUT_WEB_APPURL: ${{ inputs.WEB_APPURL }}
+ INPUT_EXISTING_WEBAPP_URL: ${{ inputs.existing_webapp_url }}
+ INPUT_RESOURCE_GROUP_NAME: ${{ inputs.RESOURCE_GROUP_NAME }}
+ INPUT_TEST_REPORT_URL: ${{ inputs.TEST_REPORT_URL }}
+ run: |
+ RUN_URL="https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}"
+ TEST_REPORT_URL="$INPUT_TEST_REPORT_URL"
+ WEBAPP_URL="${INPUT_WEB_APPURL:-$INPUT_EXISTING_WEBAPP_URL}"
+ RESOURCE_GROUP="$INPUT_RESOURCE_GROUP_NAME"
+ TEST_SUITE_NAME="${{ steps.test_suite.outputs.TEST_SUITE_NAME }}"
+
+ EMAIL_BODY=$(cat <Dear Team,We would like to inform you that ${{ env.accelerator_name }} accelerator test automation process has encountered issues and failed to complete successfully.
Deployment Details:
• Resource Group: ${RESOURCE_GROUP}
• Web App URL: ${WEBAPP_URL}
• Deployment Status: ✅ Success
• E2E Tests: ❌ Failed
• Test Suite: ${TEST_SUITE_NAME}
Test Details:
• Test Report: View Report
Run URL: ${RUN_URL}
Please investigate the matter at your earliest convenience.
Best regards,
Your Automation Team
",
+ "subject": "${{ env.accelerator_name }} Pipeline - Test Automation - Failed"
+ }
+ EOF
+ )
+
+ curl -X POST "${{ secrets.EMAILNOTIFICATION_LOGICAPP_URL_TA }}" \
+ -H "Content-Type: application/json" \
+ -d "$EMAIL_BODY" || echo "Failed to send test failure notification"
+
+ - name: Send Existing URL Success Notification
+ if: inputs.deploy_result == 'skipped' && inputs.existing_webapp_url != '' && inputs.e2e_test_result == 'success' && (inputs.TEST_SUCCESS == 'true' || inputs.TEST_SUCCESS == '')
+ shell: bash
+ env:
+ INPUT_DEPLOY_RESULT: ${{ inputs.deploy_result }}
+ INPUT_E2E_TEST_RESULT: ${{ inputs.e2e_test_result }}
+ INPUT_TEST_SUCCESS: ${{ inputs.TEST_SUCCESS }}
+ INPUT_EXISTING_WEBAPP_URL: ${{ inputs.existing_webapp_url }}
+ INPUT_TEST_REPORT_URL: ${{ inputs.TEST_REPORT_URL }}
+ run: |
+ RUN_URL="https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}"
+ EXISTING_URL="$INPUT_EXISTING_WEBAPP_URL"
+ TEST_REPORT_URL="$INPUT_TEST_REPORT_URL"
+ TEST_SUITE_NAME="${{ steps.test_suite.outputs.TEST_SUITE_NAME }}"
+
+ EMAIL_BODY=$(cat <Dear Team,The ${{ env.accelerator_name }} pipeline executed against the specified Target URL and testing process has completed successfully.
Test Results:
• Status: ✅ Passed
• Test Suite: ${TEST_SUITE_NAME}
${TEST_REPORT_URL:+• Test Report: View Report}
• Target URL: ${EXISTING_URL}
Deployment: Skipped
Run URL: ${RUN_URL}
Best regards,
Your Automation Team
",
+ "subject": "${{ env.accelerator_name }} Pipeline - Test Automation Passed"
+ }
+ EOF
+ )
+
+ curl -X POST "${{ secrets.EMAILNOTIFICATION_LOGICAPP_URL_TA }}" \
+ -H "Content-Type: application/json" \
+ -d "$EMAIL_BODY" || echo "Failed to send existing URL success notification"
+
+ - name: Send Existing URL Test Failure Notification
+ if: inputs.deploy_result == 'skipped' && inputs.existing_webapp_url != '' && inputs.e2e_test_result == 'failure'
+ shell: bash
+ env:
+ INPUT_DEPLOY_RESULT: ${{ inputs.deploy_result }}
+ INPUT_E2E_TEST_RESULT: ${{ inputs.e2e_test_result }}
+ INPUT_EXISTING_WEBAPP_URL: ${{ inputs.existing_webapp_url }}
+ INPUT_TEST_REPORT_URL: ${{ inputs.TEST_REPORT_URL }}
+ run: |
+ RUN_URL="https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}"
+ EXISTING_URL="$INPUT_EXISTING_WEBAPP_URL"
+ TEST_REPORT_URL="$INPUT_TEST_REPORT_URL"
+ TEST_SUITE_NAME="${{ steps.test_suite.outputs.TEST_SUITE_NAME }}"
+
+ EMAIL_BODY=$(cat <Dear Team,The ${{ env.accelerator_name }} pipeline executed against the specified Target URL and the test automation has encountered issues and failed to complete successfully.
Failure Details:
• Target URL: ${EXISTING_URL}
${TEST_REPORT_URL:+• Test Report: View Report}
• Test Suite: ${TEST_SUITE_NAME}
• Deployment: Skipped
Run URL: ${RUN_URL}
Best regards,
Your Automation Team
",
+ "subject": "${{ env.accelerator_name }} Pipeline - Test Automation Failed"
+ }
+ EOF
+ )
+
+ curl -X POST "${{ secrets.EMAILNOTIFICATION_LOGICAPP_URL_TA }}" \
+ -H "Content-Type: application/json" \
+ -d "$EMAIL_BODY" || echo "Failed to send existing URL test failure notification"
diff --git a/.github/workflows/node.js.yml b/archive-doc-gen/.github/workflows/node.js.yml
similarity index 100%
rename from .github/workflows/node.js.yml
rename to archive-doc-gen/.github/workflows/node.js.yml
diff --git a/.github/workflows/pr-title-checker.yml b/archive-doc-gen/.github/workflows/pr-title-checker.yml
similarity index 100%
rename from .github/workflows/pr-title-checker.yml
rename to archive-doc-gen/.github/workflows/pr-title-checker.yml
diff --git a/.github/workflows/pylint.yml b/archive-doc-gen/.github/workflows/pylint.yml
similarity index 100%
rename from .github/workflows/pylint.yml
rename to archive-doc-gen/.github/workflows/pylint.yml
diff --git a/.github/workflows/python-app.yml b/archive-doc-gen/.github/workflows/python-app.yml
similarity index 100%
rename from .github/workflows/python-app.yml
rename to archive-doc-gen/.github/workflows/python-app.yml
diff --git a/.github/workflows/stale-bot.yml b/archive-doc-gen/.github/workflows/stale-bot.yml
similarity index 100%
rename from .github/workflows/stale-bot.yml
rename to archive-doc-gen/.github/workflows/stale-bot.yml
diff --git a/.github/workflows/telemetry-template-check.yml b/archive-doc-gen/.github/workflows/telemetry-template-check.yml
similarity index 100%
rename from .github/workflows/telemetry-template-check.yml
rename to archive-doc-gen/.github/workflows/telemetry-template-check.yml
diff --git a/archive-doc-gen/.github/workflows/test-automation-v2.yml b/archive-doc-gen/.github/workflows/test-automation-v2.yml
new file mode 100644
index 000000000..637a79fa6
--- /dev/null
+++ b/archive-doc-gen/.github/workflows/test-automation-v2.yml
@@ -0,0 +1,196 @@
+name: Test Automation DocGen-v2
+
+on:
+ workflow_call:
+ inputs:
+ DOCGEN_URL:
+ required: true
+ type: string
+ description: "Web URL for DocGen"
+ TEST_SUITE:
+ required: false
+ type: string
+ default: "GoldenPath-Testing"
+ description: "Test suite to run: 'Smoke-Testing', 'GoldenPath-Testing' "
+ outputs:
+ TEST_SUCCESS:
+ description: "Whether tests passed"
+ value: ${{ jobs.test.outputs.TEST_SUCCESS }}
+ TEST_REPORT_URL:
+ description: "URL to test report artifact"
+ value: ${{ jobs.test.outputs.TEST_REPORT_URL }}
+
+env:
+ url: ${{ inputs.DOCGEN_URL }}
+ accelerator_name: "DocGen"
+ test_suite: ${{ inputs.TEST_SUITE }}
+permissions:
+ contents: read
+ actions: read
+
+jobs:
+ test:
+ runs-on: ubuntu-latest
+ outputs:
+ TEST_SUCCESS: ${{ steps.test1.outcome == 'success' || steps.test2.outcome == 'success' || steps.test3.outcome == 'success' }}
+ TEST_REPORT_URL: ${{ steps.upload_report.outputs.artifact-url }}
+ steps:
+ - name: Checkout repository
+ uses: actions/checkout@v5
+
+ - name: Set up Python
+ uses: actions/setup-python@v6
+ with:
+ python-version: '3.13'
+
+ - name: Login to Azure
+ run: |
+ az login --service-principal -u ${{ secrets.AZURE_CLIENT_ID }} -p ${{ secrets.AZURE_CLIENT_SECRET }} --tenant ${{ secrets.AZURE_TENANT_ID }}
+ az account set --subscription ${{ secrets.AZURE_SUBSCRIPTION_ID }}
+
+ - name: Install dependencies
+ run: |
+ python -m pip install --upgrade pip
+ pip install -r tests/e2e-test/requirements.txt
+
+ - name: Ensure browsers are installed
+ run: python -m playwright install --with-deps chromium
+
+ - name: Validate URL
+ run: |
+ if [ -z "${{ env.url }}" ]; then
+ echo "ERROR: No URL provided for testing"
+ exit 1
+ fi
+ echo "Testing URL: ${{ env.url }}"
+ echo "Test Suite: ${{ env.test_suite }}"
+
+
+ - name: Wait for Application to be Ready
+ run: |
+ echo "Waiting for application to be ready at ${{ env.url }} "
+ max_attempts=10
+ attempt=1
+
+ while [ $attempt -le $max_attempts ]; do
+ echo "Attempt $attempt: Checking if application is ready..."
+ if curl -f -s "${{ env.url }}" > /dev/null; then
+ echo "Application is ready!"
+ break
+
+ fi
+
+ if [ $attempt -eq $max_attempts ]; then
+ echo "Application is not ready after $max_attempts attempts"
+ exit 1
+ fi
+
+ echo "Application not ready, waiting 30 seconds..."
+ sleep 30
+ attempt=$((attempt + 1))
+ done
+
+ - name: Run tests(1)
+ id: test1
+ run: |
+ if [ "${{ env.test_suite }}" == "GoldenPath-Testing" ]; then
+ xvfb-run pytest -m goldenpath --html=report/report.html --self-contained-html
+ else
+ xvfb-run pytest --html=report/report.html --self-contained-html
+ fi
+ working-directory: tests/e2e-test
+ continue-on-error: true
+
+ - name: Sleep for 30 seconds
+ if: ${{ steps.test1.outcome == 'failure' }}
+ run: sleep 30s
+ shell: bash
+
+ - name: Run tests(2)
+ id: test2
+ if: ${{ steps.test1.outcome == 'failure' }}
+ run: |
+ if [ "${{ env.test_suite }}" == "GoldenPath-Testing" ]; then
+ xvfb-run pytest -m goldenpath --html=report/report.html --self-contained-html
+ else
+ xvfb-run pytest --html=report/report.html --self-contained-html
+ fi
+ working-directory: tests/e2e-test
+ continue-on-error: true
+
+ - name: Sleep for 60 seconds
+ if: ${{ steps.test2.outcome == 'failure' }}
+ run: sleep 60s
+ shell: bash
+
+ - name: Run tests(3)
+ id: test3
+ if: ${{ steps.test2.outcome == 'failure' }}
+ run: |
+ if [ "${{ env.test_suite }}" == "GoldenPath-Testing" ]; then
+ xvfb-run pytest -m goldenpath --html=report/report.html --self-contained-html
+ else
+ xvfb-run pytest --html=report/report.html --self-contained-html
+ fi
+ working-directory: tests/e2e-test
+
+ - name: Upload test report
+ id: upload_report
+ uses: actions/upload-artifact@v4
+ if: ${{ !cancelled() }}
+ with:
+ name: test-report
+ path: |
+ tests/e2e-test/report/*
+ tests/e2e-test/screenshots/*
+
+ - name: Generate E2E Test Summary
+ if: always()
+ run: |
+ # Determine test suite type for title
+ if [ "${{ env.test_suite }}" == "GoldenPath-Testing" ]; then
+ echo "## 🧪 E2E Test Job Summary : Golden Path Testing" >> $GITHUB_STEP_SUMMARY
+ else
+ echo "## 🧪 E2E Test Job Summary : Smoke Testing" >> $GITHUB_STEP_SUMMARY
+ fi
+ echo "" >> $GITHUB_STEP_SUMMARY
+ echo "| Field | Value |" >> $GITHUB_STEP_SUMMARY
+ echo "|-------|--------|" >> $GITHUB_STEP_SUMMARY
+
+ # Determine overall test result
+ OVERALL_SUCCESS="${{ steps.test1.outcome == 'success' || steps.test2.outcome == 'success' || steps.test3.outcome == 'success' }}"
+ if [[ "$OVERALL_SUCCESS" == "true" ]]; then
+ echo "| **Job Status** | ✅ Success |" >> $GITHUB_STEP_SUMMARY
+ else
+ echo "| **Job Status** | ❌ Failed |" >> $GITHUB_STEP_SUMMARY
+ fi
+
+ echo "| **Target URL** | [${{ env.url }}](${{ env.url }}) |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Test Suite** | \`${{ env.test_suite }}\` |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Test Report** | [Download Artifact](${{ steps.upload_report.outputs.artifact-url }}) |" >> $GITHUB_STEP_SUMMARY
+ echo "" >> $GITHUB_STEP_SUMMARY
+
+ echo "### 📋 Test Execution Details" >> $GITHUB_STEP_SUMMARY
+ echo "| Attempt | Status | Notes |" >> $GITHUB_STEP_SUMMARY
+ echo "|---------|--------|-------|" >> $GITHUB_STEP_SUMMARY
+ echo "| **Test Run 1** | ${{ steps.test1.outcome == 'success' && '✅ Passed' || '❌ Failed' }} | Initial test execution |" >> $GITHUB_STEP_SUMMARY
+
+ if [[ "${{ steps.test1.outcome }}" == "failure" ]]; then
+ echo "| **Test Run 2** | ${{ steps.test2.outcome == 'success' && '✅ Passed' || steps.test2.outcome == 'failure' && '❌ Failed' || '⏸️ Skipped' }} | Retry after 30s delay |" >> $GITHUB_STEP_SUMMARY
+ fi
+
+ if [[ "${{ steps.test2.outcome }}" == "failure" ]]; then
+ echo "| **Test Run 3** | ${{ steps.test3.outcome == 'success' && '✅ Passed' || steps.test3.outcome == 'failure' && '❌ Failed' || '⏸️ Skipped' }} | Final retry after 60s delay |" >> $GITHUB_STEP_SUMMARY
+ fi
+
+ echo "" >> $GITHUB_STEP_SUMMARY
+
+ if [[ "$OVERALL_SUCCESS" == "true" ]]; then
+ echo "### ✅ Test Results" >> $GITHUB_STEP_SUMMARY
+ echo "- End-to-end tests completed successfully" >> $GITHUB_STEP_SUMMARY
+ echo "- Application is functioning as expected" >> $GITHUB_STEP_SUMMARY
+ else
+ echo "### ❌ Test Results" >> $GITHUB_STEP_SUMMARY
+ echo "- All test attempts failed" >> $GITHUB_STEP_SUMMARY
+ echo "- Check the e2e-test/test job for detailed error information" >> $GITHUB_STEP_SUMMARY
+ fi
\ No newline at end of file
diff --git a/.github/workflows/test-automation.yml b/archive-doc-gen/.github/workflows/test-automation.yml
similarity index 99%
rename from .github/workflows/test-automation.yml
rename to archive-doc-gen/.github/workflows/test-automation.yml
index 1be1ecb7b..f2b5049ea 100644
--- a/.github/workflows/test-automation.yml
+++ b/archive-doc-gen/.github/workflows/test-automation.yml
@@ -22,7 +22,10 @@ on:
env:
url: ${{ inputs.DOCGEN_URL }}
accelerator_name: "DocGen"
-
+permissions:
+ contents: read
+ actions: read
+
jobs:
test:
runs-on: ubuntu-latest
diff --git a/.github/workflows/tests.yml b/archive-doc-gen/.github/workflows/tests.yml
similarity index 100%
rename from .github/workflows/tests.yml
rename to archive-doc-gen/.github/workflows/tests.yml
diff --git a/archive-doc-gen/.gitignore b/archive-doc-gen/.gitignore
new file mode 100644
index 000000000..0abb7a034
--- /dev/null
+++ b/archive-doc-gen/.gitignore
@@ -0,0 +1,15 @@
+.venv
+
+.env
+.azure/
+__pycache__/
+.ipynb_checkpoints/
+
+
+venv
+myenv
+
+scriptsenv/
+
+scriptenv
+pdf
\ No newline at end of file
diff --git a/.vscode/launch.json b/archive-doc-gen/.vscode/launch.json
similarity index 100%
rename from .vscode/launch.json
rename to archive-doc-gen/.vscode/launch.json
diff --git a/.vscode/settings.json b/archive-doc-gen/.vscode/settings.json
similarity index 100%
rename from .vscode/settings.json
rename to archive-doc-gen/.vscode/settings.json
diff --git a/archive-doc-gen/CODE_OF_CONDUCT.md b/archive-doc-gen/CODE_OF_CONDUCT.md
new file mode 100644
index 000000000..f9ba8cf65
--- /dev/null
+++ b/archive-doc-gen/CODE_OF_CONDUCT.md
@@ -0,0 +1,9 @@
+# Microsoft Open Source Code of Conduct
+
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
+
+Resources:
+
+- [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/)
+- [Microsoft Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
+- Contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with questions or concerns
diff --git a/archive-doc-gen/CONTRIBUTING.md b/archive-doc-gen/CONTRIBUTING.md
new file mode 100644
index 000000000..c282e9a1a
--- /dev/null
+++ b/archive-doc-gen/CONTRIBUTING.md
@@ -0,0 +1,14 @@
+# Contributing
+
+This project welcomes contributions and suggestions. Most contributions require you to
+agree to a Contributor License Agreement (CLA) declaring that you have the right to,
+and actually do, grant us the rights to use your contribution. For details, visit
+https://cla.microsoft.com.
+
+When you submit a pull request, a CLA-bot will automatically determine whether you need
+to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the
+instructions provided by the bot. You will only need to do this once across all repositories using our CLA.
+
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
+For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
+or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
\ No newline at end of file
diff --git a/archive-doc-gen/LICENSE b/archive-doc-gen/LICENSE
new file mode 100644
index 000000000..9e841e7a2
--- /dev/null
+++ b/archive-doc-gen/LICENSE
@@ -0,0 +1,21 @@
+ MIT License
+
+ Copyright (c) Microsoft Corporation.
+
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+
+ The above copyright notice and this permission notice shall be included in all
+ copies or substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ SOFTWARE
diff --git a/archive-doc-gen/README.md b/archive-doc-gen/README.md
new file mode 100644
index 000000000..4db342838
--- /dev/null
+++ b/archive-doc-gen/README.md
@@ -0,0 +1,228 @@
+# Document generation solution accelerator
+
+This solution accelerator is a powerful tool that helps you create your own AI assistant for document generation. The accelerator can be used by any customer looking for reusable architecture and code snippets to build an AI assistant to generate a sample template and content grounded on their own enterprise data.
+
+This example focuses on a generic use case - chat with your own data, generate a document template using your own data, and exporting the document in a docx format.
+
+
+
+
+
+[**SOLUTION OVERVIEW**](#solution-overview) \| [**QUICK DEPLOY**](#quick-deploy) \| [**BUSINESS SCENARIO**](#business-scenario) \| [**SUPPORTING DOCUMENTATION**](#supporting-documentation)
+
+
+
+
+**Note:** With any AI solutions you create using these templates, you are responsible for assessing all associated risks and for complying with all applicable laws and safety standards. Learn more in the transparency documents for [Agent Service](https://learn.microsoft.com/en-us/azure/ai-foundry/responsible-ai/agents/transparency-note) and [Agent Framework](https://github.com/microsoft/agent-framework/blob/main/TRANSPARENCY_FAQ.md).
+
+
+
+Solution overview
+
+
+It leverages Azure OpenAI Service and Azure AI Search, to identify relevant documents, summarize unstructured information, and generate document templates.
+
+The sample data is sourced from generic AI-generated promissory notes. The documents are intended for use as sample data only.
+
+### Solution architecture
+||
+|---|
+
+
+
+
+### Additional resources
+
+[Azure OpenAI Service](https://learn.microsoft.com/en-us/azure/ai-services/openai/)
+
+[Azure AI Search](https://learn.microsoft.com/en-us/azure/search/)
+
+[Azure AI Foundry](https://learn.microsoft.com/en-us/azure/ai-studio/)
+
+
+
+
+### Key features
+
+ Click to learn more about the key features this solution enables
+
+ - **Semantic search**
+ Azure AI Search to enable RAG and grounding of the application on the processed dataset.
+
+ - **Summarization**
+ Azure OpenAI Service and GPT models to help summarize the search content and answer questions.
+
+ - **Content generation**
+ Azure OpenAI Service and GPT models to help generate relevant content with Prompt Flow.
+
+
+
+
+
+
+
+Quick deploy
+
+
+### How to install or deploy
+Follow the quick deploy steps on the deployment guide to deploy this solution to your own Azure subscription.
+
+> **Note:** This solution accelerator requires **Azure Developer CLI (azd) version 1.18.0 or higher**. Please ensure you have the latest version installed before proceeding with deployment. [Download azd here](https://learn.microsoft.com/en-us/azure/developer/azure-developer-cli/install-azd).
+
+[Click here to launch the deployment guide](./docs/DeploymentGuide.md)
+
+
+**For Local Development**
+- [Local Development Setup Guide](docs/LocalDevelopmentSetup.md) - Comprehensive setup instructions for Windows, Linux, and macOS
+
+| [](https://codespaces.new/microsoft/document-generation-solution-accelerator) | [](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/microsoft/document-generation-solution-accelerator) | [&message=Open&color=blue&logo=visualstudiocode&logoColor=white)](https://vscode.dev/azure/?vscode-azure-exp=foundry&agentPayload=eyJiYXNlVXJsIjogImh0dHBzOi8vcmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbS9taWNyb3NvZnQvZG9jdW1lbnQtZ2VuZXJhdGlvbi1zb2x1dGlvbi1hY2NlbGVyYXRvci9yZWZzL2hlYWRzL21haW4vaW5mcmEvdnNjb2RlX3dlYiIsICJpbmRleFVybCI6ICIvaW5kZXguanNvbiIsICJ2YXJpYWJsZXMiOiB7ImFnZW50SWQiOiAiIiwgImNvbm5lY3Rpb25TdHJpbmciOiAiIiwgInRocmVhZElkIjogIiIsICJ1c2VyTWVzc2FnZSI6ICIiLCAicGxheWdyb3VuZE5hbWUiOiAiIiwgImxvY2F0aW9uIjogIiIsICJzdWJzY3JpcHRpb25JZCI6ICIiLCAicmVzb3VyY2VJZCI6ICIiLCAicHJvamVjdFJlc291cmNlSWQiOiAiIiwgImVuZHBvaW50IjogIiJ9LCAiY29kZVJvdXRlIjogWyJhaS1wcm9qZWN0cy1zZGsiLCAicHl0aG9uIiwgImRlZmF1bHQtYXp1cmUtYXV0aCIsICJlbmRwb2ludCJdfQ==) |
+|---|---|---|
+
+
+
+> ⚠️ **Important: Check Azure OpenAI Quota Availability**
+
To ensure sufficient quota is available in your subscription, please follow [quota check instructions guide](./docs/QuotaCheck.md) before you deploy the solution.
+
+
+
+### Prerequisites and costs
+
+To deploy this solution accelerator, ensure you have access to an [Azure subscription](https://azure.microsoft.com/free/) with the necessary permissions to create **resource groups, resources, app registrations, and assign roles at the resource group level**. This should include Contributor role at the subscription level and Role Based Access Control role on the subscription and/or resource group level. Follow the steps in [Azure Account Set Up](./docs/AzureAccountSetUp.md).
+
+Check the [Azure Products by Region](https://azure.microsoft.com/en-us/explore/global-infrastructure/products-by-region/?products=all®ions=all) page and select a **region** where the following services are available.
+
+Pricing varies per region and usage, so it isn't possible to predict exact costs for your usage. The majority of the Azure resources used in this infrastructure are on usage-based pricing tiers. However, Azure Container Registry has a fixed cost per registry per day.
+
+Use the [Azure pricing calculator](https://azure.microsoft.com/en-us/pricing/calculator) to calculate the cost of this solution in your subscription.
+
+Review a [sample pricing sheet](https://azure.com/e/2402502429fc46429e395e0bb93d0711) in the event you want to customize and scale usage.
+
+_Note: This is not meant to outline all costs as selected SKUs, scaled use, customizations, and integrations into your own tenant can affect the total consumption of this sample solution. The sample pricing sheet is meant to give you a starting point to customize the estimate for your specific needs._
+
+
+
+| Product | Description | Cost |
+|---|---|---|
+| [Azure AI Foundry](https://learn.microsoft.com/en-us/azure/ai-foundry/) | Free tier. Build generative AI applications on an enterprise-grade platform. | [Pricing](https://azure.microsoft.com/pricing/details/ai-studio/) |
+| [Azure AI Search](https://learn.microsoft.com/en-us/azure/search/) | Standard tier, S1. Pricing is based on the number of documents and operations. Information retrieval at scale for vector and text content in traditional or generative search scenarios. | [Pricing](https://azure.microsoft.com/pricing/details/search/) |
+| [Azure Storage Account](https://learn.microsoft.com/en-us/azure/storage/blobs/) | Standard tier, LRS. Pricing is based on storage and operations. Blob storage in the clopud, optimized for storing massive amounts of unstructured data. | [Pricing](https://azure.microsoft.com/pricing/details/storage/blobs/) |
+| [Azure Key Vault](https://learn.microsoft.com/en-us/azure/key-vault/) | Standard tier. Pricing is based on the number of operations. Maintain keys that access and encrypt your cloud resources, apps, and solutions. | [Pricing](https://azure.microsoft.com/pricing/details/key-vault/) |
+| [Azure AI Services](https://learn.microsoft.com/en-us/azure/ai-services/) | S0 tier, defaults to gpt-4.1 and text-embedding-ada-002 models. Pricing is based on token count. | [Pricing](https://azure.microsoft.com/pricing/details/cognitive-services/) |
+| [Azure Container App](https://learn.microsoft.com/en-us/azure/container-apps/) | Consumption tier with 0.5 CPU, 1GiB memory/storage. Pricing is based on resource allocation, and each month allows for a certain amount of free usage. Allows you to run containerized applications without worrying about orchestration or infrastructure. | [Pricing](https://azure.microsoft.com/pricing/details/container-apps/) |
+| [Azure Container Registry](https://learn.microsoft.com/en-us/azure/container-registry/) | Basic tier. Build, store, and manage container images and artifacts in a private registry for all types of container deployments | [Pricing](https://azure.microsoft.com/pricing/details/container-registry/) |
+| [Log analytics](https://learn.microsoft.com/en-us/azure/azure-monitor/) | Pay-as-you-go tier. Costs based on data ingested. Collect and analyze on telemetry data generated by Azure. | [Pricing](https://azure.microsoft.com/pricing/details/monitor/) |
+| [Azure Cosmos DB](https://learn.microsoft.com/en-us/azure/cosmos-db/) | Fully managed, distributed NoSQL, relational, and vector database for modern app development. | [Pricing](https://azure.microsoft.com/en-us/pricing/details/cosmos-db/autoscale-provisioned/) |
+
+
+
+
+
+>⚠️ **Important:** To avoid unnecessary costs, remember to take down your app if it's no longer in use,
+either by deleting the resource group in the Portal or running `azd down`.
+
+
+
+Business Scenario
+
+
+
+||
+|---|
+
+
+
+Put your data to work by reducing blank page anxiety, speeding up document drafting, improving draft document quality, and reference information quickly - keeping experts in their expertise. Draft document templates for your organization including Invoices, End-user Contracts, Purchase Orders, Investment Proposals, and Grant Submissions.
+
+⚠️ The sample data used in this repository is synthetic and generated using Azure OpenAI Service. The data is intended for use as sample data only.
+
+
+### Business value
+
+ Click to learn more about what value this solution provides
+
+ - **Draft templates quickly**
+ Put your data to work to create any kind of document that is supported by a large data library.
+
+ - **Share**
+ Share with co-authors, contributors and approvers quickly.
+
+ - **Contextualize information**
+ Provide context using natural language. Primary and secondary queries allow for access to supplemental detail – reducing cognitive load, increasing efficiency, and enabling focus on higher value work.
+
+ - **Gain confidence in responses**
+ Trust responses to queries by customizing how data is referenced and returned to users, reducing the risk of hallucinated responses.
Access reference documents in the same chat window to get more detail and confirm accuracy.
+
+ - **Secure data and responsible AI for innovation**
+ Improve data security to minimize breaches, fostering a culture of responsible AI adoption, maximize innovation opportunities, and sustain competitive edge.
+
+
+
+
+
+
+
+Supporting documentation
+
+
+### Security guidelines
+
+This template uses Azure Key Vault to store all connections to communicate between resources.
+
+This template also uses [Managed Identity](https://learn.microsoft.com/entra/identity/managed-identities-azure-resources/overview) for local development and deployment.
+
+To ensure continued best practices in your own repository, we recommend that anyone creating solutions based on our templates ensure that the [Github secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning) setting is enabled.
+
+You may want to consider additional security measures, such as:
+
+* Enabling Microsoft Defender for Cloud to [secure your Azure resources](https://learn.microsoft.com/azure/defender-for-cloud).
+* Protecting the Azure Container Apps instance with a [firewall](https://learn.microsoft.com/azure/container-apps/waf-app-gateway) and/or [Virtual Network](https://learn.microsoft.com/azure/container-apps/networking?tabs=workload-profiles-env%2Cazure-cli).
+
+
+
+### Cross references
+Check out similar solution accelerators
+
+| Solution Accelerator | Description |
+|---|---|
+| [Chat with your data](https://github.com/Azure-Samples/chat-with-your-data-solution-accelerator) | Chat with their own data by combining Azure Cognitive Search and Large Language Models (LLMs) to create a conversational search experience. It enables increased user efficiency by minimizing endpoints required to access internal company knowledgebases. |
+| [Document knowledge mining](https://github.com/microsoft/Document-Knowledge-Mining-Solution-Accelerator) | Built on Azure OpenAI Service and Azure AI Document Intelligence to process and extract summaries, entities, and metadata from unstructured, multi-modal documents and enable searching and chatting over this data. |
+| [Build your own copilot](https://github.com/microsoft/Build-your-own-copilot-Solution-Accelerator) | Helps client advisors to save time and prepare relevant discussion topics for scheduled meetings with overviews, client profile views, and chatting with structured data. |
+
+
+
+
+
+## Provide feedback
+
+Have questions, find a bug, or want to request a feature? [Submit a new issue](https://github.com/microsoft/document-generation-solution-accelerator/issues) on this repo and we'll connect.
+
+
+
+## Responsible AI Transparency FAQ
+Please refer to [Transparency FAQ](./docs/TRANSPARENCY_FAQ.md) for responsible AI transparency details of this solution accelerator.
+
+
+
+## Disclaimers
+
+This release is an artificial intelligence (AI) system that generates text based on user input. The text generated by this system may include ungrounded content, meaning that it is not verified by any reliable source or based on any factual data. The data included in this release is synthetic, meaning that it is artificially created by the system and may contain factual errors or inconsistencies. Users of this release are responsible for determining the accuracy, validity, and suitability of any content generated by the system for their intended purposes. Users should not rely on the system output as a source of truth or as a substitute for human judgment or expertise.
+
+This release only supports English language input and output. Users should not attempt to use the system with any other language or format. The system output may not be compatible with any translation tools or services, and may lose its meaning or coherence if translated.
+
+This release does not reflect the opinions, views, or values of Microsoft Corporation or any of its affiliates, subsidiaries, or partners. The system output is solely based on the system's own logic and algorithms, and does not represent any endorsement, recommendation, or advice from Microsoft or any other entity. Microsoft disclaims any liability or responsibility for any damages, losses, or harms arising from the use of this release or its output by any user or third party.
+
+This release does not provide any financial advice, and is not designed to replace the role of qualified client advisors in appropriately advising clients. Users should not use the system output for any financial decisions or transactions, and should consult with a professional financial advisor before taking any action based on the system output. Microsoft is not a financial institution or a fiduciary, and does not offer any financial products or services through this release or its output.
+
+This release is intended as a proof of concept only, and is not a finished or polished product. It is not intended for commercial use or distribution, and is subject to change or discontinuation without notice. Any planned deployment of this release or its output should include comprehensive testing and evaluation to ensure it is fit for purpose and meets the user's requirements and expectations. Microsoft does not guarantee the quality, performance, reliability, or availability of this release or its output, and does not provide any warranty or support for it.
+
+This Software requires the use of third-party components which are governed by separate proprietary or open-source licenses as identified below, and you must comply with the terms of each applicable license in order to use the Software. You acknowledge and agree that this license does not grant you a license or other right to use any such third-party proprietary or open-source components.
+
+To the extent that the Software includes components or code used in or derived from Microsoft products or services, including without limitation Microsoft Azure Services (collectively, “Microsoft Products and Services”), you must also comply with the Product Terms applicable to such Microsoft Products and Services. You acknowledge and agree that the license governing the Software does not grant you a license or other right to use Microsoft Products and Services. Nothing in the license or this ReadMe file will serve to supersede, amend, terminate or modify any terms in the Product Terms for any Microsoft Products and Services.
+
+You must also comply with all domestic and international export laws and regulations that apply to the Software, which include restrictions on destinations, end users, and end use. For further information on export restrictions, visit https://aka.ms/exporting.
+
+You acknowledge that the Software and Microsoft Products and Services (1) are not designed, intended or made available as a medical device(s), and (2) are not designed or intended to be a substitute for professional medical advice, diagnosis, treatment, or judgment and should not be used to replace or as a substitute for professional medical advice, diagnosis, treatment, or judgment. Customer is solely responsible for displaying and/or obtaining appropriate consents, warnings, disclaimers, and acknowledgements to end users of Customer’s implementation of the Online Services.
+
+You acknowledge the Software is not subject to SOC 1 and SOC 2 compliance audits. No Microsoft technology, nor any of its component technologies, including the Software, is intended or made available as a substitute for the professional advice, opinion, or judgment of a certified financial services professional. Do not use the Software to replace, substitute, or provide professional financial advice or judgment.
+
+BY ACCESSING OR USING THE SOFTWARE, YOU ACKNOWLEDGE THAT THE SOFTWARE IS NOT DESIGNED OR INTENDED TO SUPPORT ANY USE IN WHICH A SERVICE INTERRUPTION, DEFECT, ERROR, OR OTHER FAILURE OF THE SOFTWARE COULD RESULT IN THE DEATH OR SERIOUS BODILY INJURY OF ANY PERSON OR IN PHYSICAL OR ENVIRONMENTAL DAMAGE (COLLECTIVELY, “HIGH-RISK USE”), AND THAT YOU WILL ENSURE THAT, IN THE EVENT OF ANY INTERRUPTION, DEFECT, ERROR, OR OTHER FAILURE OF THE SOFTWARE, THE SAFETY OF PEOPLE, PROPERTY, AND THE ENVIRONMENT ARE NOT REDUCED BELOW A LEVEL THAT IS REASONABLY, APPROPRIATE, AND LEGAL, WHETHER IN GENERAL OR IN A SPECIFIC INDUSTRY. BY ACCESSING THE SOFTWARE, YOU FURTHER ACKNOWLEDGE THAT YOUR HIGH-RISK USE OF THE SOFTWARE IS AT YOUR OWN RISK.
diff --git a/archive-doc-gen/SECURITY.md b/archive-doc-gen/SECURITY.md
new file mode 100644
index 000000000..96d73bc27
--- /dev/null
+++ b/archive-doc-gen/SECURITY.md
@@ -0,0 +1,41 @@
+
+
+## Security
+
+Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet) and [Xamarin](https://github.com/xamarin).
+
+If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://aka.ms/security.md/definition), please report it to us as described below.
+
+## Reporting Security Issues
+
+**Please do not report security vulnerabilities through public GitHub issues.**
+
+Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://aka.ms/security.md/msrc/create-report).
+
+If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com). If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://aka.ms/security.md/msrc/pgp).
+
+You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc).
+
+Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
+
+ * Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
+ * Full paths of source file(s) related to the manifestation of the issue
+ * The location of the affected source code (tag/branch/commit or direct URL)
+ * Any special configuration required to reproduce the issue
+ * Step-by-step instructions to reproduce the issue
+ * Proof-of-concept or exploit code (if possible)
+ * Impact of the issue, including how an attacker might exploit the issue
+
+This information will help us triage your report more quickly.
+
+If you are reporting for a bug bounty, more complete reports can contribute to a higher bounty award. Please visit our [Microsoft Bug Bounty Program](https://aka.ms/security.md/msrc/bounty) page for more details about our active programs.
+
+## Preferred Languages
+
+We prefer all communications to be in English.
+
+## Policy
+
+Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://aka.ms/security.md/cvd).
+
+
\ No newline at end of file
diff --git a/archive-doc-gen/SUPPORT.md b/archive-doc-gen/SUPPORT.md
new file mode 100644
index 000000000..2c42db0f8
--- /dev/null
+++ b/archive-doc-gen/SUPPORT.md
@@ -0,0 +1,13 @@
+# Support
+
+## How to file issues and get help
+
+This project uses GitHub Issues to track bugs and feature requests. Please search the existing
+issues before filing new issues to avoid duplicates. For new issues, file your bug or
+feature request as a new Issue.
+
+For help and questions about using this project, please submit an issue on this repository.
+
+## Microsoft Support Policy
+
+Support for this repository is limited to the resources listed above.
\ No newline at end of file
diff --git a/app-azure.yaml b/archive-doc-gen/app-azure.yaml
similarity index 100%
rename from app-azure.yaml
rename to archive-doc-gen/app-azure.yaml
diff --git a/azure.yaml b/archive-doc-gen/azure.yaml
similarity index 100%
rename from azure.yaml
rename to archive-doc-gen/azure.yaml
diff --git a/archive-doc-gen/azure_custom.yaml b/archive-doc-gen/azure_custom.yaml
new file mode 100644
index 000000000..af8bae654
--- /dev/null
+++ b/archive-doc-gen/azure_custom.yaml
@@ -0,0 +1,48 @@
+environment:
+ name: document-generation
+ location: eastus
+
+name: document-generation
+metadata:
+ template: document-generation@1.0
+
+requiredVersions:
+ azd: '>= 1.18.0'
+
+parameters:
+ solutionPrefix:
+ type: string
+ default: bs-azdtest
+ otherLocation:
+ type: string
+ default: eastus2
+ baseUrl:
+ type: string
+ default: 'https://github.com/microsoft/document-generation-solution-accelerator'
+
+services:
+ webapp:
+ project: ./src
+ language: py
+ host: appservice
+ dist: ./dist
+ hooks:
+ prepackage:
+ windows:
+ shell: pwsh
+ run: ../infra/scripts/package_webapp.ps1
+ interactive: true
+ continueOnError: false
+ posix:
+ shell: sh
+ run: bash ../infra/scripts/package_webapp.sh
+ interactive: true
+ continueOnError: false
+
+deployment:
+ mode: Incremental
+ template: ./infra/main.bicep # Path to the main.bicep file inside the 'deployment' folder
+ parameters:
+ solutionPrefix: ${parameters.solutionPrefix}
+ otherLocation: ${parameters.otherLocation}
+ baseUrl: ${parameters.baseUrl}
diff --git a/docs/ACRBuildAndPushGuide.md b/archive-doc-gen/docs/ACRBuildAndPushGuide.md
similarity index 100%
rename from docs/ACRBuildAndPushGuide.md
rename to archive-doc-gen/docs/ACRBuildAndPushGuide.md
diff --git a/docs/AppAuthentication.md b/archive-doc-gen/docs/AppAuthentication.md
similarity index 100%
rename from docs/AppAuthentication.md
rename to archive-doc-gen/docs/AppAuthentication.md
diff --git a/docs/AzureAccountSetUp.md b/archive-doc-gen/docs/AzureAccountSetUp.md
similarity index 100%
rename from docs/AzureAccountSetUp.md
rename to archive-doc-gen/docs/AzureAccountSetUp.md
diff --git a/docs/AzureGPTQuotaSettings.md b/archive-doc-gen/docs/AzureGPTQuotaSettings.md
similarity index 100%
rename from docs/AzureGPTQuotaSettings.md
rename to archive-doc-gen/docs/AzureGPTQuotaSettings.md
diff --git a/docs/AzureSemanticSearchRegion.md b/archive-doc-gen/docs/AzureSemanticSearchRegion.md
similarity index 100%
rename from docs/AzureSemanticSearchRegion.md
rename to archive-doc-gen/docs/AzureSemanticSearchRegion.md
diff --git a/docs/CustomizingAzdParameters.md b/archive-doc-gen/docs/CustomizingAzdParameters.md
similarity index 100%
rename from docs/CustomizingAzdParameters.md
rename to archive-doc-gen/docs/CustomizingAzdParameters.md
diff --git a/docs/DeleteResourceGroup.md b/archive-doc-gen/docs/DeleteResourceGroup.md
similarity index 100%
rename from docs/DeleteResourceGroup.md
rename to archive-doc-gen/docs/DeleteResourceGroup.md
diff --git a/docs/DeploymentGuide.md b/archive-doc-gen/docs/DeploymentGuide.md
similarity index 96%
rename from docs/DeploymentGuide.md
rename to archive-doc-gen/docs/DeploymentGuide.md
index e04307df4..a6b4c2789 100644
--- a/docs/DeploymentGuide.md
+++ b/archive-doc-gen/docs/DeploymentGuide.md
@@ -117,7 +117,7 @@ Select one of the following options to deploy the Document Generation Solution A
Option C: Visual Studio Code Web
- [&message=Open&color=blue&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/azure/?vscode-azure-exp=foundry&agentPayload=eyJiYXNlVXJsIjogImh0dHBzOi8vcmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbS9taWNyb3NvZnQvZG9jdW1lbnQtZ2VuZXJhdGlvbi1zb2x1dGlvbi1hY2NlbGVyYXRvci9tYWluL2luZnJhL3ZzY29kZV93ZWIiLCAiaW5kZXhVcmwiOiAiL2luZGV4Lmpzb24iLCAidmFyaWFibGVzIjogeyJhZ2VudElkIjogIiIsICJjb25uZWN0aW9uU3RyaW5nIjogIiIsICJ0aHJlYWRJZCI6ICIiLCAidXNlck1lc3NhZ2UiOiAiIiwgInBsYXlncm91bmROYW1lIjogIiIsICJsb2NhdGlvbiI6ICIiLCAic3Vic2NyaXB0aW9uSWQiOiAiIiwgInJlc291cmNlSWQiOiAiIiwgInByb2plY3RSZXNvdXJjZUlkIjogIiIsICJlbmRwb2ludCI6ICIifSwgImNvZGVSb3V0ZSI6IFsiYWktcHJvamVjdHMtc2RrIiwgInB5dGhvbiIsICJkZWZhdWx0LWF6dXJlLWF1dGgiLCAiZW5kcG9pbnQiXX0=)
+ [&message=Open&color=blue&logo=visualstudiocode&logoColor=white)](https://vscode.dev/azure/?vscode-azure-exp=foundry&agentPayload=eyJiYXNlVXJsIjogImh0dHBzOi8vcmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbS9taWNyb3NvZnQvZG9jdW1lbnQtZ2VuZXJhdGlvbi1zb2x1dGlvbi1hY2NlbGVyYXRvci9yZWZzL2hlYWRzL21haW4vaW5mcmEvdnNjb2RlX3dlYiIsICJpbmRleFVybCI6ICIvaW5kZXguanNvbiIsICJ2YXJpYWJsZXMiOiB7ImFnZW50SWQiOiAiIiwgImNvbm5lY3Rpb25TdHJpbmciOiAiIiwgInRocmVhZElkIjogIiIsICJ1c2VyTWVzc2FnZSI6ICIiLCAicGxheWdyb3VuZE5hbWUiOiAiIiwgImxvY2F0aW9uIjogIiIsICJzdWJzY3JpcHRpb25JZCI6ICIiLCAicmVzb3VyY2VJZCI6ICIiLCAicHJvamVjdFJlc291cmNlSWQiOiAiIiwgImVuZHBvaW50IjogIiJ9LCAiY29kZVJvdXRlIjogWyJhaS1wcm9qZWN0cy1zZGsiLCAicHl0aG9uIiwgImRlZmF1bHQtYXp1cmUtYXV0aCIsICJlbmRwb2ludCJdfQ==)
1. Click the badge above (may take a few minutes to load)
2. Sign in with your Azure account when prompted
diff --git a/archive-doc-gen/docs/LocalDevelopmentSetup.md b/archive-doc-gen/docs/LocalDevelopmentSetup.md
new file mode 100644
index 000000000..4635b89e8
--- /dev/null
+++ b/archive-doc-gen/docs/LocalDevelopmentSetup.md
@@ -0,0 +1,506 @@
+# Local Development Setup Guide
+
+This guide provides comprehensive instructions for setting up the Document Generation Solution Accelerator for local development across Windows and Linux platforms.
+
+## Important Setup Notes
+
+### Multi-Service Architecture
+
+This application consists of **two separate services** that run independently:
+
+1. **Backend API** - REST API server for the frontend
+2. **Frontend** - React-based user interface
+
+> **⚠️ Critical: Each service must run in its own terminal/console window**
+>
+> - **Do NOT close terminals** while services are running
+> - Open **2 separate terminal windows** for local development
+> - Each service will occupy its terminal and show live logs
+
+
+### Path Conventions
+
+**All paths in this guide are relative to the repository root directory:**
+
+```bash
+document-generation-solution-accelerator/ ← Repository root (start here)
+├── src/
+│ ├── backend/
+│ │ ├── api/ ← API endpoints and routes
+│ │ ├── auth/ ← Authentication modules
+│ │ ├── helpers/ ← Utility and helper functions
+│ │ ├── history/ ← Chat/session history management
+│ │ ├── security/ ← Security-related modules
+│ │ └── settings.py ← Backend configuration
+│ ├── frontend/
+│ │ ├── src/ ← React/TypeScript source
+│ │ └── package.json ← Frontend dependencies
+│ ├── static/ ← Static web assets
+│ ├── tests/ ← Unit and integration tests
+│ ├── app.py ← Main Flask application entry point
+│ ├── .env ← Main application config file
+│ └── requirements.txt ← Python dependencies
+├── scripts/
+│ ├── prepdocs.py ← Document processing script
+│ ├── auth_init.py ← Authentication setup
+│ ├── data_preparation.py ← Data pipeline scripts
+│ └── config.json ← Scripts configuration
+├── infra/
+│ ├── main.bicep ← Main infrastructure template
+│ ├── scripts/ ← Infrastructure scripts
+│ └── main.parameters.json ← Deployment parameters
+├── docs/ ← Documentation (you are here)
+└── tests/ ← End-to-end tests
+ └── e2e-test/
+```
+
+**Before starting any step, ensure you are in the repository root directory:**
+
+```bash
+# Verify you're in the correct location
+pwd # Linux/macOS - should show: .../document-generation-solution-accelerator
+Get-Location # Windows PowerShell - should show: ...\document-generation-solution-accelerator
+
+# If not, navigate to repository root
+cd path/to/document-generation-solution-accelerator
+```
+
+## Step 1: Prerequisites - Install Required Tools
+
+Install these tools before you start:
+- [Visual Studio Code](https://code.visualstudio.com/) with the following extensions:
+ - [Azure Tools](https://marketplace.visualstudio.com/items?itemName=ms-vscode.vscode-node-azure-pack)
+ - [Bicep](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-bicep)
+ - [Python](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
+- [Python 3.11](https://www.python.org/downloads/). **Important:** Check "Add Python to PATH" during installation.
+- [PowerShell 7.0+](https://github.com/PowerShell/PowerShell#get-powershell).
+- [Node.js (LTS)](https://nodejs.org/en).
+- [Git](https://git-scm.com/downloads).
+- [Azure Developer CLI (azd) v1.18.0+](https://learn.microsoft.com/en-us/azure/developer/azure-developer-cli/install-azd).
+- [Microsoft ODBC Driver 17](https://learn.microsoft.com/en-us/sql/connect/odbc/download-odbc-driver-for-sql-server?view=sql-server-ver16) for SQL Server.
+
+
+### Windows Development
+
+#### Option 1: Native Windows (PowerShell)
+
+```powershell
+# Install Python 3.11+ and Git
+winget install Python.Python.3.11
+winget install Git.Git
+
+# Install Node.js for frontend
+winget install OpenJS.NodeJS.LTS
+
+# Install uv package manager
+py -3.11 -m pip install uv
+```
+
+**Note**: On Windows, use `py -3.11 -m uv` instead of `uv` for all commands to ensure you're using Python 3.11.
+
+#### Option 2: Windows with WSL2 (Recommended)
+
+```bash
+# Install WSL2 first (run in PowerShell as Administrator):
+# wsl --install -d Ubuntu
+
+# Then in WSL2 Ubuntu terminal:
+sudo apt update && sudo apt install python3.11 python3.11-venv git curl nodejs npm -y
+
+# Install uv
+curl -LsSf https://astral.sh/uv/install.sh | sh
+source ~/.bashrc
+```
+
+### Linux Development
+
+#### Ubuntu/Debian
+
+```bash
+# Install prerequisites
+sudo apt update && sudo apt install python3.11 python3.11-venv git curl nodejs npm -y
+
+# Install uv package manager
+curl -LsSf https://astral.sh/uv/install.sh | sh
+source ~/.bashrc
+```
+
+#### RHEL/CentOS/Fedora
+
+```bash
+# Install prerequisites
+sudo dnf install python3.11 python3.11-devel git curl gcc nodejs npm -y
+
+# Install uv
+curl -LsSf https://astral.sh/uv/install.sh | sh
+source ~/.bashrc
+```
+
+
+## Step 2: Clone the Repository
+
+Choose a location on your local machine where you want to store the project files. We recommend creating a dedicated folder for your development projects.
+
+#### Using Command Line/Terminal
+
+1. **Open your terminal or command prompt. Navigate to your desired directory and Clone the repository:**
+ ```bash
+ git clone https://github.com/microsoft/document-generation-solution-accelerator.git
+ ```
+
+2. **Navigate to the project directory:**
+ ```bash
+ cd document-generation-solution-accelerator
+ ```
+
+3. **Open the project in Visual Studio Code:**
+ ```bash
+ code .
+ ```
+
+
+## Step 3: Development Tools Setup
+
+### Visual Studio Code (Recommended)
+
+#### Required Extensions
+
+Create `.vscode/extensions.json` in the workspace root and copy the following JSON:
+
+```json
+{
+ "recommendations": [
+ "ms-python.python",
+ "ms-python.pylint",
+ "ms-python.black-formatter",
+ "ms-python.isort",
+ "ms-vscode-remote.remote-wsl",
+ "ms-vscode-remote.remote-containers",
+ "redhat.vscode-yaml",
+ "ms-vscode.azure-account",
+ "ms-python.mypy-type-checker"
+ ]
+}
+```
+
+VS Code will prompt you to install these recommended extensions when you open the workspace.
+
+#### Settings Configuration
+
+Create `.vscode/settings.json` and copy the following JSON:
+
+```json
+{
+ "python.defaultInterpreterPath": "./.venv/bin/python",
+ "python.terminal.activateEnvironment": true,
+ "python.formatting.provider": "black",
+ "python.linting.enabled": true,
+ "python.linting.pylintEnabled": true,
+ "python.testing.pytestEnabled": true,
+ "python.testing.unittestEnabled": false,
+ "files.associations": {
+ "*.yaml": "yaml",
+ "*.yml": "yaml"
+ }
+}
+```
+
+## Step 4: Azure Authentication Setup
+
+Before configuring services, authenticate with Azure:
+
+```bash
+# Login to Azure CLI
+az login
+
+# Set your subscription
+az account set --subscription "your-subscription-id"
+
+# Verify authentication
+az account show
+```
+
+## Step 5: Local Setup/Deployment
+
+Follow these steps to set up and run the application locally:
+
+## Local Deployment:
+
+You can refer the local deployment guide here: [Local Deployment Guide](https://github.com/microsoft/document-generation-solution-accelerator/blob/main/docs/DeploymentGuide.md)
+
+### 5.1. Open the App Folder
+Navigate to the `src` directory of the repository using Visual Studio Code.
+
+### 5.2. Configure Environment Variables
+- Copy the `.env.sample` file to a new file named `.env`.
+- Update the `.env` file with the required values from your Azure resource group in Azure Portal App Service environment variables.
+- You can get all env value in your deployed resource group under App Service:
+
+- Alternatively, if resources were
+provisioned using `azd provision` or `azd up`, a `.env` file is automatically generated in the `.azure//.env`
+file. To get your `` run `azd env list` to see which env is default.
+
+> **Note**: After adding all environment variables to the .env file, update the value of **'APP_ENV'** from:
+```
+APP_ENV="Prod"
+```
+**to:**
+```
+APP_ENV="Dev"
+```
+
+This change is required for running the application in local development mode.
+
+
+### 5.3. Required Azure RBAC Permissions
+
+To run the application locally, your Azure account needs the following role assignments on the deployed resources:
+
+#### 5.3.1. App Configuration Access
+```bash
+# Get your principal ID
+PRINCIPAL_ID=$(az ad signed-in-user show --query id -o tsv)
+
+# Assign App Configuration Data Reader role
+az role assignment create \
+ --assignee $PRINCIPAL_ID \
+ --role "App Configuration Data Reader" \
+ --scope "/subscriptions//resourceGroups//providers/Microsoft.AppConfiguration/configurationStores/"
+```
+
+#### 5.3.2. Cosmos DB Access
+```bash
+# Assign Cosmos DB Built-in Data Contributor role
+az cosmosdb sql role assignment create \
+ --account-name \
+ --resource-group \
+ --role-definition-name "Cosmos DB Built-in Data Contributor" \
+ --principal-id $PRINCIPAL_ID \
+ --scope "/"
+```
+> **Note**: After local deployment is complete, you need to execute the post-deployment script so that all the required roles will be assigned automatically.
+
+### 5.4. Running with Automated Script
+
+For convenience, you can use the provided startup scripts that handle environment setup and start both services:
+
+**Windows:**
+```cmd
+cd src
+.\start.cmd
+```
+
+**macOS/Linux:**
+```bash
+cd src
+chmod +x start.sh
+./start.sh
+```
+### 5.5. Start the Application
+- Run `start.cmd` (Windows) or `start.sh` (Linux/Mac) to:
+ - Install backend dependencies.
+ - Install frontend dependencies.
+ - Build the frontend.
+ - Start the backend server.
+- Alternatively, you can run the backend in debug mode using the VS Code debug configuration defined in `.vscode/launch.json`.
+
+
+## Step 6: Running Backend and Frontend Separately
+
+> **📋 Terminal Reminder**: This section requires **two separate terminal windows** - one for the Backend API and one for the Frontend. Keep both terminals open while running. All commands assume you start from the **repository root directory**.
+
+### 6.1. Create Virtual Environment (Recommended)
+
+Open your terminal and navigate to the root folder of the project, then create the virtual environment:
+
+```bash
+# Navigate to the project root folder
+cd document-generation-solution-accelerator
+
+# Create virtual environment in the root folder
+python -m venv .venv
+
+# Activate virtual environment (Windows)
+.venv/Scripts/activate
+
+# Activate virtual environment (macOS/Linux)
+source .venv/bin/activate
+```
+
+> **Note**: After activation, you should see `(.venv)` in your terminal prompt indicating the virtual environment is active.
+
+### 6.2. Install Dependencies and Run
+
+To develop and run the backend API locally:
+
+```bash
+# Navigate to the API folder (while virtual environment is activated)
+cd src/
+
+# Upgrade pip
+python -m pip install --upgrade pip
+
+# Install Python dependencies
+pip install -r requirements.txt
+
+# Install Frontend Packages
+cd frontend
+
+npm install
+npm run build
+
+# Run the backend API (Windows)
+cd ..
+
+start http://127.0.0.1:50505
+call python -m uvicorn app:app --port 50505 --reload
+
+# Run the backend API (MacOs)
+cd ..
+
+open http://127.0.0.1:50505
+python -m uvicorn app:app --port 50505 --reload
+
+# Run the backend API (Linux)
+cd ..
+
+xdg-open http://127.0.0.1:50505
+python -m uvicorn app:app --port 50505 --reload
+
+```
+
+> **Note**: Make sure your virtual environment is activated before running these commands. You should see `(.venv)` in your terminal prompt when the virtual environment is active.
+
+The App will run on `http://127.0.0.1:50505/#/` by default.
+
+## Step 7: Verify All Services Are Running
+
+Before using the application, confirm all services are running correctly:
+
+### 7.1. Terminal Status Checklist
+
+| Terminal | Service | Command | Expected Output | URL |
+|----------|---------|---------|-----------------|-----|
+| **Terminal 1** | Backend API | `python -m uvicorn app:app --port 50505 --reload` | `INFO: Application startup complete` | http://127.0.0.1:50505 |
+| **Terminal 2** | Frontend (Dev) | `npm run dev` | `Local: http://localhost:5173/` | http://localhost:5173 |
+
+### 7.2. Quick Verification
+
+**1. Check Backend API:**
+```bash
+# In a new terminal
+curl http://127.0.0.1:50505/health
+# Expected: {"status":"healthy"} or similar JSON response
+```
+
+**2. Check Frontend:**
+- Open browser to http://127.0.0.1:50505 (production build) or http://localhost:5173 (dev server)
+- Should see the Document Generation UI
+- If authentication is configured, you'll be redirected to Azure AD login
+
+### 7.3. Common Issues
+
+**Service not starting?**
+- Ensure you're in the correct directory (`src/` for backend)
+- Verify virtual environment is activated (you should see `(.venv)` in prompt)
+- Check that port is not already in use (50505 for API, 5173 for frontend dev)
+- Review error messages in the terminal
+
+**Can't access services?**
+- Verify firewall isn't blocking ports 50505 or 5173
+- Try `http://localhost:port` instead of `http://127.0.0.1:port`
+- Ensure services show "startup complete" messages
+
+## Step 8: Next Steps
+
+Once all services are running (as confirmed in Step 7), you can:
+
+1. **Access the Application**: Open `http://127.0.0.1:50505` in your browser to explore the Document Generation UI
+2. **Explore Sample Questions**: Follow [SampleQuestions.md](SampleQuestions.md) for example prompts and use cases
+3. **Understand the Architecture**: Review the codebase starting with `src/backend/` directory
+
+## Troubleshooting
+
+### Common Issues
+
+#### Python Version Issues
+
+```bash
+# Check available Python versions
+python3 --version
+python3.11 --version
+
+# If python3.11 not found, install it:
+# Ubuntu: sudo apt install python3.11
+# macOS: brew install python@3.11
+# Windows: winget install Python.Python.3.11
+```
+
+#### Virtual Environment Issues
+
+```bash
+# Recreate virtual environment
+rm -rf .venv # Linux/macOS
+# or Remove-Item -Recurse .venv # Windows PowerShell
+
+uv venv .venv
+# Activate and reinstall
+source .venv/bin/activate # Linux/macOS
+# or .\.venv\Scripts\Activate.ps1 # Windows
+uv sync --python 3.11
+```
+
+#### Permission Issues (Linux/macOS)
+
+```bash
+# Fix ownership of files
+sudo chown -R $USER:$USER .
+
+# Fix uv permissions
+chmod +x ~/.local/bin/uv
+```
+
+#### Windows-Specific Issues
+
+```powershell
+# PowerShell execution policy
+Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
+
+# Long path support (Windows 10 1607+, run as Administrator)
+New-ItemProperty -Path "HKLM:\SYSTEM\CurrentControlSet\Control\FileSystem" -Name "LongPathsEnabled" -Value 1 -PropertyType DWORD -Force
+
+# SSL certificate issues
+python -m pip install uv
+```
+
+### Azure Authentication Issues
+
+```bash
+# Login to Azure CLI
+az login
+
+# Set subscription
+az account set --subscription "your-subscription-id"
+
+# Test authentication
+az account show
+```
+
+### Environment Variable Issues
+
+```bash
+# Check environment variables are loaded
+env | grep AZURE # Linux/macOS
+Get-ChildItem Env:AZURE* # Windows PowerShell
+
+# Validate .env file format
+cat .env | grep -v '^#' | grep '=' # Should show key=value pairs
+```
+
+## Related Documentation
+
+- [Deployment Guide](DeploymentGuide.md) - Instructions for production deployment.
+- [Delete Resource Group](DeleteResourceGroup.md) - Steps to safely delete the Azure resource group created for the solution.
+- [App Authentication Setup](AppAuthentication.md) - Guide to configure application authentication and add support for additional platforms.
+- [Powershell Setup](PowershellSetup.md) - Instructions for setting up PowerShell and required scripts.
+- [Quota Check](QuotaCheck.md) - Steps to verify Azure quotas and ensure required limits before deployment.
diff --git a/archive-doc-gen/docs/LogAnalyticsReplicationDisable.md b/archive-doc-gen/docs/LogAnalyticsReplicationDisable.md
new file mode 100644
index 000000000..f4379a84a
--- /dev/null
+++ b/archive-doc-gen/docs/LogAnalyticsReplicationDisable.md
@@ -0,0 +1,28 @@
+# 🛠 Handling Log Analytics Workspace Deletion with Replication Enabled
+
+If redundancy (replication) is enabled for your Log Analytics workspace, you must disable it before deleting the workspace or resource group. Otherwise, deletion will fail.
+
+## ✅ Steps to Disable Replication Before Deletion
+Run the following Azure CLI command. Note: This operation may take about 5 minutes to complete.
+
+```bash
+az resource update --ids "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{logAnalyticsName}" --set properties.replication.enabled=false
+```
+
+Replace:
+- `{subscriptionId}` → Your Azure subscription ID
+- `{resourceGroupName}` → The name of your resource group
+- `{logAnalyticsName}` → The name of your Log Analytics workspace
+
+Optional: Verify replication disabled (should output `false`):
+```bash
+az resource show --ids "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{logAnalyticsName}" --query properties.replication.enabled -o tsv
+```
+
+## ✅ After Disabling Replication
+You can safely delete:
+- The Log Analytics workspace (manual)
+- The resource group (manual), or
+- All provisioned resources via `azd down`
+
+Return to: [Deployment Guide](./DeploymentGuide.md)
diff --git a/docs/PowershellSetup.md b/archive-doc-gen/docs/PowershellSetup.md
similarity index 100%
rename from docs/PowershellSetup.md
rename to archive-doc-gen/docs/PowershellSetup.md
diff --git a/docs/QuotaCheck.md b/archive-doc-gen/docs/QuotaCheck.md
similarity index 100%
rename from docs/QuotaCheck.md
rename to archive-doc-gen/docs/QuotaCheck.md
diff --git a/docs/README_LOCAL.md b/archive-doc-gen/docs/README_LOCAL.md
similarity index 100%
rename from docs/README_LOCAL.md
rename to archive-doc-gen/docs/README_LOCAL.md
diff --git a/docs/SampleQuestions.md b/archive-doc-gen/docs/SampleQuestions.md
similarity index 100%
rename from docs/SampleQuestions.md
rename to archive-doc-gen/docs/SampleQuestions.md
diff --git a/docs/TRANSPARENCY_FAQ.md b/archive-doc-gen/docs/TRANSPARENCY_FAQ.md
similarity index 100%
rename from docs/TRANSPARENCY_FAQ.md
rename to archive-doc-gen/docs/TRANSPARENCY_FAQ.md
diff --git a/docs/TroubleShootingSteps.md b/archive-doc-gen/docs/TroubleShootingSteps.md
similarity index 100%
rename from docs/TroubleShootingSteps.md
rename to archive-doc-gen/docs/TroubleShootingSteps.md
diff --git a/docs/container_registry_migration.md b/archive-doc-gen/docs/container_registry_migration.md
similarity index 100%
rename from docs/container_registry_migration.md
rename to archive-doc-gen/docs/container_registry_migration.md
diff --git a/docs/create_new_app_registration.md b/archive-doc-gen/docs/create_new_app_registration.md
similarity index 100%
rename from docs/create_new_app_registration.md
rename to archive-doc-gen/docs/create_new_app_registration.md
diff --git a/docs/images/AddDetails.png b/archive-doc-gen/docs/images/AddDetails.png
similarity index 100%
rename from docs/images/AddDetails.png
rename to archive-doc-gen/docs/images/AddDetails.png
diff --git a/docs/images/AddPlatform.png b/archive-doc-gen/docs/images/AddPlatform.png
similarity index 100%
rename from docs/images/AddPlatform.png
rename to archive-doc-gen/docs/images/AddPlatform.png
diff --git a/docs/images/AddRedirectURL.png b/archive-doc-gen/docs/images/AddRedirectURL.png
similarity index 100%
rename from docs/images/AddRedirectURL.png
rename to archive-doc-gen/docs/images/AddRedirectURL.png
diff --git a/docs/images/AppAuthIdentityProvider.png b/archive-doc-gen/docs/images/AppAuthIdentityProvider.png
similarity index 100%
rename from docs/images/AppAuthIdentityProvider.png
rename to archive-doc-gen/docs/images/AppAuthIdentityProvider.png
diff --git a/docs/images/AppAuthIdentityProviderAdd.png b/archive-doc-gen/docs/images/AppAuthIdentityProviderAdd.png
similarity index 100%
rename from docs/images/AppAuthIdentityProviderAdd.png
rename to archive-doc-gen/docs/images/AppAuthIdentityProviderAdd.png
diff --git a/docs/images/AppAuthIdentityProviderAdded.png b/archive-doc-gen/docs/images/AppAuthIdentityProviderAdded.png
similarity index 100%
rename from docs/images/AppAuthIdentityProviderAdded.png
rename to archive-doc-gen/docs/images/AppAuthIdentityProviderAdded.png
diff --git a/docs/images/AppAuthentication.png b/archive-doc-gen/docs/images/AppAuthentication.png
similarity index 100%
rename from docs/images/AppAuthentication.png
rename to archive-doc-gen/docs/images/AppAuthentication.png
diff --git a/docs/images/AppAuthenticationIdentity.png b/archive-doc-gen/docs/images/AppAuthenticationIdentity.png
similarity index 100%
rename from docs/images/AppAuthenticationIdentity.png
rename to archive-doc-gen/docs/images/AppAuthenticationIdentity.png
diff --git a/docs/images/AppServiceContainer.png b/archive-doc-gen/docs/images/AppServiceContainer.png
similarity index 100%
rename from docs/images/AppServiceContainer.png
rename to archive-doc-gen/docs/images/AppServiceContainer.png
diff --git a/docs/images/Appregistrations.png b/archive-doc-gen/docs/images/Appregistrations.png
similarity index 100%
rename from docs/images/Appregistrations.png
rename to archive-doc-gen/docs/images/Appregistrations.png
diff --git a/docs/images/Archimage.png b/archive-doc-gen/docs/images/Archimage.png
similarity index 100%
rename from docs/images/Archimage.png
rename to archive-doc-gen/docs/images/Archimage.png
diff --git a/docs/images/AzureHomePage.png b/archive-doc-gen/docs/images/AzureHomePage.png
similarity index 100%
rename from docs/images/AzureHomePage.png
rename to archive-doc-gen/docs/images/AzureHomePage.png
diff --git a/docs/images/ContainerApp.png b/archive-doc-gen/docs/images/ContainerApp.png
similarity index 100%
rename from docs/images/ContainerApp.png
rename to archive-doc-gen/docs/images/ContainerApp.png
diff --git a/docs/images/DeleteRG.png b/archive-doc-gen/docs/images/DeleteRG.png
similarity index 100%
rename from docs/images/DeleteRG.png
rename to archive-doc-gen/docs/images/DeleteRG.png
diff --git a/docs/images/DocGen_Azure_AI_Foundry_Architecture.png b/archive-doc-gen/docs/images/DocGen_Azure_AI_Foundry_Architecture.png
similarity index 100%
rename from docs/images/DocGen_Azure_AI_Foundry_Architecture.png
rename to archive-doc-gen/docs/images/DocGen_Azure_AI_Foundry_Architecture.png
diff --git a/archive-doc-gen/docs/images/Enviorment_variables.png b/archive-doc-gen/docs/images/Enviorment_variables.png
new file mode 100644
index 000000000..f5539fb1d
Binary files /dev/null and b/archive-doc-gen/docs/images/Enviorment_variables.png differ
diff --git a/docs/images/GenerateDraft.png b/archive-doc-gen/docs/images/GenerateDraft.png
similarity index 100%
rename from docs/images/GenerateDraft.png
rename to archive-doc-gen/docs/images/GenerateDraft.png
diff --git a/docs/images/MicrosoftEntraID.png b/archive-doc-gen/docs/images/MicrosoftEntraID.png
similarity index 100%
rename from docs/images/MicrosoftEntraID.png
rename to archive-doc-gen/docs/images/MicrosoftEntraID.png
diff --git a/docs/images/NewRegistration.png b/archive-doc-gen/docs/images/NewRegistration.png
similarity index 100%
rename from docs/images/NewRegistration.png
rename to archive-doc-gen/docs/images/NewRegistration.png
diff --git a/docs/images/Web.png b/archive-doc-gen/docs/images/Web.png
similarity index 100%
rename from docs/images/Web.png
rename to archive-doc-gen/docs/images/Web.png
diff --git a/docs/images/WebAppURL.png b/archive-doc-gen/docs/images/WebAppURL.png
similarity index 100%
rename from docs/images/WebAppURL.png
rename to archive-doc-gen/docs/images/WebAppURL.png
diff --git a/docs/images/architecture.png b/archive-doc-gen/docs/images/architecture.png
similarity index 100%
rename from docs/images/architecture.png
rename to archive-doc-gen/docs/images/architecture.png
diff --git a/docs/images/customerTruth.png b/archive-doc-gen/docs/images/customerTruth.png
similarity index 100%
rename from docs/images/customerTruth.png
rename to archive-doc-gen/docs/images/customerTruth.png
diff --git a/docs/images/deleteservices.png b/archive-doc-gen/docs/images/deleteservices.png
similarity index 100%
rename from docs/images/deleteservices.png
rename to archive-doc-gen/docs/images/deleteservices.png
diff --git a/docs/images/deployment_center.png b/archive-doc-gen/docs/images/deployment_center.png
similarity index 100%
rename from docs/images/deployment_center.png
rename to archive-doc-gen/docs/images/deployment_center.png
diff --git a/docs/images/git_bash.png b/archive-doc-gen/docs/images/git_bash.png
similarity index 100%
rename from docs/images/git_bash.png
rename to archive-doc-gen/docs/images/git_bash.png
diff --git a/docs/images/keyfeatures.png b/archive-doc-gen/docs/images/keyfeatures.png
similarity index 100%
rename from docs/images/keyfeatures.png
rename to archive-doc-gen/docs/images/keyfeatures.png
diff --git a/docs/images/landing_page.png b/archive-doc-gen/docs/images/landing_page.png
similarity index 100%
rename from docs/images/landing_page.png
rename to archive-doc-gen/docs/images/landing_page.png
diff --git a/docs/images/logAnalytics.png b/archive-doc-gen/docs/images/logAnalytics.png
similarity index 100%
rename from docs/images/logAnalytics.png
rename to archive-doc-gen/docs/images/logAnalytics.png
diff --git a/docs/images/logAnalyticsJson.png b/archive-doc-gen/docs/images/logAnalyticsJson.png
similarity index 100%
rename from docs/images/logAnalyticsJson.png
rename to archive-doc-gen/docs/images/logAnalyticsJson.png
diff --git a/docs/images/logAnalyticsList.png b/archive-doc-gen/docs/images/logAnalyticsList.png
similarity index 100%
rename from docs/images/logAnalyticsList.png
rename to archive-doc-gen/docs/images/logAnalyticsList.png
diff --git a/docs/images/oneClickDeploy.png b/archive-doc-gen/docs/images/oneClickDeploy.png
similarity index 100%
rename from docs/images/oneClickDeploy.png
rename to archive-doc-gen/docs/images/oneClickDeploy.png
diff --git a/docs/images/quota-check-output.png b/archive-doc-gen/docs/images/quota-check-output.png
similarity index 100%
rename from docs/images/quota-check-output.png
rename to archive-doc-gen/docs/images/quota-check-output.png
diff --git a/docs/images/re_use_foundry_project/azure_ai_foundry_list.png b/archive-doc-gen/docs/images/re_use_foundry_project/azure_ai_foundry_list.png
similarity index 100%
rename from docs/images/re_use_foundry_project/azure_ai_foundry_list.png
rename to archive-doc-gen/docs/images/re_use_foundry_project/azure_ai_foundry_list.png
diff --git a/docs/images/re_use_foundry_project/navigate_to_projects.png b/archive-doc-gen/docs/images/re_use_foundry_project/navigate_to_projects.png
similarity index 100%
rename from docs/images/re_use_foundry_project/navigate_to_projects.png
rename to archive-doc-gen/docs/images/re_use_foundry_project/navigate_to_projects.png
diff --git a/docs/images/re_use_foundry_project/project_resource_id.png b/archive-doc-gen/docs/images/re_use_foundry_project/project_resource_id.png
similarity index 100%
rename from docs/images/re_use_foundry_project/project_resource_id.png
rename to archive-doc-gen/docs/images/re_use_foundry_project/project_resource_id.png
diff --git a/docs/images/re_use_log/logAnalytics.png b/archive-doc-gen/docs/images/re_use_log/logAnalytics.png
similarity index 100%
rename from docs/images/re_use_log/logAnalytics.png
rename to archive-doc-gen/docs/images/re_use_log/logAnalytics.png
diff --git a/docs/images/re_use_log/logAnalyticsJson.png b/archive-doc-gen/docs/images/re_use_log/logAnalyticsJson.png
similarity index 100%
rename from docs/images/re_use_log/logAnalyticsJson.png
rename to archive-doc-gen/docs/images/re_use_log/logAnalyticsJson.png
diff --git a/docs/images/re_use_log/logAnalyticsList.png b/archive-doc-gen/docs/images/re_use_log/logAnalyticsList.png
similarity index 100%
rename from docs/images/re_use_log/logAnalyticsList.png
rename to archive-doc-gen/docs/images/re_use_log/logAnalyticsList.png
diff --git a/docs/images/readme/business-scenario.png b/archive-doc-gen/docs/images/readme/business-scenario.png
similarity index 100%
rename from docs/images/readme/business-scenario.png
rename to archive-doc-gen/docs/images/readme/business-scenario.png
diff --git a/docs/images/readme/quick-deploy.png b/archive-doc-gen/docs/images/readme/quick-deploy.png
similarity index 100%
rename from docs/images/readme/quick-deploy.png
rename to archive-doc-gen/docs/images/readme/quick-deploy.png
diff --git a/docs/images/readme/solution-overview.png b/archive-doc-gen/docs/images/readme/solution-overview.png
similarity index 100%
rename from docs/images/readme/solution-overview.png
rename to archive-doc-gen/docs/images/readme/solution-overview.png
diff --git a/docs/images/readme/supporting-documentation.png b/archive-doc-gen/docs/images/readme/supporting-documentation.png
similarity index 100%
rename from docs/images/readme/supporting-documentation.png
rename to archive-doc-gen/docs/images/readme/supporting-documentation.png
diff --git a/docs/images/resource-groups.png b/archive-doc-gen/docs/images/resource-groups.png
similarity index 100%
rename from docs/images/resource-groups.png
rename to archive-doc-gen/docs/images/resource-groups.png
diff --git a/docs/images/resource_menu.png b/archive-doc-gen/docs/images/resource_menu.png
similarity index 100%
rename from docs/images/resource_menu.png
rename to archive-doc-gen/docs/images/resource_menu.png
diff --git a/docs/images/resourcegroup.png b/archive-doc-gen/docs/images/resourcegroup.png
similarity index 100%
rename from docs/images/resourcegroup.png
rename to archive-doc-gen/docs/images/resourcegroup.png
diff --git a/docs/images/resourcegroup1.png b/archive-doc-gen/docs/images/resourcegroup1.png
similarity index 100%
rename from docs/images/resourcegroup1.png
rename to archive-doc-gen/docs/images/resourcegroup1.png
diff --git a/docs/images/supportingDocuments.png b/archive-doc-gen/docs/images/supportingDocuments.png
similarity index 100%
rename from docs/images/supportingDocuments.png
rename to archive-doc-gen/docs/images/supportingDocuments.png
diff --git a/docs/images/userStory.png b/archive-doc-gen/docs/images/userStory.png
similarity index 100%
rename from docs/images/userStory.png
rename to archive-doc-gen/docs/images/userStory.png
diff --git a/docs/re-use-foundry-project.md b/archive-doc-gen/docs/re-use-foundry-project.md
similarity index 100%
rename from docs/re-use-foundry-project.md
rename to archive-doc-gen/docs/re-use-foundry-project.md
diff --git a/docs/re-use-log-analytics.md b/archive-doc-gen/docs/re-use-log-analytics.md
similarity index 100%
rename from docs/re-use-log-analytics.md
rename to archive-doc-gen/docs/re-use-log-analytics.md
diff --git a/infra/data/pdfdata.zip b/archive-doc-gen/infra/data/pdfdata.zip
similarity index 100%
rename from infra/data/pdfdata.zip
rename to archive-doc-gen/infra/data/pdfdata.zip
diff --git a/infra/main.bicep b/archive-doc-gen/infra/main.bicep
similarity index 100%
rename from infra/main.bicep
rename to archive-doc-gen/infra/main.bicep
diff --git a/infra/main.json b/archive-doc-gen/infra/main.json
similarity index 100%
rename from infra/main.json
rename to archive-doc-gen/infra/main.json
diff --git a/infra/main.parameters.json b/archive-doc-gen/infra/main.parameters.json
similarity index 100%
rename from infra/main.parameters.json
rename to archive-doc-gen/infra/main.parameters.json
diff --git a/infra/main.waf.parameters.json b/archive-doc-gen/infra/main.waf.parameters.json
similarity index 100%
rename from infra/main.waf.parameters.json
rename to archive-doc-gen/infra/main.waf.parameters.json
diff --git a/infra/main_custom.bicep b/archive-doc-gen/infra/main_custom.bicep
similarity index 100%
rename from infra/main_custom.bicep
rename to archive-doc-gen/infra/main_custom.bicep
diff --git a/infra/modules/ai-project.bicep b/archive-doc-gen/infra/modules/ai-project.bicep
similarity index 100%
rename from infra/modules/ai-project.bicep
rename to archive-doc-gen/infra/modules/ai-project.bicep
diff --git a/infra/modules/ai-services-deployments.bicep b/archive-doc-gen/infra/modules/ai-services-deployments.bicep
similarity index 100%
rename from infra/modules/ai-services-deployments.bicep
rename to archive-doc-gen/infra/modules/ai-services-deployments.bicep
diff --git a/infra/modules/deploy_aifp_aisearch_connection.bicep b/archive-doc-gen/infra/modules/deploy_aifp_aisearch_connection.bicep
similarity index 100%
rename from infra/modules/deploy_aifp_aisearch_connection.bicep
rename to archive-doc-gen/infra/modules/deploy_aifp_aisearch_connection.bicep
diff --git a/infra/modules/role-assignment.bicep b/archive-doc-gen/infra/modules/role-assignment.bicep
similarity index 100%
rename from infra/modules/role-assignment.bicep
rename to archive-doc-gen/infra/modules/role-assignment.bicep
diff --git a/infra/modules/virtualNetwork.bicep b/archive-doc-gen/infra/modules/virtualNetwork.bicep
similarity index 100%
rename from infra/modules/virtualNetwork.bicep
rename to archive-doc-gen/infra/modules/virtualNetwork.bicep
diff --git a/infra/modules/web-sites.bicep b/archive-doc-gen/infra/modules/web-sites.bicep
similarity index 100%
rename from infra/modules/web-sites.bicep
rename to archive-doc-gen/infra/modules/web-sites.bicep
diff --git a/infra/modules/web-sites.config.bicep b/archive-doc-gen/infra/modules/web-sites.config.bicep
similarity index 100%
rename from infra/modules/web-sites.config.bicep
rename to archive-doc-gen/infra/modules/web-sites.config.bicep
diff --git a/infra/scripts/add_cosmosdb_access.sh b/archive-doc-gen/infra/scripts/add_cosmosdb_access.sh
similarity index 100%
rename from infra/scripts/add_cosmosdb_access.sh
rename to archive-doc-gen/infra/scripts/add_cosmosdb_access.sh
diff --git a/infra/scripts/copy_kb_files.sh b/archive-doc-gen/infra/scripts/copy_kb_files.sh
similarity index 100%
rename from infra/scripts/copy_kb_files.sh
rename to archive-doc-gen/infra/scripts/copy_kb_files.sh
diff --git a/infra/scripts/index_scripts/01_create_search_index.py b/archive-doc-gen/infra/scripts/index_scripts/01_create_search_index.py
similarity index 100%
rename from infra/scripts/index_scripts/01_create_search_index.py
rename to archive-doc-gen/infra/scripts/index_scripts/01_create_search_index.py
diff --git a/infra/scripts/index_scripts/02_process_data.py b/archive-doc-gen/infra/scripts/index_scripts/02_process_data.py
similarity index 100%
rename from infra/scripts/index_scripts/02_process_data.py
rename to archive-doc-gen/infra/scripts/index_scripts/02_process_data.py
diff --git a/infra/scripts/index_scripts/requirements.txt b/archive-doc-gen/infra/scripts/index_scripts/requirements.txt
similarity index 100%
rename from infra/scripts/index_scripts/requirements.txt
rename to archive-doc-gen/infra/scripts/index_scripts/requirements.txt
diff --git a/infra/scripts/package_webapp.ps1 b/archive-doc-gen/infra/scripts/package_webapp.ps1
similarity index 100%
rename from infra/scripts/package_webapp.ps1
rename to archive-doc-gen/infra/scripts/package_webapp.ps1
diff --git a/infra/scripts/package_webapp.sh b/archive-doc-gen/infra/scripts/package_webapp.sh
similarity index 100%
rename from infra/scripts/package_webapp.sh
rename to archive-doc-gen/infra/scripts/package_webapp.sh
diff --git a/infra/scripts/process_sample_data.sh b/archive-doc-gen/infra/scripts/process_sample_data.sh
similarity index 100%
rename from infra/scripts/process_sample_data.sh
rename to archive-doc-gen/infra/scripts/process_sample_data.sh
diff --git a/infra/scripts/run_create_index_scripts.sh b/archive-doc-gen/infra/scripts/run_create_index_scripts.sh
similarity index 100%
rename from infra/scripts/run_create_index_scripts.sh
rename to archive-doc-gen/infra/scripts/run_create_index_scripts.sh
diff --git a/infra/vscode_web/.gitignore b/archive-doc-gen/infra/vscode_web/.gitignore
similarity index 100%
rename from infra/vscode_web/.gitignore
rename to archive-doc-gen/infra/vscode_web/.gitignore
diff --git a/infra/vscode_web/LICENSE b/archive-doc-gen/infra/vscode_web/LICENSE
similarity index 100%
rename from infra/vscode_web/LICENSE
rename to archive-doc-gen/infra/vscode_web/LICENSE
diff --git a/infra/vscode_web/README-noazd.md b/archive-doc-gen/infra/vscode_web/README-noazd.md
similarity index 100%
rename from infra/vscode_web/README-noazd.md
rename to archive-doc-gen/infra/vscode_web/README-noazd.md
diff --git a/infra/vscode_web/README.md b/archive-doc-gen/infra/vscode_web/README.md
similarity index 100%
rename from infra/vscode_web/README.md
rename to archive-doc-gen/infra/vscode_web/README.md
diff --git a/infra/vscode_web/codeSample.py b/archive-doc-gen/infra/vscode_web/codeSample.py
similarity index 100%
rename from infra/vscode_web/codeSample.py
rename to archive-doc-gen/infra/vscode_web/codeSample.py
diff --git a/infra/vscode_web/endpoint-requirements.txt b/archive-doc-gen/infra/vscode_web/endpoint-requirements.txt
similarity index 100%
rename from infra/vscode_web/endpoint-requirements.txt
rename to archive-doc-gen/infra/vscode_web/endpoint-requirements.txt
diff --git a/infra/vscode_web/endpointCodeSample.py b/archive-doc-gen/infra/vscode_web/endpointCodeSample.py
similarity index 100%
rename from infra/vscode_web/endpointCodeSample.py
rename to archive-doc-gen/infra/vscode_web/endpointCodeSample.py
diff --git a/infra/vscode_web/index.json b/archive-doc-gen/infra/vscode_web/index.json
similarity index 100%
rename from infra/vscode_web/index.json
rename to archive-doc-gen/infra/vscode_web/index.json
diff --git a/infra/vscode_web/install.sh b/archive-doc-gen/infra/vscode_web/install.sh
similarity index 100%
rename from infra/vscode_web/install.sh
rename to archive-doc-gen/infra/vscode_web/install.sh
diff --git a/infra/vscode_web/requirements.txt b/archive-doc-gen/infra/vscode_web/requirements.txt
similarity index 100%
rename from infra/vscode_web/requirements.txt
rename to archive-doc-gen/infra/vscode_web/requirements.txt
diff --git a/package-lock.json b/archive-doc-gen/package-lock.json
similarity index 100%
rename from package-lock.json
rename to archive-doc-gen/package-lock.json
diff --git a/scripts/SAMPLE_DATA.md b/archive-doc-gen/scripts/SAMPLE_DATA.md
similarity index 100%
rename from scripts/SAMPLE_DATA.md
rename to archive-doc-gen/scripts/SAMPLE_DATA.md
diff --git a/scripts/auth_init.ps1 b/archive-doc-gen/scripts/auth_init.ps1
similarity index 100%
rename from scripts/auth_init.ps1
rename to archive-doc-gen/scripts/auth_init.ps1
diff --git a/scripts/auth_init.py b/archive-doc-gen/scripts/auth_init.py
similarity index 100%
rename from scripts/auth_init.py
rename to archive-doc-gen/scripts/auth_init.py
diff --git a/scripts/auth_init.sh b/archive-doc-gen/scripts/auth_init.sh
similarity index 100%
rename from scripts/auth_init.sh
rename to archive-doc-gen/scripts/auth_init.sh
diff --git a/scripts/auth_update.ps1 b/archive-doc-gen/scripts/auth_update.ps1
similarity index 100%
rename from scripts/auth_update.ps1
rename to archive-doc-gen/scripts/auth_update.ps1
diff --git a/scripts/auth_update.py b/archive-doc-gen/scripts/auth_update.py
similarity index 100%
rename from scripts/auth_update.py
rename to archive-doc-gen/scripts/auth_update.py
diff --git a/scripts/auth_update.sh b/archive-doc-gen/scripts/auth_update.sh
similarity index 100%
rename from scripts/auth_update.sh
rename to archive-doc-gen/scripts/auth_update.sh
diff --git a/scripts/checkquota.sh b/archive-doc-gen/scripts/checkquota.sh
similarity index 100%
rename from scripts/checkquota.sh
rename to archive-doc-gen/scripts/checkquota.sh
diff --git a/scripts/chunk_documents.py b/archive-doc-gen/scripts/chunk_documents.py
similarity index 100%
rename from scripts/chunk_documents.py
rename to archive-doc-gen/scripts/chunk_documents.py
diff --git a/scripts/config.json b/archive-doc-gen/scripts/config.json
similarity index 100%
rename from scripts/config.json
rename to archive-doc-gen/scripts/config.json
diff --git a/scripts/data_preparation.py b/archive-doc-gen/scripts/data_preparation.py
similarity index 100%
rename from scripts/data_preparation.py
rename to archive-doc-gen/scripts/data_preparation.py
diff --git a/scripts/data_utils.py b/archive-doc-gen/scripts/data_utils.py
similarity index 100%
rename from scripts/data_utils.py
rename to archive-doc-gen/scripts/data_utils.py
diff --git a/scripts/embed_documents.py b/archive-doc-gen/scripts/embed_documents.py
similarity index 100%
rename from scripts/embed_documents.py
rename to archive-doc-gen/scripts/embed_documents.py
diff --git a/scripts/loadenv.ps1 b/archive-doc-gen/scripts/loadenv.ps1
similarity index 100%
rename from scripts/loadenv.ps1
rename to archive-doc-gen/scripts/loadenv.ps1
diff --git a/scripts/loadenv.sh b/archive-doc-gen/scripts/loadenv.sh
similarity index 100%
rename from scripts/loadenv.sh
rename to archive-doc-gen/scripts/loadenv.sh
diff --git a/scripts/prepdocs.ps1 b/archive-doc-gen/scripts/prepdocs.ps1
similarity index 100%
rename from scripts/prepdocs.ps1
rename to archive-doc-gen/scripts/prepdocs.ps1
diff --git a/scripts/prepdocs.py b/archive-doc-gen/scripts/prepdocs.py
similarity index 100%
rename from scripts/prepdocs.py
rename to archive-doc-gen/scripts/prepdocs.py
diff --git a/scripts/prepdocs.sh b/archive-doc-gen/scripts/prepdocs.sh
similarity index 100%
rename from scripts/prepdocs.sh
rename to archive-doc-gen/scripts/prepdocs.sh
diff --git a/scripts/quota_check_params.sh b/archive-doc-gen/scripts/quota_check_params.sh
similarity index 100%
rename from scripts/quota_check_params.sh
rename to archive-doc-gen/scripts/quota_check_params.sh
diff --git a/scripts/readme.md b/archive-doc-gen/scripts/readme.md
similarity index 100%
rename from scripts/readme.md
rename to archive-doc-gen/scripts/readme.md
diff --git a/scripts/role_assignment.sh b/archive-doc-gen/scripts/role_assignment.sh
similarity index 100%
rename from scripts/role_assignment.sh
rename to archive-doc-gen/scripts/role_assignment.sh
diff --git a/src/.dockerignore b/archive-doc-gen/src/.dockerignore
similarity index 100%
rename from src/.dockerignore
rename to archive-doc-gen/src/.dockerignore
diff --git a/src/.env.sample b/archive-doc-gen/src/.env.sample
similarity index 100%
rename from src/.env.sample
rename to archive-doc-gen/src/.env.sample
diff --git a/src/.gitignore b/archive-doc-gen/src/.gitignore
similarity index 100%
rename from src/.gitignore
rename to archive-doc-gen/src/.gitignore
diff --git a/src/SUPPORT.md b/archive-doc-gen/src/SUPPORT.md
similarity index 100%
rename from src/SUPPORT.md
rename to archive-doc-gen/src/SUPPORT.md
diff --git a/src/TEST_CASE_FLOWS.md b/archive-doc-gen/src/TEST_CASE_FLOWS.md
similarity index 100%
rename from src/TEST_CASE_FLOWS.md
rename to archive-doc-gen/src/TEST_CASE_FLOWS.md
diff --git a/src/WebApp.Dockerfile b/archive-doc-gen/src/WebApp.Dockerfile
similarity index 100%
rename from src/WebApp.Dockerfile
rename to archive-doc-gen/src/WebApp.Dockerfile
diff --git a/src/app.py b/archive-doc-gen/src/app.py
similarity index 100%
rename from src/app.py
rename to archive-doc-gen/src/app.py
diff --git a/src/backend/__init__.py b/archive-doc-gen/src/backend/__init__.py
similarity index 100%
rename from src/backend/__init__.py
rename to archive-doc-gen/src/backend/__init__.py
diff --git a/src/backend/api/agent/agent_factory_base.py b/archive-doc-gen/src/backend/api/agent/agent_factory_base.py
similarity index 100%
rename from src/backend/api/agent/agent_factory_base.py
rename to archive-doc-gen/src/backend/api/agent/agent_factory_base.py
diff --git a/src/backend/api/agent/browse_agent_factory.py b/archive-doc-gen/src/backend/api/agent/browse_agent_factory.py
similarity index 100%
rename from src/backend/api/agent/browse_agent_factory.py
rename to archive-doc-gen/src/backend/api/agent/browse_agent_factory.py
diff --git a/src/backend/api/agent/section_agent_factory.py b/archive-doc-gen/src/backend/api/agent/section_agent_factory.py
similarity index 100%
rename from src/backend/api/agent/section_agent_factory.py
rename to archive-doc-gen/src/backend/api/agent/section_agent_factory.py
diff --git a/src/backend/api/agent/template_agent_factory.py b/archive-doc-gen/src/backend/api/agent/template_agent_factory.py
similarity index 100%
rename from src/backend/api/agent/template_agent_factory.py
rename to archive-doc-gen/src/backend/api/agent/template_agent_factory.py
diff --git a/src/backend/auth/__init__.py b/archive-doc-gen/src/backend/auth/__init__.py
similarity index 100%
rename from src/backend/auth/__init__.py
rename to archive-doc-gen/src/backend/auth/__init__.py
diff --git a/src/backend/auth/auth_utils.py b/archive-doc-gen/src/backend/auth/auth_utils.py
similarity index 100%
rename from src/backend/auth/auth_utils.py
rename to archive-doc-gen/src/backend/auth/auth_utils.py
diff --git a/src/backend/auth/sample_user.py b/archive-doc-gen/src/backend/auth/sample_user.py
similarity index 100%
rename from src/backend/auth/sample_user.py
rename to archive-doc-gen/src/backend/auth/sample_user.py
diff --git a/src/backend/helpers/azure_credential_utils.py b/archive-doc-gen/src/backend/helpers/azure_credential_utils.py
similarity index 100%
rename from src/backend/helpers/azure_credential_utils.py
rename to archive-doc-gen/src/backend/helpers/azure_credential_utils.py
diff --git a/src/backend/history/cosmosdbservice.py b/archive-doc-gen/src/backend/history/cosmosdbservice.py
similarity index 100%
rename from src/backend/history/cosmosdbservice.py
rename to archive-doc-gen/src/backend/history/cosmosdbservice.py
diff --git a/src/backend/security/__init__.py b/archive-doc-gen/src/backend/security/__init__.py
similarity index 100%
rename from src/backend/security/__init__.py
rename to archive-doc-gen/src/backend/security/__init__.py
diff --git a/src/backend/security/ms_defender_utils.py b/archive-doc-gen/src/backend/security/ms_defender_utils.py
similarity index 100%
rename from src/backend/security/ms_defender_utils.py
rename to archive-doc-gen/src/backend/security/ms_defender_utils.py
diff --git a/src/backend/settings.py b/archive-doc-gen/src/backend/settings.py
similarity index 100%
rename from src/backend/settings.py
rename to archive-doc-gen/src/backend/settings.py
diff --git a/src/backend/utils.py b/archive-doc-gen/src/backend/utils.py
similarity index 100%
rename from src/backend/utils.py
rename to archive-doc-gen/src/backend/utils.py
diff --git a/src/event_utils.py b/archive-doc-gen/src/event_utils.py
similarity index 100%
rename from src/event_utils.py
rename to archive-doc-gen/src/event_utils.py
diff --git a/src/frontend/.eslintignore b/archive-doc-gen/src/frontend/.eslintignore
similarity index 100%
rename from src/frontend/.eslintignore
rename to archive-doc-gen/src/frontend/.eslintignore
diff --git a/src/frontend/.eslintrc.json b/archive-doc-gen/src/frontend/.eslintrc.json
similarity index 100%
rename from src/frontend/.eslintrc.json
rename to archive-doc-gen/src/frontend/.eslintrc.json
diff --git a/src/frontend/.prettierignore b/archive-doc-gen/src/frontend/.prettierignore
similarity index 100%
rename from src/frontend/.prettierignore
rename to archive-doc-gen/src/frontend/.prettierignore
diff --git a/src/frontend/.prettierrc.json b/archive-doc-gen/src/frontend/.prettierrc.json
similarity index 100%
rename from src/frontend/.prettierrc.json
rename to archive-doc-gen/src/frontend/.prettierrc.json
diff --git a/src/frontend/__mocks__/dompurify.ts b/archive-doc-gen/src/frontend/__mocks__/dompurify.ts
similarity index 100%
rename from src/frontend/__mocks__/dompurify.ts
rename to archive-doc-gen/src/frontend/__mocks__/dompurify.ts
diff --git a/src/frontend/__mocks__/fileMock.ts b/archive-doc-gen/src/frontend/__mocks__/fileMock.ts
similarity index 100%
rename from src/frontend/__mocks__/fileMock.ts
rename to archive-doc-gen/src/frontend/__mocks__/fileMock.ts
diff --git a/src/frontend/__mocks__/mockAPIData.ts b/archive-doc-gen/src/frontend/__mocks__/mockAPIData.ts
similarity index 100%
rename from src/frontend/__mocks__/mockAPIData.ts
rename to archive-doc-gen/src/frontend/__mocks__/mockAPIData.ts
diff --git a/src/frontend/__mocks__/react-markdown.tsx b/archive-doc-gen/src/frontend/__mocks__/react-markdown.tsx
similarity index 100%
rename from src/frontend/__mocks__/react-markdown.tsx
rename to archive-doc-gen/src/frontend/__mocks__/react-markdown.tsx
diff --git a/src/frontend/eslint.config.ts b/archive-doc-gen/src/frontend/eslint.config.ts
similarity index 100%
rename from src/frontend/eslint.config.ts
rename to archive-doc-gen/src/frontend/eslint.config.ts
diff --git a/src/frontend/index.html b/archive-doc-gen/src/frontend/index.html
similarity index 100%
rename from src/frontend/index.html
rename to archive-doc-gen/src/frontend/index.html
diff --git a/src/frontend/jest.config.ts b/archive-doc-gen/src/frontend/jest.config.ts
similarity index 100%
rename from src/frontend/jest.config.ts
rename to archive-doc-gen/src/frontend/jest.config.ts
diff --git a/src/frontend/jest.polyfills.js b/archive-doc-gen/src/frontend/jest.polyfills.js
similarity index 100%
rename from src/frontend/jest.polyfills.js
rename to archive-doc-gen/src/frontend/jest.polyfills.js
diff --git a/src/frontend/package-lock.json b/archive-doc-gen/src/frontend/package-lock.json
similarity index 100%
rename from src/frontend/package-lock.json
rename to archive-doc-gen/src/frontend/package-lock.json
diff --git a/src/frontend/package.json b/archive-doc-gen/src/frontend/package.json
similarity index 100%
rename from src/frontend/package.json
rename to archive-doc-gen/src/frontend/package.json
diff --git a/src/frontend/polyfills.js b/archive-doc-gen/src/frontend/polyfills.js
similarity index 100%
rename from src/frontend/polyfills.js
rename to archive-doc-gen/src/frontend/polyfills.js
diff --git a/src/frontend/public/favicon.ico b/archive-doc-gen/src/frontend/public/favicon.ico
similarity index 100%
rename from src/frontend/public/favicon.ico
rename to archive-doc-gen/src/frontend/public/favicon.ico
diff --git a/src/frontend/src/api/api.ts b/archive-doc-gen/src/frontend/src/api/api.ts
similarity index 100%
rename from src/frontend/src/api/api.ts
rename to archive-doc-gen/src/frontend/src/api/api.ts
diff --git a/src/frontend/src/api/index.ts b/archive-doc-gen/src/frontend/src/api/index.ts
similarity index 100%
rename from src/frontend/src/api/index.ts
rename to archive-doc-gen/src/frontend/src/api/index.ts
diff --git a/src/frontend/src/api/models.ts b/archive-doc-gen/src/frontend/src/api/models.ts
similarity index 100%
rename from src/frontend/src/api/models.ts
rename to archive-doc-gen/src/frontend/src/api/models.ts
diff --git a/src/frontend/src/assets/Azure.svg b/archive-doc-gen/src/frontend/src/assets/Azure.svg
similarity index 100%
rename from src/frontend/src/assets/Azure.svg
rename to archive-doc-gen/src/frontend/src/assets/Azure.svg
diff --git a/src/frontend/src/assets/ClearChat.svg b/archive-doc-gen/src/frontend/src/assets/ClearChat.svg
similarity index 100%
rename from src/frontend/src/assets/ClearChat.svg
rename to archive-doc-gen/src/frontend/src/assets/ClearChat.svg
diff --git a/src/frontend/src/assets/Contoso.svg b/archive-doc-gen/src/frontend/src/assets/Contoso.svg
similarity index 100%
rename from src/frontend/src/assets/Contoso.svg
rename to archive-doc-gen/src/frontend/src/assets/Contoso.svg
diff --git a/src/frontend/src/assets/Generate.svg b/archive-doc-gen/src/frontend/src/assets/Generate.svg
similarity index 100%
rename from src/frontend/src/assets/Generate.svg
rename to archive-doc-gen/src/frontend/src/assets/Generate.svg
diff --git a/src/frontend/src/assets/Send.svg b/archive-doc-gen/src/frontend/src/assets/Send.svg
similarity index 100%
rename from src/frontend/src/assets/Send.svg
rename to archive-doc-gen/src/frontend/src/assets/Send.svg
diff --git a/src/frontend/src/components/Answer/Answer.module.css b/archive-doc-gen/src/frontend/src/components/Answer/Answer.module.css
similarity index 100%
rename from src/frontend/src/components/Answer/Answer.module.css
rename to archive-doc-gen/src/frontend/src/components/Answer/Answer.module.css
diff --git a/src/frontend/src/components/Answer/Answer.test.tsx b/archive-doc-gen/src/frontend/src/components/Answer/Answer.test.tsx
similarity index 100%
rename from src/frontend/src/components/Answer/Answer.test.tsx
rename to archive-doc-gen/src/frontend/src/components/Answer/Answer.test.tsx
diff --git a/src/frontend/src/components/Answer/Answer.tsx b/archive-doc-gen/src/frontend/src/components/Answer/Answer.tsx
similarity index 100%
rename from src/frontend/src/components/Answer/Answer.tsx
rename to archive-doc-gen/src/frontend/src/components/Answer/Answer.tsx
diff --git a/src/frontend/src/components/Answer/AnswerParser.test.ts b/archive-doc-gen/src/frontend/src/components/Answer/AnswerParser.test.ts
similarity index 100%
rename from src/frontend/src/components/Answer/AnswerParser.test.ts
rename to archive-doc-gen/src/frontend/src/components/Answer/AnswerParser.test.ts
diff --git a/src/frontend/src/components/Answer/AnswerParser.tsx b/archive-doc-gen/src/frontend/src/components/Answer/AnswerParser.tsx
similarity index 100%
rename from src/frontend/src/components/Answer/AnswerParser.tsx
rename to archive-doc-gen/src/frontend/src/components/Answer/AnswerParser.tsx
diff --git a/src/frontend/src/components/Answer/index.ts b/archive-doc-gen/src/frontend/src/components/Answer/index.ts
similarity index 100%
rename from src/frontend/src/components/Answer/index.ts
rename to archive-doc-gen/src/frontend/src/components/Answer/index.ts
diff --git a/src/frontend/src/components/ChatHistory/ChatHistoryList.test.tsx b/archive-doc-gen/src/frontend/src/components/ChatHistory/ChatHistoryList.test.tsx
similarity index 100%
rename from src/frontend/src/components/ChatHistory/ChatHistoryList.test.tsx
rename to archive-doc-gen/src/frontend/src/components/ChatHistory/ChatHistoryList.test.tsx
diff --git a/src/frontend/src/components/ChatHistory/ChatHistoryList.tsx b/archive-doc-gen/src/frontend/src/components/ChatHistory/ChatHistoryList.tsx
similarity index 100%
rename from src/frontend/src/components/ChatHistory/ChatHistoryList.tsx
rename to archive-doc-gen/src/frontend/src/components/ChatHistory/ChatHistoryList.tsx
diff --git a/src/frontend/src/components/ChatHistory/ChatHistoryListItem.tsx b/archive-doc-gen/src/frontend/src/components/ChatHistory/ChatHistoryListItem.tsx
similarity index 100%
rename from src/frontend/src/components/ChatHistory/ChatHistoryListItem.tsx
rename to archive-doc-gen/src/frontend/src/components/ChatHistory/ChatHistoryListItem.tsx
diff --git a/src/frontend/src/components/ChatHistory/ChatHistoryPanel.module.css b/archive-doc-gen/src/frontend/src/components/ChatHistory/ChatHistoryPanel.module.css
similarity index 100%
rename from src/frontend/src/components/ChatHistory/ChatHistoryPanel.module.css
rename to archive-doc-gen/src/frontend/src/components/ChatHistory/ChatHistoryPanel.module.css
diff --git a/src/frontend/src/components/ChatHistory/ChatHistoryPanel.test.tsx b/archive-doc-gen/src/frontend/src/components/ChatHistory/ChatHistoryPanel.test.tsx
similarity index 100%
rename from src/frontend/src/components/ChatHistory/ChatHistoryPanel.test.tsx
rename to archive-doc-gen/src/frontend/src/components/ChatHistory/ChatHistoryPanel.test.tsx
diff --git a/src/frontend/src/components/ChatHistory/ChatHistoryPanel.tsx b/archive-doc-gen/src/frontend/src/components/ChatHistory/ChatHistoryPanel.tsx
similarity index 100%
rename from src/frontend/src/components/ChatHistory/ChatHistoryPanel.tsx
rename to archive-doc-gen/src/frontend/src/components/ChatHistory/ChatHistoryPanel.tsx
diff --git a/src/frontend/src/components/ChatHistory/chatHistoryListItem.test.tsx b/archive-doc-gen/src/frontend/src/components/ChatHistory/chatHistoryListItem.test.tsx
similarity index 100%
rename from src/frontend/src/components/ChatHistory/chatHistoryListItem.test.tsx
rename to archive-doc-gen/src/frontend/src/components/ChatHistory/chatHistoryListItem.test.tsx
diff --git a/src/frontend/src/components/DraftCards/SectionCard.test.tsx b/archive-doc-gen/src/frontend/src/components/DraftCards/SectionCard.test.tsx
similarity index 100%
rename from src/frontend/src/components/DraftCards/SectionCard.test.tsx
rename to archive-doc-gen/src/frontend/src/components/DraftCards/SectionCard.test.tsx
diff --git a/src/frontend/src/components/DraftCards/SectionCard.tsx b/archive-doc-gen/src/frontend/src/components/DraftCards/SectionCard.tsx
similarity index 100%
rename from src/frontend/src/components/DraftCards/SectionCard.tsx
rename to archive-doc-gen/src/frontend/src/components/DraftCards/SectionCard.tsx
diff --git a/src/frontend/src/components/DraftCards/TitleCard.test.tsx b/archive-doc-gen/src/frontend/src/components/DraftCards/TitleCard.test.tsx
similarity index 100%
rename from src/frontend/src/components/DraftCards/TitleCard.test.tsx
rename to archive-doc-gen/src/frontend/src/components/DraftCards/TitleCard.test.tsx
diff --git a/src/frontend/src/components/DraftCards/TitleCard.tsx b/archive-doc-gen/src/frontend/src/components/DraftCards/TitleCard.tsx
similarity index 100%
rename from src/frontend/src/components/DraftCards/TitleCard.tsx
rename to archive-doc-gen/src/frontend/src/components/DraftCards/TitleCard.tsx
diff --git a/src/frontend/src/components/FeatureCard/FeatureCard.test.tsx b/archive-doc-gen/src/frontend/src/components/FeatureCard/FeatureCard.test.tsx
similarity index 100%
rename from src/frontend/src/components/FeatureCard/FeatureCard.test.tsx
rename to archive-doc-gen/src/frontend/src/components/FeatureCard/FeatureCard.test.tsx
diff --git a/src/frontend/src/components/FeatureCard/FeatureCard.tsx b/archive-doc-gen/src/frontend/src/components/FeatureCard/FeatureCard.tsx
similarity index 100%
rename from src/frontend/src/components/FeatureCard/FeatureCard.tsx
rename to archive-doc-gen/src/frontend/src/components/FeatureCard/FeatureCard.tsx
diff --git a/src/frontend/src/components/QuestionInput/QuestionInput.module.css b/archive-doc-gen/src/frontend/src/components/QuestionInput/QuestionInput.module.css
similarity index 100%
rename from src/frontend/src/components/QuestionInput/QuestionInput.module.css
rename to archive-doc-gen/src/frontend/src/components/QuestionInput/QuestionInput.module.css
diff --git a/src/frontend/src/components/QuestionInput/QuestionInput.test.tsx b/archive-doc-gen/src/frontend/src/components/QuestionInput/QuestionInput.test.tsx
similarity index 100%
rename from src/frontend/src/components/QuestionInput/QuestionInput.test.tsx
rename to archive-doc-gen/src/frontend/src/components/QuestionInput/QuestionInput.test.tsx
diff --git a/src/frontend/src/components/QuestionInput/QuestionInput.tsx b/archive-doc-gen/src/frontend/src/components/QuestionInput/QuestionInput.tsx
similarity index 100%
rename from src/frontend/src/components/QuestionInput/QuestionInput.tsx
rename to archive-doc-gen/src/frontend/src/components/QuestionInput/QuestionInput.tsx
diff --git a/src/frontend/src/components/QuestionInput/index.ts b/archive-doc-gen/src/frontend/src/components/QuestionInput/index.ts
similarity index 100%
rename from src/frontend/src/components/QuestionInput/index.ts
rename to archive-doc-gen/src/frontend/src/components/QuestionInput/index.ts
diff --git a/src/frontend/src/components/Sidebar/Sidebar.module.css b/archive-doc-gen/src/frontend/src/components/Sidebar/Sidebar.module.css
similarity index 100%
rename from src/frontend/src/components/Sidebar/Sidebar.module.css
rename to archive-doc-gen/src/frontend/src/components/Sidebar/Sidebar.module.css
diff --git a/src/frontend/src/components/Sidebar/Sidebar.test.tsx b/archive-doc-gen/src/frontend/src/components/Sidebar/Sidebar.test.tsx
similarity index 100%
rename from src/frontend/src/components/Sidebar/Sidebar.test.tsx
rename to archive-doc-gen/src/frontend/src/components/Sidebar/Sidebar.test.tsx
diff --git a/src/frontend/src/components/Sidebar/Sidebar.tsx b/archive-doc-gen/src/frontend/src/components/Sidebar/Sidebar.tsx
similarity index 100%
rename from src/frontend/src/components/Sidebar/Sidebar.tsx
rename to archive-doc-gen/src/frontend/src/components/Sidebar/Sidebar.tsx
diff --git a/src/frontend/src/components/common/Button.module.css b/archive-doc-gen/src/frontend/src/components/common/Button.module.css
similarity index 100%
rename from src/frontend/src/components/common/Button.module.css
rename to archive-doc-gen/src/frontend/src/components/common/Button.module.css
diff --git a/src/frontend/src/components/common/Button.test.tsx b/archive-doc-gen/src/frontend/src/components/common/Button.test.tsx
similarity index 100%
rename from src/frontend/src/components/common/Button.test.tsx
rename to archive-doc-gen/src/frontend/src/components/common/Button.test.tsx
diff --git a/src/frontend/src/components/common/Button.tsx b/archive-doc-gen/src/frontend/src/components/common/Button.tsx
similarity index 100%
rename from src/frontend/src/components/common/Button.tsx
rename to archive-doc-gen/src/frontend/src/components/common/Button.tsx
diff --git a/src/frontend/src/constants/chatHistory.test.tsx b/archive-doc-gen/src/frontend/src/constants/chatHistory.test.tsx
similarity index 100%
rename from src/frontend/src/constants/chatHistory.test.tsx
rename to archive-doc-gen/src/frontend/src/constants/chatHistory.test.tsx
diff --git a/src/frontend/src/constants/chatHistory.tsx b/archive-doc-gen/src/frontend/src/constants/chatHistory.tsx
similarity index 100%
rename from src/frontend/src/constants/chatHistory.tsx
rename to archive-doc-gen/src/frontend/src/constants/chatHistory.tsx
diff --git a/src/frontend/src/constants/xssAllowTags.ts b/archive-doc-gen/src/frontend/src/constants/xssAllowTags.ts
similarity index 100%
rename from src/frontend/src/constants/xssAllowTags.ts
rename to archive-doc-gen/src/frontend/src/constants/xssAllowTags.ts
diff --git a/src/frontend/src/helpers/helpers.ts b/archive-doc-gen/src/frontend/src/helpers/helpers.ts
similarity index 100%
rename from src/frontend/src/helpers/helpers.ts
rename to archive-doc-gen/src/frontend/src/helpers/helpers.ts
diff --git a/src/frontend/src/index.css b/archive-doc-gen/src/frontend/src/index.css
similarity index 100%
rename from src/frontend/src/index.css
rename to archive-doc-gen/src/frontend/src/index.css
diff --git a/src/frontend/src/index.tsx b/archive-doc-gen/src/frontend/src/index.tsx
similarity index 100%
rename from src/frontend/src/index.tsx
rename to archive-doc-gen/src/frontend/src/index.tsx
diff --git a/src/frontend/src/pages/NoPage.tsx b/archive-doc-gen/src/frontend/src/pages/NoPage.tsx
similarity index 100%
rename from src/frontend/src/pages/NoPage.tsx
rename to archive-doc-gen/src/frontend/src/pages/NoPage.tsx
diff --git a/src/frontend/src/pages/chat/Chat.module.css b/archive-doc-gen/src/frontend/src/pages/chat/Chat.module.css
similarity index 100%
rename from src/frontend/src/pages/chat/Chat.module.css
rename to archive-doc-gen/src/frontend/src/pages/chat/Chat.module.css
diff --git a/src/frontend/src/pages/chat/Chat.test.tsx b/archive-doc-gen/src/frontend/src/pages/chat/Chat.test.tsx
similarity index 100%
rename from src/frontend/src/pages/chat/Chat.test.tsx
rename to archive-doc-gen/src/frontend/src/pages/chat/Chat.test.tsx
diff --git a/src/frontend/src/pages/chat/Chat.tsx b/archive-doc-gen/src/frontend/src/pages/chat/Chat.tsx
similarity index 100%
rename from src/frontend/src/pages/chat/Chat.tsx
rename to archive-doc-gen/src/frontend/src/pages/chat/Chat.tsx
diff --git a/src/frontend/src/pages/chat/Components/AuthNotConfigure.test.tsx b/archive-doc-gen/src/frontend/src/pages/chat/Components/AuthNotConfigure.test.tsx
similarity index 100%
rename from src/frontend/src/pages/chat/Components/AuthNotConfigure.test.tsx
rename to archive-doc-gen/src/frontend/src/pages/chat/Components/AuthNotConfigure.test.tsx
diff --git a/src/frontend/src/pages/chat/Components/AuthNotConfigure.tsx b/archive-doc-gen/src/frontend/src/pages/chat/Components/AuthNotConfigure.tsx
similarity index 100%
rename from src/frontend/src/pages/chat/Components/AuthNotConfigure.tsx
rename to archive-doc-gen/src/frontend/src/pages/chat/Components/AuthNotConfigure.tsx
diff --git a/src/frontend/src/pages/chat/Components/ChatMessageContainer.test.tsx b/archive-doc-gen/src/frontend/src/pages/chat/Components/ChatMessageContainer.test.tsx
similarity index 100%
rename from src/frontend/src/pages/chat/Components/ChatMessageContainer.test.tsx
rename to archive-doc-gen/src/frontend/src/pages/chat/Components/ChatMessageContainer.test.tsx
diff --git a/src/frontend/src/pages/chat/Components/ChatMessageContainer.tsx b/archive-doc-gen/src/frontend/src/pages/chat/Components/ChatMessageContainer.tsx
similarity index 100%
rename from src/frontend/src/pages/chat/Components/ChatMessageContainer.tsx
rename to archive-doc-gen/src/frontend/src/pages/chat/Components/ChatMessageContainer.tsx
diff --git a/src/frontend/src/pages/chat/Components/CitationPanel.test.tsx b/archive-doc-gen/src/frontend/src/pages/chat/Components/CitationPanel.test.tsx
similarity index 100%
rename from src/frontend/src/pages/chat/Components/CitationPanel.test.tsx
rename to archive-doc-gen/src/frontend/src/pages/chat/Components/CitationPanel.test.tsx
diff --git a/src/frontend/src/pages/chat/Components/CitationPanel.tsx b/archive-doc-gen/src/frontend/src/pages/chat/Components/CitationPanel.tsx
similarity index 100%
rename from src/frontend/src/pages/chat/Components/CitationPanel.tsx
rename to archive-doc-gen/src/frontend/src/pages/chat/Components/CitationPanel.tsx
diff --git a/src/frontend/src/pages/document/Document.module.css b/archive-doc-gen/src/frontend/src/pages/document/Document.module.css
similarity index 100%
rename from src/frontend/src/pages/document/Document.module.css
rename to archive-doc-gen/src/frontend/src/pages/document/Document.module.css
diff --git a/src/frontend/src/pages/document/Document.test.tsx b/archive-doc-gen/src/frontend/src/pages/document/Document.test.tsx
similarity index 100%
rename from src/frontend/src/pages/document/Document.test.tsx
rename to archive-doc-gen/src/frontend/src/pages/document/Document.test.tsx
diff --git a/src/frontend/src/pages/document/Document.tsx b/archive-doc-gen/src/frontend/src/pages/document/Document.tsx
similarity index 100%
rename from src/frontend/src/pages/document/Document.tsx
rename to archive-doc-gen/src/frontend/src/pages/document/Document.tsx
diff --git a/src/frontend/src/pages/draft/Draft.module.css b/archive-doc-gen/src/frontend/src/pages/draft/Draft.module.css
similarity index 100%
rename from src/frontend/src/pages/draft/Draft.module.css
rename to archive-doc-gen/src/frontend/src/pages/draft/Draft.module.css
diff --git a/src/frontend/src/pages/draft/Draft.test.tsx b/archive-doc-gen/src/frontend/src/pages/draft/Draft.test.tsx
similarity index 100%
rename from src/frontend/src/pages/draft/Draft.test.tsx
rename to archive-doc-gen/src/frontend/src/pages/draft/Draft.test.tsx
diff --git a/src/frontend/src/pages/draft/Draft.tsx b/archive-doc-gen/src/frontend/src/pages/draft/Draft.tsx
similarity index 100%
rename from src/frontend/src/pages/draft/Draft.tsx
rename to archive-doc-gen/src/frontend/src/pages/draft/Draft.tsx
diff --git a/src/frontend/src/pages/landing/Landing.module.css b/archive-doc-gen/src/frontend/src/pages/landing/Landing.module.css
similarity index 100%
rename from src/frontend/src/pages/landing/Landing.module.css
rename to archive-doc-gen/src/frontend/src/pages/landing/Landing.module.css
diff --git a/src/frontend/src/pages/landing/Landing.test.tsx b/archive-doc-gen/src/frontend/src/pages/landing/Landing.test.tsx
similarity index 100%
rename from src/frontend/src/pages/landing/Landing.test.tsx
rename to archive-doc-gen/src/frontend/src/pages/landing/Landing.test.tsx
diff --git a/src/frontend/src/pages/landing/Landing.tsx b/archive-doc-gen/src/frontend/src/pages/landing/Landing.tsx
similarity index 100%
rename from src/frontend/src/pages/landing/Landing.tsx
rename to archive-doc-gen/src/frontend/src/pages/landing/Landing.tsx
diff --git a/src/frontend/src/pages/layout/Layout.module.css b/archive-doc-gen/src/frontend/src/pages/layout/Layout.module.css
similarity index 100%
rename from src/frontend/src/pages/layout/Layout.module.css
rename to archive-doc-gen/src/frontend/src/pages/layout/Layout.module.css
diff --git a/src/frontend/src/pages/layout/Layout.test.tsx b/archive-doc-gen/src/frontend/src/pages/layout/Layout.test.tsx
similarity index 100%
rename from src/frontend/src/pages/layout/Layout.test.tsx
rename to archive-doc-gen/src/frontend/src/pages/layout/Layout.test.tsx
diff --git a/src/frontend/src/pages/layout/Layout.tsx b/archive-doc-gen/src/frontend/src/pages/layout/Layout.tsx
similarity index 100%
rename from src/frontend/src/pages/layout/Layout.tsx
rename to archive-doc-gen/src/frontend/src/pages/layout/Layout.tsx
diff --git a/src/frontend/src/state/AppProvider.tsx b/archive-doc-gen/src/frontend/src/state/AppProvider.tsx
similarity index 100%
rename from src/frontend/src/state/AppProvider.tsx
rename to archive-doc-gen/src/frontend/src/state/AppProvider.tsx
diff --git a/src/frontend/src/state/AppReducer.tsx b/archive-doc-gen/src/frontend/src/state/AppReducer.tsx
similarity index 100%
rename from src/frontend/src/state/AppReducer.tsx
rename to archive-doc-gen/src/frontend/src/state/AppReducer.tsx
diff --git a/src/frontend/src/test/setupTests.ts b/archive-doc-gen/src/frontend/src/test/setupTests.ts
similarity index 100%
rename from src/frontend/src/test/setupTests.ts
rename to archive-doc-gen/src/frontend/src/test/setupTests.ts
diff --git a/src/frontend/src/test/test.utils.tsx b/archive-doc-gen/src/frontend/src/test/test.utils.tsx
similarity index 100%
rename from src/frontend/src/test/test.utils.tsx
rename to archive-doc-gen/src/frontend/src/test/test.utils.tsx
diff --git a/src/frontend/src/vite-env.d.ts b/archive-doc-gen/src/frontend/src/vite-env.d.ts
similarity index 100%
rename from src/frontend/src/vite-env.d.ts
rename to archive-doc-gen/src/frontend/src/vite-env.d.ts
diff --git a/src/frontend/tsconfig.json b/archive-doc-gen/src/frontend/tsconfig.json
similarity index 100%
rename from src/frontend/tsconfig.json
rename to archive-doc-gen/src/frontend/tsconfig.json
diff --git a/src/frontend/tsconfig.node.json b/archive-doc-gen/src/frontend/tsconfig.node.json
similarity index 100%
rename from src/frontend/tsconfig.node.json
rename to archive-doc-gen/src/frontend/tsconfig.node.json
diff --git a/src/frontend/vite.config.ts b/archive-doc-gen/src/frontend/vite.config.ts
similarity index 100%
rename from src/frontend/vite.config.ts
rename to archive-doc-gen/src/frontend/vite.config.ts
diff --git a/src/gunicorn.conf.py b/archive-doc-gen/src/gunicorn.conf.py
similarity index 100%
rename from src/gunicorn.conf.py
rename to archive-doc-gen/src/gunicorn.conf.py
diff --git a/src/requirements-dev.txt b/archive-doc-gen/src/requirements-dev.txt
similarity index 100%
rename from src/requirements-dev.txt
rename to archive-doc-gen/src/requirements-dev.txt
diff --git a/src/requirements.txt b/archive-doc-gen/src/requirements.txt
similarity index 100%
rename from src/requirements.txt
rename to archive-doc-gen/src/requirements.txt
diff --git a/src/start.cmd b/archive-doc-gen/src/start.cmd
similarity index 100%
rename from src/start.cmd
rename to archive-doc-gen/src/start.cmd
diff --git a/src/start.sh b/archive-doc-gen/src/start.sh
similarity index 100%
rename from src/start.sh
rename to archive-doc-gen/src/start.sh
diff --git a/src/test.cmd b/archive-doc-gen/src/test.cmd
similarity index 100%
rename from src/test.cmd
rename to archive-doc-gen/src/test.cmd
diff --git a/src/tests/conftest.py b/archive-doc-gen/src/tests/conftest.py
similarity index 100%
rename from src/tests/conftest.py
rename to archive-doc-gen/src/tests/conftest.py
diff --git a/src/tests/integration_tests/conftest.py b/archive-doc-gen/src/tests/integration_tests/conftest.py
similarity index 100%
rename from src/tests/integration_tests/conftest.py
rename to archive-doc-gen/src/tests/integration_tests/conftest.py
diff --git a/src/tests/integration_tests/dotenv_templates/dotenv.jinja2 b/archive-doc-gen/src/tests/integration_tests/dotenv_templates/dotenv.jinja2
similarity index 100%
rename from src/tests/integration_tests/dotenv_templates/dotenv.jinja2
rename to archive-doc-gen/src/tests/integration_tests/dotenv_templates/dotenv.jinja2
diff --git a/src/tests/integration_tests/test_datasources.py b/archive-doc-gen/src/tests/integration_tests/test_datasources.py
similarity index 100%
rename from src/tests/integration_tests/test_datasources.py
rename to archive-doc-gen/src/tests/integration_tests/test_datasources.py
diff --git a/src/tests/integration_tests/test_startup_scripts.py b/archive-doc-gen/src/tests/integration_tests/test_startup_scripts.py
similarity index 100%
rename from src/tests/integration_tests/test_startup_scripts.py
rename to archive-doc-gen/src/tests/integration_tests/test_startup_scripts.py
diff --git a/src/tests/unit_tests/dotenv_data/dotenv_no_datasource_1 b/archive-doc-gen/src/tests/unit_tests/dotenv_data/dotenv_no_datasource_1
similarity index 100%
rename from src/tests/unit_tests/dotenv_data/dotenv_no_datasource_1
rename to archive-doc-gen/src/tests/unit_tests/dotenv_data/dotenv_no_datasource_1
diff --git a/src/tests/unit_tests/dotenv_data/dotenv_no_datasource_2 b/archive-doc-gen/src/tests/unit_tests/dotenv_data/dotenv_no_datasource_2
similarity index 100%
rename from src/tests/unit_tests/dotenv_data/dotenv_no_datasource_2
rename to archive-doc-gen/src/tests/unit_tests/dotenv_data/dotenv_no_datasource_2
diff --git a/src/tests/unit_tests/dotenv_data/dotenv_with_azure_search_success b/archive-doc-gen/src/tests/unit_tests/dotenv_data/dotenv_with_azure_search_success
similarity index 100%
rename from src/tests/unit_tests/dotenv_data/dotenv_with_azure_search_success
rename to archive-doc-gen/src/tests/unit_tests/dotenv_data/dotenv_with_azure_search_success
diff --git a/src/tests/unit_tests/dotenv_data/dotenv_with_elasticsearch_success b/archive-doc-gen/src/tests/unit_tests/dotenv_data/dotenv_with_elasticsearch_success
similarity index 100%
rename from src/tests/unit_tests/dotenv_data/dotenv_with_elasticsearch_success
rename to archive-doc-gen/src/tests/unit_tests/dotenv_data/dotenv_with_elasticsearch_success
diff --git a/src/tests/unit_tests/helpers/test_azure_credential_utils.py b/archive-doc-gen/src/tests/unit_tests/helpers/test_azure_credential_utils.py
similarity index 100%
rename from src/tests/unit_tests/helpers/test_azure_credential_utils.py
rename to archive-doc-gen/src/tests/unit_tests/helpers/test_azure_credential_utils.py
diff --git a/src/tests/unit_tests/test_settings.py b/archive-doc-gen/src/tests/unit_tests/test_settings.py
similarity index 100%
rename from src/tests/unit_tests/test_settings.py
rename to archive-doc-gen/src/tests/unit_tests/test_settings.py
diff --git a/src/tests/unit_tests/test_utils.py b/archive-doc-gen/src/tests/unit_tests/test_utils.py
similarity index 100%
rename from src/tests/unit_tests/test_utils.py
rename to archive-doc-gen/src/tests/unit_tests/test_utils.py
diff --git a/tests/e2e-test/.gitignore b/archive-doc-gen/tests/e2e-test/.gitignore
similarity index 100%
rename from tests/e2e-test/.gitignore
rename to archive-doc-gen/tests/e2e-test/.gitignore
diff --git a/tests/e2e-test/README.md b/archive-doc-gen/tests/e2e-test/README.md
similarity index 100%
rename from tests/e2e-test/README.md
rename to archive-doc-gen/tests/e2e-test/README.md
diff --git a/tests/e2e-test/base/__init__.py b/archive-doc-gen/tests/e2e-test/base/__init__.py
similarity index 100%
rename from tests/e2e-test/base/__init__.py
rename to archive-doc-gen/tests/e2e-test/base/__init__.py
diff --git a/tests/e2e-test/base/base.py b/archive-doc-gen/tests/e2e-test/base/base.py
similarity index 100%
rename from tests/e2e-test/base/base.py
rename to archive-doc-gen/tests/e2e-test/base/base.py
diff --git a/tests/e2e-test/config/constants.py b/archive-doc-gen/tests/e2e-test/config/constants.py
similarity index 51%
rename from tests/e2e-test/config/constants.py
rename to archive-doc-gen/tests/e2e-test/config/constants.py
index 9e7021a31..6dec2c9a5 100644
--- a/tests/e2e-test/config/constants.py
+++ b/archive-doc-gen/tests/e2e-test/config/constants.py
@@ -13,11 +13,25 @@
# browse input data
browse_question1 = "What are typical sections in a promissory note?"
browse_question2 = "List the details of two promissory notes governed by the laws of the state of California"
+browse_question3 = "List all documents and their value"
+browse_question4 = "list each promissory note, the borrower name, the lender name, the amount, and the interest rate in table format where the interest rate is not 5%"
+browse_question5 = "list each promissory note, the borrower name, the lender name, the amount, and the interest rate in tabular format where the interest rate is not 5%"
# Generate input data
generate_question1 = "Generate promissory note for Washington State"
add_section = "Add Payment acceleration clause after the payment terms sections"
+remove_section = "Remove Borrower Information Promissory note"
+
# Response Text Data
invalid_response = "I was unable to find content related to your query and could not generate a template. Please try again."
invalid_response1 = "An error occurred. Answers can't be saved at this time. If the problem persists, please contact the site administrator."
+
+
+# Construct the absolute path to the JSON file
+# Note: This section is commented out as prompts.json file doesn't exist
+# All required constants are defined above
+# json_file_path = os.path.join(repo_root, 'tests/e2e-test', 'testdata', 'prompts.json')
+# with open(json_file_path, 'r') as file:
+# data = json.load(file)
+# questions = data['questions']
diff --git a/tests/e2e-test/img.png b/archive-doc-gen/tests/e2e-test/img.png
similarity index 100%
rename from tests/e2e-test/img.png
rename to archive-doc-gen/tests/e2e-test/img.png
diff --git a/tests/e2e-test/img_1.png b/archive-doc-gen/tests/e2e-test/img_1.png
similarity index 100%
rename from tests/e2e-test/img_1.png
rename to archive-doc-gen/tests/e2e-test/img_1.png
diff --git a/tests/e2e-test/pages/__init__.py b/archive-doc-gen/tests/e2e-test/pages/__init__.py
similarity index 100%
rename from tests/e2e-test/pages/__init__.py
rename to archive-doc-gen/tests/e2e-test/pages/__init__.py
diff --git a/archive-doc-gen/tests/e2e-test/pages/browsePage.py b/archive-doc-gen/tests/e2e-test/pages/browsePage.py
new file mode 100644
index 000000000..bf65cbeb9
--- /dev/null
+++ b/archive-doc-gen/tests/e2e-test/pages/browsePage.py
@@ -0,0 +1,287 @@
+from base.base import BasePage
+from playwright.sync_api import expect
+import logging
+logger = logging.getLogger(__name__)
+
+
+class BrowsePage(BasePage):
+ TYPE_QUESTION = "//textarea[@placeholder='Type a new question...']"
+ SEND_BUTTON = "//div[@aria-label='Ask question button']"
+ GENERATE_BUTTON = "//div[contains(@class, 'ms-Stack')]//span[normalize-space()='Generate']"
+ DRAFT_TAB_BUTTON = "//span[normalize-space()='Draft']"
+ DRAFT_TAB_CONTAINER = "//div[contains(@class, '_navigationButtonDisabled')]"
+ RESPONSE_REFERENCE_EXPAND_ICON = "//span[@aria-label='Open references']"
+ REFERENCE_LINKS_IN_RESPONSE = "//span[@class='_citationContainer_1qm4u_72']"
+ REFERENCE_POPUP_PANEL = "//div[@role='dialog']"
+ REFERENCE_POPUP_CONTENT = "//div[@role='dialog']//div[contains(@class, 'fui-DialogSurface')]"
+ CLOSE_BUTTON = "//button[.='Close']"
+ CLEAR_CHAT_BROOM_BUTTON = "button[aria-label='clear chat button']"
+
+ def __init__(self, page):
+ super().__init__(page)
+
+ def validate_browse_page(self):
+ """Validate that Browse page chat conversation elements are visible"""
+ self.page.wait_for_timeout(3000)
+ expect(self.page.locator(self.TYPE_QUESTION)).to_be_visible()
+ expect(self.page.locator(self.SEND_BUTTON)).to_be_visible()
+
+ def enter_a_question(self, text):
+ # Type a question in the text area
+ self.page.locator(self.TYPE_QUESTION).fill(text)
+ self.page.wait_for_timeout(2000)
+
+ def click_send_button(self):
+ # Type a question in the text area
+ self.page.locator(self.SEND_BUTTON).click()
+ self.page.wait_for_timeout(10000)
+
+ def click_generate_button(self):
+ # Type a question in the text area
+ self.page.locator(self.GENERATE_BUTTON).click()
+ self.page.wait_for_timeout(5000)
+
+ def click_reference_link_in_response(self):
+ # Click on reference link response
+ BasePage.scroll_into_view(
+ self, self.page.locator(self.REFERENCE_LINKS_IN_RESPONSE)
+ )
+ self.page.wait_for_timeout(2000)
+ reference_links = self.page.locator(self.REFERENCE_LINKS_IN_RESPONSE)
+ reference_links.nth(reference_links.count() - 1).click()
+ # self.page.locator(self.REFERENCE_LINKS_IN_RESPONSE).click()
+ self.page.wait_for_load_state("networkidle")
+ self.page.wait_for_timeout(2000)
+
+ def click_expand_reference_in_response(self):
+ # Click on expand in response reference area
+ self.page.wait_for_timeout(5000)
+ expand_icon = self.page.locator(self.RESPONSE_REFERENCE_EXPAND_ICON)
+ expand_icon.nth(expand_icon.count() - 1).click()
+ self.page.wait_for_load_state("networkidle")
+ self.page.wait_for_timeout(2000)
+
+ def close_citation(self):
+ self.page.wait_for_timeout(3000)
+ self.page.locator(self.CLOSE_BUTTON).click()
+ self.page.wait_for_timeout(2000)
+
+ def click_draft_tab_button(self):
+ """Click on Draft tab button"""
+ self.page.wait_for_timeout(2000)
+ self.page.locator(self.DRAFT_TAB_BUTTON).click()
+ self.page.wait_for_timeout(3000)
+
+ def is_draft_tab_enabled(self):
+ """Check if Draft tab is enabled (clickable)"""
+ self.page.wait_for_timeout(2000)
+ draft_button = self.page.locator(self.DRAFT_TAB_BUTTON)
+
+ if draft_button.count() > 0:
+ # Check if the container has the disabled class
+ draft_container = self.page.locator(self.DRAFT_TAB_CONTAINER)
+ has_disabled_class = draft_container.count() > 0
+
+ # Check if cursor is not-allowed (disabled state)
+ cursor_style = draft_container.get_attribute("style") if has_disabled_class else ""
+ is_disabled = "cursor: not-allowed" in cursor_style or has_disabled_class
+
+ return not is_disabled
+ return False
+
+ def is_draft_tab_disabled(self):
+ """Check if Draft tab is disabled (not clickable)"""
+ self.page.wait_for_timeout(2000)
+ draft_button = self.page.locator(self.DRAFT_TAB_BUTTON)
+
+ if draft_button.count() > 0:
+ # Check if the container has the disabled class
+ draft_container = self.page.locator(self.DRAFT_TAB_CONTAINER)
+ has_disabled_class = draft_container.count() > 0
+
+ # Check if cursor is not-allowed (disabled state)
+ if has_disabled_class:
+ cursor_style = draft_container.get_attribute("style") or ""
+ is_disabled = "cursor: not-allowed" in cursor_style
+ return is_disabled
+ return False
+ return True # If not visible, consider it disabled
+
+ def click_broom_icon(self):
+ broom = self.page.locator(self.CLEAR_CHAT_BROOM_BUTTON)
+ assert broom.is_visible(), "Broom (clear chat) icon is not visible"
+ broom.click()
+ logger.info("Clicked broom icon to clear the chat")
+
+ def is_chat_cleared(self):
+ """
+ Verify that the chat has been cleared and a new session has started.
+ Checks if the chat area is empty (no previous messages visible).
+
+ :return: True if chat is cleared, False otherwise
+ """
+ self.page.wait_for_timeout(1000)
+
+ # Check if any response paragraphs exist (indicating old messages)
+ response_paragraphs = self.page.locator("//div[contains(@class, 'answerContainer')]//p")
+ has_old_messages = response_paragraphs.count() > 0
+
+ if has_old_messages:
+ logger.warning("Chat still contains old messages after clearing")
+ return False
+
+ # Verify the input field is visible and empty (ready for new input)
+ input_field = self.page.locator(self.TYPE_QUESTION)
+ if not input_field.is_visible():
+ logger.warning("Chat input field is not visible")
+ return False
+
+ # Check if input field is empty or has placeholder text
+ input_value = input_field.input_value()
+ if input_value.strip():
+ logger.warning("Chat input field still contains text: '%s'", input_value)
+ return False
+
+ logger.info("Chat cleared successfully - no old messages, input field is empty")
+ return True
+
+ def get_citation_count(self):
+ """
+ Get the number of citations/references in the last response.
+
+ Returns:
+ int: Number of citation links found
+ """
+ logger.info("🔹 Counting citations in response")
+
+ self.page.wait_for_timeout(2000)
+
+ # Get citation links in the last response
+ citation_links = self.page.locator(self.REFERENCE_LINKS_IN_RESPONSE)
+ count = citation_links.count()
+
+ logger.info(f"Found {count} citations in response")
+ return count
+
+ def get_citations_and_documents(self):
+ """
+ Get all citations and their corresponding document names from the last response.
+ Expands the references section and extracts document information.
+
+ Returns:
+ tuple: (citation_count, document_list)
+ """
+ logger.info("🔹 Extracting citations and documents from response")
+
+ self.page.wait_for_timeout(3000)
+
+ # Count citations first
+ citation_count = self.get_citation_count()
+
+ if citation_count == 0:
+ logger.warning("No citations found in response")
+ return 0, []
+
+ # Click to expand references
+ try:
+ expand_icon = self.page.locator(self.RESPONSE_REFERENCE_EXPAND_ICON)
+ if expand_icon.count() > 0:
+ expand_icon.nth(expand_icon.count() - 1).click()
+ logger.info("Expanded references section")
+ self.page.wait_for_timeout(2000)
+ else:
+ logger.warning("References expand icon not found")
+ return citation_count, []
+ except Exception as e:
+ logger.error(f"Failed to expand references: {e}")
+ return citation_count, []
+
+ # Extract document names from expanded references
+ documents = []
+
+ try:
+ # Look for reference items in the expanded section
+ # This selector may need adjustment based on actual DOM structure
+ reference_items = self.page.locator("//div[contains(@class, 'citationPanel')]//div[contains(@class, 'citationItem')]")
+
+ if reference_items.count() == 0:
+ # Try alternative selector
+ reference_items = self.page.locator("//div[@role='complementary']//div[contains(@class, 'citation')]")
+
+ ref_count = reference_items.count()
+ logger.info(f"Found {ref_count} reference items in expanded section")
+
+ for i in range(ref_count):
+ try:
+ ref_text = reference_items.nth(i).inner_text()
+ documents.append(ref_text.strip())
+ logger.info(f" Reference {i + 1}: {ref_text[:100]}...")
+ except Exception as e:
+ logger.warning(f"Could not extract reference {i + 1}: {e}")
+
+ except Exception as e:
+ logger.error(f"Failed to extract reference documents: {e}")
+
+ logger.info(f"✅ Extracted {len(documents)} document references")
+ return citation_count, documents
+
+ def verify_response_has_citations(self, min_citations=1):
+ """
+ Verify that the response has at least the minimum number of citations.
+
+ Args:
+ min_citations: Minimum expected number of citations (default: 1)
+
+ Returns:
+ bool: True if citation count >= min_citations
+ """
+ logger.info(f"🔹 Verifying response has at least {min_citations} citation(s)")
+
+ citation_count = self.get_citation_count()
+
+ if citation_count >= min_citations:
+ logger.info(f"✅ Response has {citation_count} citations (>= {min_citations})")
+ return True
+ else:
+ logger.error(f"❌ Response has only {citation_count} citations (expected >= {min_citations})")
+ return False
+
+ def verify_response_generated_with_citations(self, timeout=60000):
+ """
+ Verify that a response is generated with citations/references.
+
+ Args:
+ timeout: Maximum wait time in milliseconds
+
+ Returns:
+ tuple: (response_text, citation_count)
+ """
+ logger.info("🔹 Verifying response generated with citations")
+
+ # Wait for response container
+ self.page.wait_for_timeout(5000)
+
+ answer_container = self.page.locator("//div[contains(@class, 'answerContainer')]").last
+
+ try:
+ # Wait for answer to be visible
+ expect(answer_container).to_be_visible(timeout=timeout)
+
+ # Get response text
+ response_text = answer_container.inner_text()
+ logger.info(f"Response length: {len(response_text)} characters")
+
+ # Verify response is not empty
+ assert response_text.strip(), "Response text is empty"
+
+ # Count citations
+ citation_count = self.get_citation_count()
+ logger.info(f"Response has {citation_count} citations")
+
+ logger.info("✅ Response generated successfully with citations")
+ return response_text, citation_count
+
+ except Exception as e:
+ logger.error(f"❌ Failed to verify response with citations: {e}")
+ raise
+
diff --git a/archive-doc-gen/tests/e2e-test/pages/draftPage.py b/archive-doc-gen/tests/e2e-test/pages/draftPage.py
new file mode 100644
index 000000000..760a54e55
--- /dev/null
+++ b/archive-doc-gen/tests/e2e-test/pages/draftPage.py
@@ -0,0 +1,627 @@
+import time
+import os
+from base.base import BasePage
+from pytest_check import check
+from playwright.sync_api import expect
+import logging
+logger = logging.getLogger(__name__)
+
+
+class DraftPage(BasePage):
+ Draft_Sections = "//textarea"
+ Draft_headings = "//span[@class='fui-Text ___nl2uoq0 fk6fouc f4ybsrx f1i3iumi f16wzh4i fpgzoln f1w7gpdv f6juhto f1gl81tg f2jf649 fepr9ql febqm8h']"
+ invalid_response = "The requested information is not available in the retrieved data. Please try another query or topic."
+ invalid_response1 = "There was an issue fetching your data. Please try again."
+ SECTION_CONTAINER = "div[role='region']"
+ SECTION_GENERATE_BUTTON = "button.fui-Button:has-text('Generate')"
+
+ def __init__(self, page):
+ super().__init__(page)
+
+ def validate_draft_sections_loaded(self):
+ max_wait_time = 180 # seconds
+ poll_interval = 2
+
+ self.page.wait_for_timeout(25000)
+
+ # All draft section containers
+ section_blocks = self.page.locator("//div[@class='ms-Stack ___mit7380 f4zyqsv f6m9rw3 fwbpcpn folxr9a f1s274it css-103']")
+ total_sections = section_blocks.count()
+
+ logger.info(f"🔍 Total sections found: {total_sections}")
+
+ for index in range(total_sections):
+ section = section_blocks.nth(index)
+
+ try:
+ section.scroll_into_view_if_needed()
+ self.page.wait_for_timeout(500)
+
+ title_element = section.locator("//span[@class='fui-Text ___nl2uoq0 fk6fouc f4ybsrx f1i3iumi f16wzh4i fpgzoln f1w7gpdv f6juhto f1gl81tg f2jf649 fepr9ql febqm8h']")
+ title_text = title_element.inner_text(timeout=5000).strip()
+ except Exception as e:
+ logger.error(f"❌ Could not read title for section #{index + 1}: {e}")
+ continue
+
+ logger.info(f"➡️ Validating section [{index + 1}/{total_sections}]: '{title_text}'")
+
+ content_locator = section.locator("//textarea")
+ generate_btn = section.locator("//span[@class='fui-Button__icon rywnvv2 ___963sj20 f1nizpg2']")
+ spinner_locator = section.locator("//div[@id='section-card-spinner']")
+
+ content_loaded = False
+
+ # 🚨 If spinner is visible inside this section, click generate immediately
+ try:
+ if spinner_locator.is_visible(timeout=1000):
+ logger.warning(f"⏳ Spinner found in section '{title_text}'. Clicking Generate immediately.")
+ generate_btn.click()
+ self.page.wait_for_timeout(3000)
+ confirm_btn = self.page.locator("//button[@class='fui-Button r1alrhcs ___zqkcn80 fd1o0ie fjxutwb fwiml72 fj8njcf fzcpov4 f1d2rq10 f1mk8lai ff3glw6']")
+ if confirm_btn.is_visible(timeout=3000):
+ confirm_btn.click()
+ logger.info(f"🟢 Clicked Confirm button for section '{title_text}'")
+ else:
+ logger.warning(f"⚠️ Confirm button not visible for section '{title_text}'")
+ except Exception as e:
+ logger.error(f"❌ Error while clicking Confirm button for section '{title_text}': {e}")
+
+ # ⏳ Retry short wait (15s) for content to load
+ short_wait = 15
+ short_start = time.time()
+ while time.time() - short_start < short_wait:
+ try:
+ content = content_locator.text_content(timeout=2000).strip()
+ if content:
+ logger.info(f"✅ Section '{title_text}' loaded after Generate + Confirm.")
+ content_loaded = True
+ break
+ except Exception as e:
+ logger.info(f"⏳ Waiting for section '{title_text}' to load... {e}")
+ time.sleep(1)
+
+ if not content_loaded:
+ logger.error(f"❌ Section '{title_text}' still empty after Generate + Confirm wait ({short_wait}s). Skipping.")
+
+ # Step 1: Wait for content to load normally
+ start = time.time()
+ while time.time() - start < max_wait_time:
+ try:
+ content = content_locator.text_content(timeout=2000).strip()
+ if content:
+ logger.info(f"✅ Section '{title_text}' loaded successfully.")
+ content_loaded = True
+ break
+ except Exception as e:
+ logger.info(f"⏳ Waiting for section '{title_text}' to load... {e}")
+ time.sleep(poll_interval)
+
+ # Step 2: If still not loaded, click Generate and retry
+ if not content_loaded:
+ logger.warning(f"⚠️ Section '{title_text}' is empty. Attempting 'Generate'...")
+
+ try:
+ generate_btn.click()
+ logger.info(f"🔄 Clicked 'Generate' for section '{title_text}'")
+ except Exception as e:
+ logger.error(f"❌ Failed to click 'Generate' for section '{title_text}': {e}")
+ continue
+
+ # Retry wait
+ start = time.time()
+ while time.time() - start < max_wait_time:
+ try:
+ content = content_locator.text_content(timeout=2000).strip()
+ if content:
+ logger.info(f"✅ Section '{title_text}' loaded after clicking Generate.")
+ content_loaded = True
+ break
+ except Exception as e:
+ logger.info(f"⏳ Waiting for section '{title_text}' to load after Generate... {e}")
+ time.sleep(poll_interval)
+
+ if not content_loaded:
+ logger.error(f"❌ Section '{title_text}' still empty after retrying.")
+ # Note: Screenshots are only captured on test failures, not during normal page operations
+ continue
+
+ try:
+ content = content_locator.text_content(timeout=2000).strip()
+ with check:
+ if content == self.invalid_response or content == self.invalid_response1:
+ logger.warning(f"❌ Invalid response found in '{title_text}'. Retrying Generate + Confirm...")
+
+ try:
+ generate_btn.click()
+ self.page.wait_for_timeout(3000)
+
+ confirm_btn = self.page.locator("//button[@class='fui-Button r1alrhcs ___zqkcn80 fd1o0ie fjxutwb fwiml72 fj8njcf fzcpov4 f1d2rq10 f1mk8lai ff3glw6']")
+ if confirm_btn.is_visible(timeout=3000):
+ confirm_btn.click()
+ logger.info(f"🟢 Retried Confirm for section '{title_text}'")
+ else:
+ logger.warning(f"⚠️ Confirm button not visible during retry for '{title_text}'")
+ except Exception as e:
+ logger.error(f"❌ Retry Generate/Confirm failed: {e}")
+
+ retry_start = time.time()
+ while time.time() - retry_start < short_wait:
+ try:
+ content = content_locator.text_content(timeout=2000).strip()
+ if content and content not in [self.invalid_response, self.invalid_response1]:
+ logger.info(f"✅ Section '{title_text}' fixed after retry.")
+ break
+ except Exception as e:
+ logger.info(f"⏳ Retrying section '{title_text}'... {e}")
+ time.sleep(1)
+
+ with check:
+ assert content != self.invalid_response, f"❌ '{title_text}' still has invalid response after retry"
+ assert content != self.invalid_response1, f"❌ '{title_text}' still has invalid response after retry"
+
+ else:
+ logger.info(f"🎯 Section '{title_text}' has valid content.")
+ except Exception as e:
+ logger.error(f"❌ Could not validate content for '{title_text}': {e}")
+ logger.info(f"✔️ Completed section: '{title_text}'\n")
+
+ def verify_all_section_generate_buttons(self, expected_count=11):
+ """
+ Verifies that each Draft section contains a visible 'Generate' button.
+ Ensures no section is missing its Generate button.
+ """
+ buttons = self.page.locator('button:has-text("Generate")')
+ found_count = buttons.count()
+
+ # Logging (optional)
+ logger.info(f"Found {found_count} Generate buttons, expected {expected_count}")
+
+ # Assertion
+ expect(buttons).to_have_count(expected_count)
+
+ return found_count
+
+ def click_section_generate_button(self, section_index):
+ """
+ Click the Generate button for a specific section on the Draft page.
+ """
+
+ logger.info(f"🔹 Clicking Generate button for section {section_index + 1}")
+
+ # Corrected section locator (your old one was too rigid)
+ section_blocks = self.page.locator(
+ "//div[contains(@class,'ms-Stack') and contains(@class,'f1s274it')]"
+ )
+
+ section = section_blocks.nth(section_index)
+
+ # Get section title (your previous locator was global → replaced with relative)
+ try:
+ title_element = section.locator(".fui-Text").first
+ title = title_element.inner_text(timeout=3000).strip()
+ logger.info(f"Section title: '{title}'")
+ except Exception:
+ title = f"Section {section_index + 1}"
+ logger.warning(f"⚠️ Could not read section title, using default: {title}")
+
+ # Scroll into view before clicking
+ section.scroll_into_view_if_needed()
+ self.page.wait_for_timeout(300)
+
+ # Find Generate button inside section
+ generate_button = section.locator("button:has-text('Generate')").first
+ expect(generate_button).to_be_visible(timeout=5000)
+
+ generate_button.click()
+ logger.info(f"✅ Clicked Generate button for section: {title}")
+
+ return title
+
+ def verify_regenerate_popup_displayed(self):
+ """
+ Verify that the Regenerate popup is displayed with Generate button.
+ """
+ logger.info("🔹 Verifying Regenerate popup is displayed")
+
+ # Wait for the popup to appear
+ self.page.wait_for_timeout(1000)
+
+ # Correct locator for the Popover
+ popup = self.page.locator("div.fui-PopoverSurface").first
+
+ try:
+ expect(popup).to_be_visible(timeout=5000)
+ logger.info("✅ Regenerate popup is displayed")
+ except Exception as e:
+ logger.error(f"❌ Regenerate popup not found: {e}")
+ raise
+
+ # Locate the Generate button inside the popup
+ generate_button = popup.locator("button[data-testid='generate-btn-in-popover']")
+ expect(generate_button).to_be_visible(timeout=3000)
+ logger.info("✅ Generate button found in Regenerate popup")
+
+ return popup
+
+ def update_prompt_and_regenerate(self, additional_instruction):
+ """
+ Read the existing section-specific prompt from the popup, append additional instruction, and regenerate.
+
+ Args:
+ additional_instruction: Additional instruction to append to the existing prompt (e.g., "add max 150 words")
+ """
+ logger.info(f"🔹 Reading existing prompt from popup and appending: '{additional_instruction}'")
+
+ # Find the popup using the correct locator
+ popup = self.page.locator("div.fui-PopoverSurface").first
+
+ # Find the textarea in the popup
+ prompt_input = popup.locator("textarea").first
+
+ try:
+ # Read the existing section-specific prompt from the popup
+ existing_prompt = prompt_input.input_value(timeout=3000)
+ logger.info(f"📝 Existing prompt in popup: '{existing_prompt}'")
+
+ # Append the additional instruction to the existing prompt
+ updated_prompt = f"{existing_prompt} {additional_instruction}"
+
+ # Clear and enter the updated prompt
+ prompt_input.clear()
+ prompt_input.fill(updated_prompt)
+ logger.info(f"✅ Updated prompt: '{updated_prompt}'")
+ except Exception as e:
+ logger.error(f"❌ Failed to update prompt: {e}")
+ raise
+
+ # Click Generate button in popup using the correct data-testid
+ generate_button = popup.locator("button[data-testid='generate-btn-in-popover']")
+
+ try:
+ expect(generate_button).to_be_visible(timeout=3000)
+ generate_button.click()
+ logger.info("✅ Clicked Generate button in popup")
+ except Exception as e:
+ logger.error(f"❌ Failed to click Generate button: {e}")
+ raise
+
+ # Wait for popup to close and regeneration to start
+ self.page.wait_for_timeout(2000)
+
+ def verify_section_content_updated(self, section_index, original_content):
+ """
+ Verify that the section content has been updated after regeneration.
+
+ Args:
+ section_index: Index of the section (0-based)
+ original_content: Original content before regeneration
+
+ Returns:
+ new_content: The updated content
+ """
+ logger.info(f"🔹 Verifying section {section_index + 1} content is updated")
+
+ # Wait for regeneration to complete
+ max_wait = 60 # seconds
+ start_time = time.time()
+
+ # Use the same section locator as other methods for consistency
+ section_blocks = self.page.locator(
+ "//div[contains(@class,'ms-Stack') and contains(@class,'f1s274it')]"
+ )
+ section = section_blocks.nth(section_index)
+
+ # Wait for spinner to disappear if present
+ spinner_locator = section.locator("//div[@id='section-card-spinner']")
+ try:
+ if spinner_locator.is_visible(timeout=2000):
+ logger.info("⏳ Waiting for regeneration to complete...")
+ spinner_locator.wait_for(state="hidden", timeout=max_wait * 1000)
+ except Exception:
+ pass # Spinner might not appear for fast responses
+
+ # Get updated content
+ content_locator = section.locator("//textarea")
+
+ while time.time() - start_time < max_wait:
+ try:
+ new_content = content_locator.text_content(timeout=3000).strip()
+
+ if new_content and new_content != original_content:
+ logger.info(f"✅ Section content updated successfully")
+ logger.info(f"Original length: {len(original_content)} chars")
+ logger.info(f"New length: {len(new_content)} chars")
+ return new_content
+
+ except Exception as e:
+ logger.warning(f"⏳ Waiting for content update: {e}")
+
+ time.sleep(2)
+
+ # If we reach here, content didn't update
+ logger.warning("⚠️ Section content may not have updated within timeout")
+ new_content = content_locator.text_content(timeout=3000).strip()
+ return new_content
+
+ def regenerate_all_sections(self, additional_instruction="add max 150 words"):
+ """
+ Iterate through all sections, click Generate button, append instruction to existing popup prompt, and verify regeneration.
+
+ Args:
+ additional_instruction: Instruction to append to the existing section-specific prompt in the popup
+ """
+ logger.info("🔹 Starting regeneration of all sections")
+ logger.info(f"Additional instruction to append: '{additional_instruction}'")
+
+ # Get total section count
+ section_blocks = self.page.locator(
+ "//div[contains(@class,'ms-Stack') and contains(@class,'f1s274it')]"
+ )
+ total_sections = section_blocks.count()
+
+ logger.info(f"Total sections to regenerate: {total_sections}")
+
+ for i in range(total_sections):
+ logger.info(f"\n{'='*60}")
+ logger.info(f"Processing section {i + 1}/{total_sections}")
+ logger.info(f"{'='*60}")
+
+ # Get original content
+ section = section_blocks.nth(i)
+ content_locator = section.locator("//textarea")
+ original_content = content_locator.text_content(timeout=3000).strip()
+
+ # Step 1: Click Generate button for this section
+ self.click_section_generate_button(i)
+
+ # Step 2: Verify regenerate popup is displayed
+ self.verify_regenerate_popup_displayed()
+
+ # Step 3: Read existing prompt from popup and append additional instruction
+ self.update_prompt_and_regenerate(additional_instruction)
+
+ # Step 4: Verify content is updated
+ new_content = self.verify_section_content_updated(i, original_content)
+
+ with check:
+ assert new_content != original_content, f"Section {i + 1} content did not update"
+
+ logger.info(f"✅ Section {i + 1} regenerated successfully\n")
+
+ # Small delay between sections
+ self.page.wait_for_timeout(1000)
+
+ logger.info(f"\n{'='*60}")
+ logger.info("✅ All sections regenerated successfully")
+ logger.info(f"{'='*60}")
+
+ def verify_character_count_labels(self, max_chars=2000):
+ """
+ Verify that each section shows a character count label and count is less than max_chars.
+
+ Args:
+ max_chars: Maximum allowed characters (default: 2000)
+ """
+ logger.info("🔹 Verifying character count labels in all sections")
+
+ # Get all section containers
+ section_blocks = self.page.locator(
+ "//div[contains(@class,'ms-Stack') and contains(@class,'f1s274it')]"
+ )
+ total_sections = section_blocks.count()
+
+ logger.info(f"Total sections to verify: {total_sections}")
+
+ # Locator for character count label
+ char_count_locator = "span.fui-Text.___1v8ne64.fk6fouc.f1ugzwwg.f1i3iumi.figsok6.fpgzoln.f1w7gpdv.f6juhto.f1gl81tg.f2jf649.fq02s40.f4aeiui.f1locze1"
+
+ for i in range(total_sections):
+ section = section_blocks.nth(i)
+
+ # Get section title for logging
+ try:
+ title_element = section.locator(".fui-Text").first
+ title = title_element.inner_text(timeout=3000).strip()
+ except Exception:
+ title = f"Section {i + 1}"
+
+ logger.info(f"🔹 Verifying character count for: {title}")
+
+ # Scroll section into view
+ section.scroll_into_view_if_needed()
+ self.page.wait_for_timeout(300)
+
+ # Find character count label within this section
+ char_label = section.locator(char_count_locator).first
+
+ try:
+ expect(char_label).to_be_visible(timeout=5000)
+ label_text = char_label.inner_text(timeout=3000).strip()
+ logger.info(f"📊 Character count label: '{label_text}'")
+
+ # Extract the number from label text (e.g., "1551 characters remaining")
+ import re
+ match = re.search(r'(\d+)\s+characters remaining', label_text)
+
+ if match:
+ remaining_chars = int(match.group(1))
+ logger.info(f"📈 Characters remaining: {remaining_chars}")
+
+ # Verify remaining characters is less than or equal to max_chars
+ with check:
+ assert remaining_chars <= max_chars, f"{title}: Remaining chars {remaining_chars} should be <= {max_chars}"
+
+ # Calculate used characters
+ used_chars = max_chars - remaining_chars
+ logger.info(f"✅ {title}: Used {used_chars} chars, Remaining {remaining_chars} chars")
+ else:
+ logger.error(f"❌ Could not parse character count from label: '{label_text}'")
+
+ except Exception as e:
+ logger.error(f"❌ Character count label not found for {title}: {e}")
+ raise
+
+ logger.info("✅ All sections have valid character count labels")
+
+ def test_character_limit_restriction(self, section_index=0):
+ """
+ Test that a section restricts input to max 2000 characters.
+
+ Args:
+ section_index: Index of the section to test (default: 0 - first section)
+ """
+ logger.info(f"🔹 Testing character limit restriction for section {section_index + 1}")
+
+ # Get section
+ section_blocks = self.page.locator(
+ "//div[contains(@class,'ms-Stack') and contains(@class,'f1s274it')]"
+ )
+ section = section_blocks.nth(section_index)
+
+ # Get section title
+ try:
+ title_element = section.locator(".fui-Text").first
+ title = title_element.inner_text(timeout=3000).strip()
+ logger.info(f"Testing section: '{title}'")
+ except Exception:
+ logger.info(f"Testing section: 'Section {section_index + 1}'")
+
+ # Scroll section into view
+ section.scroll_into_view_if_needed()
+ self.page.wait_for_timeout(500)
+
+ # Find the textarea
+ textarea = section.locator("//textarea").first
+
+ # Create a string with more than 2000 characters (e.g., 2500 chars)
+ test_text = "A" * 2500
+ logger.info(f"Attempting to enter {len(test_text)} characters")
+
+ # Clear existing text
+ textarea.clear()
+
+ # Try to fill with 2500 characters
+ textarea.fill(test_text)
+ self.page.wait_for_timeout(1000)
+
+ # Get the actual text in textarea
+ actual_text = textarea.input_value()
+ actual_length = len(actual_text)
+
+ logger.info(f"📊 Actual characters entered: {actual_length}")
+
+ # Verify it's restricted to 2000 characters
+ with check:
+ assert actual_length == 2000, f"Text should be restricted to 2000 chars, but got {actual_length}"
+
+ logger.info(f"✅ Character limit enforced: Only 2000 characters allowed")
+
+ # Verify the character count label shows "0 characters remaining"
+ char_count_locator = "span.fui-Text.___1v8ne64.fk6fouc.f1ugzwwg.f1i3iumi.figsok6.fpgzoln.f1w7gpdv.f6juhto.f1gl81tg.f2jf649.fq02s40.f4aeiui.f1locze1"
+ char_label = section.locator(char_count_locator).first
+
+ try:
+ label_text = char_label.inner_text(timeout=3000).strip()
+ logger.info(f"📊 Character count label after max input: '{label_text}'")
+
+ with check:
+ assert "0 characters remaining" in label_text, f"Expected '0 characters remaining', got '{label_text}'"
+
+ logger.info("✅ Character count label correctly shows '0 characters remaining'")
+ except Exception as e:
+ logger.error(f"❌ Failed to verify character count label: {e}")
+ raise
+
+ return actual_length
+
+ def enter_document_title(self, title):
+ """
+ Enter a title in the document title text box on the Draft page
+
+ Args:
+ title: The title to enter in the document title field
+ """
+ try:
+ logger.info(f"🔹 Entering document title: '{title}'")
+
+ # Primary locator: by placeholder text
+ title_input = self.page.locator("input[placeholder='Enter title here']")
+
+ # Check if input field is visible
+ if not title_input.is_visible(timeout=5000):
+ # Try alternative locator: by class name
+ logger.warning("⚠️ Title input not found by placeholder, trying by class")
+ title_input = self.page.locator("input.ms-TextField-field")
+
+ # Wait for the input to be editable
+ title_input.wait_for(state="visible", timeout=5000)
+
+ # Scroll to the input field if needed
+ title_input.scroll_into_view_if_needed()
+ self.page.wait_for_timeout(500)
+
+ # Clear any existing title
+ title_input.clear()
+ self.page.wait_for_timeout(300)
+
+ # Enter new title
+ title_input.fill(title)
+ self.page.wait_for_timeout(500)
+
+ # Verify the title was entered correctly
+ entered_value = title_input.input_value()
+ if entered_value == title:
+ logger.info(f"✅ Successfully entered document title: '{title}'")
+ else:
+ logger.warning(f"⚠️ Title mismatch - Expected: '{title}', Got: '{entered_value}'")
+
+ except Exception as e:
+ logger.error(f"❌ Failed to enter document title: {e}")
+ # Note: Screenshots are only captured on test failures, not during normal page operations
+ raise
+
+ def click_export_document_button(self):
+ """
+ Click the 'Export Document' button at the bottom of the Draft page.
+ Waits for the button to be enabled before clicking to ensure document is ready.
+ """
+ try:
+ # First, ensure no section generation is in progress
+ # Check for any visible spinners indicating sections are still being generated
+ spinner_locator = self.page.locator("//div[@id='section-card-spinner']")
+ if spinner_locator.first.is_visible(timeout=2000):
+ logger.warning("⚠️ Sections still generating, waiting for completion...")
+ # Wait for all spinners to disappear (max 5 minutes for complex documents)
+ try:
+ spinner_locator.first.wait_for(state="hidden", timeout=300000)
+ logger.info("✅ All sections finished generating")
+ except Exception as e:
+ logger.warning(f"⚠️ Timeout waiting for spinners: {e}")
+
+ # Locate the Export Document button using the class and text
+ # Button structure:
Solution overview
Click to learn more about the key features this solution enables
- - **Semantic search**- Azure AI Search to enable RAG and grounding of the application on the processed dataset. - - - **Summarization**
- Azure OpenAI Service and GPT models to help summarize the search content and answer questions. + - **Creative Brief Interpretation**
+ Parse free-text creative briefs into structured fields (overview, objectives, target audience, key message, tone/style, deliverable, timelines, visual guidelines, CTA). - - **Content generation**
- Azure OpenAI Service and GPT models to help generate relevant content with Prompt Flow. - -
+
Quick deploy
@@ -69,13 +69,10 @@ Follow the quick deploy steps on the deployment guide to deploy this solution to
> **Note:** This solution accelerator requires **Azure Developer CLI (azd) version 1.18.0 or higher**. Please ensure you have the latest version installed before proceeding with deployment. [Download azd here](https://learn.microsoft.com/en-us/azure/developer/azure-developer-cli/install-azd).
-[Click here to launch the deployment guide](./docs/DeploymentGuide.md)
+[Click here to launch the deployment guide](./content-gen/docs/DEPLOYMENT.md)
-**For Local Development** -- [Local Development Setup Guide](docs/LocalDevelopmentSetup.md) - Comprehensive setup instructions for Windows, Linux, and macOS - -| [](https://codespaces.new/microsoft/document-generation-solution-accelerator) | [](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/microsoft/document-generation-solution-accelerator) | [&message=Open&color=blue&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/azure/?vscode-azure-exp=foundry&agentPayload=eyJiYXNlVXJsIjogImh0dHBzOi8vcmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbS9taWNyb3NvZnQvZG9jdW1lbnQtZ2VuZXJhdGlvbi1zb2x1dGlvbi1hY2NlbGVyYXRvci9yZWZzL2hlYWRzL21haW4vaW5mcmEvdnNjb2RlX3dlYiIsICJpbmRleFVybCI6ICIvaW5kZXguanNvbiIsICJ2YXJpYWJsZXMiOiB7ImFnZW50SWQiOiAiIiwgImNvbm5lY3Rpb25TdHJpbmciOiAiIiwgInRocmVhZElkIjogIiIsICJ1c2VyTWVzc2FnZSI6ICIiLCAicGxheWdyb3VuZE5hbWUiOiAiIiwgImxvY2F0aW9uIjogIiIsICJzdWJzY3JpcHRpb25JZCI6ICIiLCAicmVzb3VyY2VJZCI6ICIiLCAicHJvamVjdFJlc291cmNlSWQiOiAiIiwgImVuZHBvaW50IjogIiJ9LCAiY29kZVJvdXRlIjogWyJhaS1wcm9qZWN0cy1zZGsiLCAicHl0aG9uIiwgImRlZmF1bHQtYXp1cmUtYXV0aCIsICJlbmRwb2ludCJdfQ==) | +| [](https://codespaces.new/hunterjam/content-generation-solution-accelerator) | [](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/hunterjam/content-generation-solution-accelerator) | [&message=Open&color=blue&logo=visualstudiocode&logoColor=white)](https://vscode.dev/azure/?vscode-azure-exp=foundry&agentPayload=eyJiYXNlVXJsIjogImh0dHBzOi8vcmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbS9odW50ZXJqYW0vY29udGVudC1nZW5lcmF0aW9uLXNvbHV0aW9uLWFjY2VsZXJhdG9yL3JlZnMvaGVhZHMvbWFpbi9jb250ZW50LWdlbi9pbmZyYS92c2NvZGVfd2ViIiwgImluZGV4VXJsIjogIi9pbmRleC5qc29uIiwgInZhcmlhYmxlcyI6IHsiYWdlbnRJZCI6ICIiLCAiY29ubmVjdGlvblN0cmluZyI6ICIiLCAidGhyZWFkSWQiOiAiIiwgInVzZXJNZXNzYWdlIjogIiIsICJwbGF5Z3JvdW5kTmFtZSI6ICIiLCAibG9jYXRpb24iOiAiIiwgInN1YnNjcmlwdGlvbklkIjogIiIsICJyZXNvdXJjZUlkIjogIiIsICJwcm9qZWN0UmVzb3VyY2VJZCI6ICIiLCAiZW5kcG9pbnQiOiAiIn0sICJjb2RlUm91dGUiOiBbImFpLXByb2plY3RzLXNkayIsICJweXRob24iLCAiZGVmYXVsdC1henVyZS1hdXRoIiwgImVuZHBvaW50Il19) | |---|---|---|
@@ -104,14 +101,13 @@ _Note: This is not meant to outline all costs as selected SKUs, scaled use, cust | Product | Description | Cost | |---|---|---| | [Azure AI Foundry](https://learn.microsoft.com/en-us/azure/ai-foundry/) | Free tier. Build generative AI applications on an enterprise-grade platform. | [Pricing](https://azure.microsoft.com/pricing/details/ai-studio/) | -| [Azure AI Search](https://learn.microsoft.com/en-us/azure/search/) | Standard tier, S1. Pricing is based on the number of documents and operations. Information retrieval at scale for vector and text content in traditional or generative search scenarios. | [Pricing](https://azure.microsoft.com/pricing/details/search/) | -| [Azure Storage Account](https://learn.microsoft.com/en-us/azure/storage/blobs/) | Standard tier, LRS. Pricing is based on storage and operations. Blob storage in the clopud, optimized for storing massive amounts of unstructured data. | [Pricing](https://azure.microsoft.com/pricing/details/storage/blobs/) | -| [Azure Key Vault](https://learn.microsoft.com/en-us/azure/key-vault/) | Standard tier. Pricing is based on the number of operations. Maintain keys that access and encrypt your cloud resources, apps, and solutions. | [Pricing](https://azure.microsoft.com/pricing/details/key-vault/) | -| [Azure AI Services](https://learn.microsoft.com/en-us/azure/ai-services/) | S0 tier, defaults to gpt-4.1 and text-embedding-ada-002 models. Pricing is based on token count. | [Pricing](https://azure.microsoft.com/pricing/details/cognitive-services/) | -| [Azure Container App](https://learn.microsoft.com/en-us/azure/container-apps/) | Consumption tier with 0.5 CPU, 1GiB memory/storage. Pricing is based on resource allocation, and each month allows for a certain amount of free usage. Allows you to run containerized applications without worrying about orchestration or infrastructure. | [Pricing](https://azure.microsoft.com/pricing/details/container-apps/) | +| [Azure Storage Account](https://learn.microsoft.com/en-us/azure/storage/blobs/) | Standard tier, LRS. Pricing is based on storage and operations. Blob storage for product images and generated content. | [Pricing](https://azure.microsoft.com/pricing/details/storage/blobs/) | +| [Azure AI Services](https://learn.microsoft.com/en-us/azure/ai-services/) | S0 tier, defaults to gpt-5.1 (GPT) and gpt-image-1 (DALL-E 3) models. Pricing is based on token count. | [Pricing](https://azure.microsoft.com/pricing/details/cognitive-services/) | +| [Azure Container Instance](https://learn.microsoft.com/en-us/azure/container-instances/) | Backend API hosting with private VNet integration. Pricing is based on resource allocation. | [Pricing](https://azure.microsoft.com/pricing/details/container-instances/) | +| [Azure App Service](https://learn.microsoft.com/en-us/azure/app-service/) | B1 tier. Frontend hosting with Node.js proxy server. | [Pricing](https://azure.microsoft.com/pricing/details/app-service/) | | [Azure Container Registry](https://learn.microsoft.com/en-us/azure/container-registry/) | Basic tier. Build, store, and manage container images and artifacts in a private registry for all types of container deployments | [Pricing](https://azure.microsoft.com/pricing/details/container-registry/) | | [Log analytics](https://learn.microsoft.com/en-us/azure/azure-monitor/) | Pay-as-you-go tier. Costs based on data ingested. Collect and analyze on telemetry data generated by Azure. | [Pricing](https://azure.microsoft.com/pricing/details/monitor/) | -| [Azure Cosmos DB](https://learn.microsoft.com/en-us/azure/cosmos-db/) | Fully managed, distributed NoSQL, relational, and vector database for modern app development. | [Pricing](https://azure.microsoft.com/en-us/pricing/details/cosmos-db/autoscale-provisioned/) | +| [Azure Cosmos DB](https://learn.microsoft.com/en-us/azure/cosmos-db/) | Serverless tier. Product catalog and conversation history storage. | [Pricing](https://azure.microsoft.com/en-us/pricing/details/cosmos-db/autoscale-provisioned/) | @@ -121,17 +117,17 @@ _Note: This is not meant to outline all costs as selected SKUs, scaled use, cust either by deleting the resource group in the Portal or running `azd down`.
-
+
Business Scenario
-||
+||
|---|
-Put your data to work by reducing blank page anxiety, speeding up document drafting, improving draft document quality, and reference information quickly - keeping experts in their expertise. Draft document templates for your organization including Invoices, End-user Contracts, Purchase Orders, Investment Proposals, and Grant Submissions.
+Accelerate your marketing content creation by leveraging AI to interpret creative briefs and generate on-brand, multimodal content. The solution helps marketing teams reduce time-to-market for campaigns by automating the creation of compliant marketing copy and images grounded in product data.
⚠️ The sample data used in this repository is synthetic and generated using Azure OpenAI Service. The data is intended for use as sample data only.
@@ -140,42 +136,42 @@ Put your data to work by reducing blank page anxiety, speeding up document draft
Click to learn more about what value this solution provides
- - **Draft templates quickly**
- Put your data to work to create any kind of document that is supported by a large data library.
+ - **Interpret creative briefs**
+ Parse unstructured creative briefs into structured fields automatically, ensuring all campaign requirements are captured.
- - **Share**
- Share with co-authors, contributors and approvers quickly.
+ - **Generate multimodal content**
+ Create marketing copy and images that align with your brand voice and product catalog using GPT and DALL-E 3.
- - **Contextualize information**
- Provide context using natural language. Primary and secondary queries allow for access to supplemental detail – reducing cognitive load, increasing efficiency, and enabling focus on higher value work.
+ - **Ensure brand compliance**
+ Validate all generated content against brand guidelines with severity-categorized feedback before publication.
- - **Gain confidence in responses**
- Trust responses to queries by customizing how data is referenced and returned to users, reducing the risk of hallucinated responses.
Access reference documents in the same chat window to get more detail and confirm accuracy.
+ - **Ground in enterprise data**
+ Leverage product information, images, and brand guidelines stored in Azure to ensure accurate, relevant content.
- - **Secure data and responsible AI for innovation**
- Improve data security to minimize breaches, fostering a culture of responsible AI adoption, maximize innovation opportunities, and sustain competitive edge.
+ - **Secure data and responsible AI**
+ Maintain data security with managed identities and private networking while fostering responsible AI adoption.
-
+
Supporting documentation
### Security guidelines
-This template uses Azure Key Vault to store all connections to communicate between resources.
+This template uses [Managed Identity](https://learn.microsoft.com/entra/identity/managed-identities-azure-resources/overview) for authentication between Azure services.
-This template also uses [Managed Identity](https://learn.microsoft.com/entra/identity/managed-identities-azure-resources/overview) for local development and deployment.
+The backend runs in Azure Container Instance within a private VNet subnet, accessible only through the App Service frontend proxy. Private networking can be enabled via the `enablePrivateNetworking` parameter.
To ensure continued best practices in your own repository, we recommend that anyone creating solutions based on our templates ensure that the [Github secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning) setting is enabled.
You may want to consider additional security measures, such as:
* Enabling Microsoft Defender for Cloud to [secure your Azure resources](https://learn.microsoft.com/azure/defender-for-cloud).
-* Protecting the Azure Container Apps instance with a [firewall](https://learn.microsoft.com/azure/container-apps/waf-app-gateway) and/or [Virtual Network](https://learn.microsoft.com/azure/container-apps/networking?tabs=workload-profiles-env%2Cazure-cli).
+* Protecting the Azure App Service with [authentication](https://learn.microsoft.com/azure/app-service/overview-authentication-authorization) and/or [Virtual Network integration](https://learn.microsoft.com/azure/app-service/overview-vnet-integration).
@@ -199,7 +195,7 @@ Have questions, find a bug, or want to request a feature? [Submit a new issue](h
## Responsible AI Transparency FAQ
-Please refer to [Transparency FAQ](./docs/TRANSPARENCY_FAQ.md) for responsible AI transparency details of this solution accelerator.
+Please refer to [Transparency FAQ](./content-gen/docs/TRANSPARENCY_FAQ.md) for responsible AI transparency details of this solution accelerator.
diff --git a/TRANSITION_DOCUMENT.md b/TRANSITION_DOCUMENT.md
new file mode 100644
index 000000000..2797fcbd6
--- /dev/null
+++ b/TRANSITION_DOCUMENT.md
@@ -0,0 +1,399 @@
+# Content Generation Solution Accelerator - Transition Document
+
+**Date:** January 16, 2026
+**Prepared for:** Incoming Engineer
+**Repository:** https://github.com/hunterjam/content-generation-solution-accelerator
+**Upstream:** https://github.com/microsoft/document-generation-solution-accelerator
+
+---
+
+## 1. Project Overview
+
+This is a **multimodal content generation solution** for retail marketing campaigns. It uses Microsoft Agent Framework with HandoffBuilder orchestration to interpret creative briefs and generate compliant marketing content (text + images) grounded in enterprise product data and brand guidelines.
+
+### Key Capabilities
+- Parse free-text creative briefs into structured fields
+- Generate marketing copy using GPT models
+- Generate marketing images using DALL-E 3
+- Validate content against brand guidelines with severity-categorized compliance checks
+- Ground content in product catalog data from Cosmos DB
+
+---
+
+## 2. System Architecture & How It Works
+
+### High-Level Flow
+
+```
+User → Frontend (React) → Backend API (Python/Quart) → Agent Orchestrator → Azure OpenAI
+ ↓
+ Multi-Agent System
+ ↓
+ ┌───────────────┼───────────────┐
+ ↓ ↓ ↓
+ TriageAgent → PlanningAgent → ResearchAgent
+ ↓ ↓ ↓
+ TextContentAgent ImageContentAgent ComplianceAgent
+ ↓ ↓ ↓
+ └───────────────┼───────────────┘
+ ↓
+ Generated Content
+ (Text + Image + Compliance)
+```
+
+### The Agent System
+
+The solution uses **Microsoft Agent Framework** with **HandoffBuilder orchestration**. This means agents can dynamically hand off control to each other based on context. Here's how each agent works:
+
+| Agent | Responsibility | Inputs | Outputs |
+|-------|---------------|--------|---------|
+| **TriageAgent** | Coordinator - routes requests to the right specialist | User message | Handoff decision |
+| **PlanningAgent** | Parses creative briefs into structured fields, asks clarifying questions if info is missing | Free-text brief | Structured `CreativeBrief` JSON |
+| **ResearchAgent** | Retrieves product data from Cosmos DB, fetches brand guidelines | Product queries | Product details, brand info |
+| **TextContentAgent** | Generates marketing copy (headlines, body, CTAs, hashtags) | Brief + Products | Marketing copy JSON |
+| **ImageContentAgent** | Creates DALL-E prompts and generates images | Brief + Products | Image URL + prompt |
+| **ComplianceAgent** | Validates content against brand guidelines | Generated content | Violations list with severity |
+
+### Content Generation Workflow
+
+When a user submits a creative brief, this is what happens:
+
+1. **Brief Parsing** (PlanningAgent)
+ - User submits free-text brief like "Create a spring campaign for our new green paint colors"
+ - PlanningAgent extracts structured fields: objectives, target audience, key message, tone, deliverables
+ - If critical fields are missing, agent asks clarifying questions
+ - User confirms the parsed brief
+
+2. **Product Selection** (ResearchAgent)
+ - System queries Cosmos DB for matching products
+ - Products are presented to user for confirmation
+ - User can add/remove products from selection
+
+3. **Content Generation** (TextContentAgent + ImageContentAgent)
+ - **Text**: GPT generates headline, body copy, CTA, hashtags based on brief + products
+ - **Image**: DALL-E generates marketing image with product context
+ - If product has an image (`image_url`), it's overlaid on the generated background
+
+4. **Compliance Check** (ComplianceAgent)
+ - Validates content against brand guidelines
+ - Returns violations categorized by severity:
+ - **Error**: Must fix before use (blocks acceptance)
+ - **Warning**: Review recommended
+ - **Info**: Optional improvements
+
+5. **Response to User**
+ - Frontend displays generated content with compliance status
+ - User can regenerate, modify, or accept
+
+### Key Data Structures
+
+**CreativeBrief** (what the PlanningAgent extracts):
+```typescript
+{
+ overview: string; // Campaign summary
+ objectives: string; // Goals and KPIs
+ target_audience: string; // Who it's for
+ key_message: string; // Core value proposition
+ tone_and_style: string; // Voice (professional, playful, etc.)
+ deliverable: string; // Output type (social post, email, etc.)
+ timelines: string; // Deadlines
+ visual_guidelines: string; // Image style requirements
+ cta: string; // Call to action
+}
+```
+
+**Product** (from Cosmos DB):
+```typescript
+{
+ product_name: string;
+ description: string;
+ tags: string;
+ price: number;
+ sku: string;
+ image_url?: string; // Product image for overlay
+ hex_value?: string; // Color hex code for paint products
+}
+```
+
+**GeneratedContent** (what the system produces):
+```typescript
+{
+ text_content: {
+ headline: string;
+ body: string;
+ cta_text: string;
+ tagline: string;
+ };
+ image_content: {
+ image_url: string; // Generated or composite image
+ alt_text: string;
+ prompt_used: string; // The DALL-E prompt
+ };
+ violations: ComplianceViolation[];
+ requires_modification: boolean; // True if any "error" violations
+}
+```
+
+### Image Generation Details
+
+The image generation has special logic for **product overlay**:
+
+1. If the product has an `image_url` (e.g., a paint can image):
+ - DALL-E generates a **background scene** (e.g., living room with the paint color)
+ - The product image is **composited** onto the background
+ - This ensures the actual product packaging appears in the marketing image
+
+2. If no product image:
+ - DALL-E generates a complete scene
+ - No overlay is applied
+
+3. **Text-free images**: The system instructs DALL-E to generate images without text overlays, as text rendering in AI images is often poor quality.
+
+### Frontend-Backend Communication
+
+The frontend uses **Server-Sent Events (SSE)** for streaming responses:
+
+1. Frontend calls `/api/generate/start` with brief + products
+2. Backend returns a `task_id` immediately
+3. Frontend polls `/api/generate/status/{task_id}` every second
+4. Backend returns progress updates (heartbeats with stage info)
+5. When complete, backend returns the full `GeneratedContent`
+
+This polling approach handles the 30-60 second generation time without timeouts.
+
+### Content Safety
+
+The system has multiple layers of content safety:
+
+1. **Input filtering** (`orchestrator.py`): Regex patterns block harmful requests before they reach agents
+2. **Agent instructions**: Each agent has explicit refusal instructions for inappropriate content
+3. **Azure OpenAI content filters**: Built-in filters on the AI models
+4. **Compliance validation**: Final check against brand guidelines
+
+---
+
+## 3. Repository Structure
+
+```
+content-generation-solution-accelerator/
+├── content-gen/ # Main application (THIS IS THE ACTIVE CODE)
+│ ├── src/
+│ │ ├── app/ # Frontend application
+│ │ │ ├── frontend/ # React + Vite + TypeScript + Fluent UI
+│ │ │ │ └── src/
+│ │ │ │ ├── components/ # React components
+│ │ │ │ ├── api/ # API client functions
+│ │ │ │ └── types/ # TypeScript interfaces
+│ │ │ └── WebApp.Dockerfile # Frontend container build
+│ │ └── backend/ # Python backend
+│ │ ├── agents/ # AI agent implementations
+│ │ ├── api/ # API route handlers
+│ │ ├── services/ # Business logic services
+│ │ ├── orchestrator.py # Agent orchestration logic
+│ │ ├── settings.py # Configuration/environment
+│ │ └── ApiApp.Dockerfile # Backend container build
+│ ├── scripts/ # Deployment and data scripts
+│ │ └── post_deploy.py # Product data seeding
+│ ├── infra/ # Bicep infrastructure as code
+│ └── docs/ # Documentation
+├── archive-doc-gen/ # Legacy document generation (separate app)
+└── docs/ # Root-level documentation
+```
+
+---
+
+## 4. Key Files Reference
+
+### Backend
+| File | Purpose |
+|------|---------|
+| `src/backend/orchestrator.py` | Main agent orchestration, content generation workflow |
+| `src/backend/agents/image_content_agent.py` | DALL-E image generation logic |
+| `src/backend/settings.py` | All environment variables and configuration |
+| `src/backend/api/` | REST API endpoints |
+| `src/backend/services/` | Cosmos DB, storage, AI service integrations |
+
+### Frontend
+| File | Purpose |
+|------|---------|
+| `src/app/frontend/src/App.tsx` | Main React application |
+| `src/app/frontend/src/components/ChatPanel.tsx` | Main chat interface |
+| `src/app/frontend/src/components/InlineContentPreview.tsx` | Content display with compliance status |
+| `src/app/frontend/src/api/index.ts` | API client functions |
+| `src/app/frontend/src/types/index.ts` | TypeScript type definitions |
+
+### Deployment
+| File | Purpose |
+|------|---------|
+| `scripts/post_deploy.py` | Seeds sample product data to Cosmos DB |
+| `infra/main.bicep` | Azure infrastructure definition |
+| `azure.yaml` | Azure Developer CLI configuration |
+
+---
+
+## 5. Recent Changes (Last Session)
+
+### Commits Merged to Main
+
+1. **Fix image generation overlay handling** - Improved how product images are overlaid on generated backgrounds
+2. **Fix product/campaign logic** - Corrected color descriptions for paint products (Quiet Moss, Cloud Drift, Pine Shadow)
+3. **Add multi-product handling instructions** - Enhanced orchestrator to handle campaigns with multiple products
+4. **Add user guidance callouts** - Added clear "Action needed" / "Optional review" messages in UI for compliance status
+5. **Remove unused components** - Cleaned up dead code:
+ - `ContentPreview.tsx` (replaced by `InlineContentPreview.tsx`)
+ - `TaskHeader.tsx`
+ - Unused API functions (`getProducts`, `uploadProductImage`, `getBrandGuidelines`, `getConversations`, `getConversation`)
+ - Unused types (`ComplianceSeverity`, `ContentResponse`)
+
+### Important Discovery
+The frontend uses **`InlineContentPreview.tsx`** for displaying generated content, NOT `ContentPreview.tsx`. The latter was dead code and has been removed.
+
+---
+
+## 6. Development Workflow
+
+### Local Development
+
+```bash
+# Backend
+cd content-gen/src/backend
+pip install -r requirements.txt
+python app.py
+
+# Frontend
+cd content-gen/src/app/frontend
+npm install
+npm run dev
+```
+
+### Building & Deploying Containers
+
+```bash
+# Build and push frontend (using ACR build)
+az acr build --registry \
+ --image content-gen-webapp:latest \
+ --file content-gen/src/app/WebApp.Dockerfile \
+ content-gen/src/app
+
+# Build and push backend
+az acr build --registry \
+ --image content-gen-api:latest \
+ --file content-gen/src/backend/ApiApp.Dockerfile \
+ content-gen/src/backend
+
+# Restart services to pull new images
+az webapp restart --name --resource-group
+az container restart --name --resource-group
+```
+
+---
+
+## 7. Git Workflow
+
+### Branches
+- `main` - Production branch
+- `fix-image-generation-overlay` - Recent image generation fixes (merged)
+- `cleanup-unused-frontend-code` - Code cleanup (merged)
+
+### Remotes
+- `origin` - Fork: `hunterjam/content-generation-solution-accelerator`
+- `upstream` - Microsoft repo: `microsoft/document-generation-solution-accelerator`
+
+### Syncing with Upstream
+```bash
+git fetch upstream
+git merge upstream/main
+```
+
+---
+
+## 8. Environment Variables
+
+Key settings in `src/backend/settings.py`:
+
+| Variable | Description |
+|----------|-------------|
+| `AZURE_OPENAI_ENDPOINT` | Azure OpenAI endpoint for GPT |
+| `AZURE_OPENAI_DEPLOYMENT_NAME` | GPT model deployment name |
+| `AZURE_OPENAI_DALLE_ENDPOINT` | DALL-E endpoint (if separate) |
+| `AZURE_OPENAI_DALLE_DEPLOYMENT` | DALL-E deployment name |
+| `COSMOS_ENDPOINT` | Cosmos DB endpoint |
+| `COSMOS_DATABASE` | Database name |
+| `AZURE_STORAGE_ACCOUNT_NAME` | Blob storage account |
+| `ENABLE_IMAGE_GENERATION` | Toggle image generation feature |
+
+---
+
+## 9. Useful Commands
+
+```bash
+# View container logs
+az webapp log tail --name --resource-group
+
+# Check container configuration
+az webapp config container show --name --resource-group
+
+# List ACR images
+az acr repository list --name
+
+# Check image tags
+az acr repository show-tags --name --repository content-gen-webapp
+```
+
+---
+
+## 10. Contact & Resources
+
+- **Project README:** `content-gen/README.md`
+- **Deployment Docs:** `content-gen/docs/`
+- **Upstream Issues:** https://github.com/microsoft/document-generation-solution-accelerator/issues
+
+---
+
+## 11. Quick Start for New Engineer
+
+1. **Clone and setup:**
+ ```bash
+ git clone https://github.com/hunterjam/content-generation-solution-accelerator.git
+ cd content-generation-solution-accelerator
+ ```
+
+2. **Open in VS Code with Dev Container** (recommended)
+
+3. **Login to Azure:**
+ ```bash
+ az login
+ az account set --subscription
+ az acr login --name
+ ```
+
+4. **Run locally:**
+ ```bash
+ # Terminal 1 - Backend
+ cd content-gen/src/backend
+ pip install -r requirements.txt
+ # Set environment variables (see settings.py)
+ python app.py
+
+ # Terminal 2 - Frontend
+ cd content-gen/src/app/frontend
+ npm install
+ npm run dev
+ ```
+
+5. **Make changes and deploy:**
+ ```bash
+ # After code changes
+ git checkout -b feature/your-feature
+ # Make changes...
+ git commit -am "Your change"
+
+ # Build and deploy (replace placeholders with your Azure resources)
+ az acr build --registry --image content-gen-webapp:latest \
+ --file content-gen/src/app/WebApp.Dockerfile content-gen/src/app
+ az webapp restart --name --resource-group
+ ```
+
+---
+
+*Document generated: January 16, 2026*
diff --git a/.azdo/pipelines/azure-dev.yml b/archive-doc-gen/.azdo/pipelines/azure-dev.yml
similarity index 100%
rename from .azdo/pipelines/azure-dev.yml
rename to archive-doc-gen/.azdo/pipelines/azure-dev.yml
diff --git a/archive-doc-gen/.devcontainer/devcontainer.json b/archive-doc-gen/.devcontainer/devcontainer.json
new file mode 100644
index 000000000..f143c9dc4
--- /dev/null
+++ b/archive-doc-gen/.devcontainer/devcontainer.json
@@ -0,0 +1,38 @@
+{
+ "name": "azd-template",
+ "image": "mcr.microsoft.com/devcontainers/python:3.11-bullseye",
+ "forwardPorts": [50505],
+ "features": {
+ "ghcr.io/devcontainers/features/node:1": {
+ "nodeGypDependencies": true,
+ "installYarnUsingApt": true,
+ "version": "lts",
+ "pnpmVersion": "latest",
+ "nvmVersion": "latest"
+ },
+ "ghcr.io/devcontainers/features/azure-cli:1": {
+ "installBicep": true,
+ "version": "latest",
+ "bicepVersion": "latest"
+ },
+ "ghcr.io/azure/azure-dev/azd:0": {
+ "version": "stable"
+ }
+ },
+ "customizations": {
+ "vscode": {
+ "extensions": [
+ "ms-azuretools.azure-dev",
+ "ms-azuretools.vscode-bicep",
+ "ms-python.python",
+ "ms-toolsai.jupyter",
+ "GitHub.vscode-github-actions"
+ ]
+ }
+ },
+ "postCreateCommand": "bash ./.devcontainer/setup_env.sh",
+ "remoteUser": "vscode",
+ "hostRequirements": {
+ "memory": "4gb"
+ }
+}
diff --git a/archive-doc-gen/.devcontainer/setup_env.sh b/archive-doc-gen/.devcontainer/setup_env.sh
new file mode 100644
index 000000000..91de5b222
--- /dev/null
+++ b/archive-doc-gen/.devcontainer/setup_env.sh
@@ -0,0 +1,7 @@
+#!/bin/bash
+
+git fetch
+git pull
+
+# provide execute permission to quotacheck script
+sudo chmod +x ./scripts/quota_check_params.sh
\ No newline at end of file
diff --git a/.flake8 b/archive-doc-gen/.flake8
similarity index 100%
rename from .flake8
rename to archive-doc-gen/.flake8
diff --git a/archive-doc-gen/.gitattributes b/archive-doc-gen/.gitattributes
new file mode 100644
index 000000000..314766e91
--- /dev/null
+++ b/archive-doc-gen/.gitattributes
@@ -0,0 +1,3 @@
+* text=auto eol=lf
+*.{cmd,[cC][mM][dD]} text eol=crlf
+*.{bat,[bB][aA][tT]} text eol=crlf
diff --git a/.github/CODEOWNERS b/archive-doc-gen/.github/CODEOWNERS
similarity index 100%
rename from .github/CODEOWNERS
rename to archive-doc-gen/.github/CODEOWNERS
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/archive-doc-gen/.github/ISSUE_TEMPLATE/bug_report.md
similarity index 100%
rename from .github/ISSUE_TEMPLATE/bug_report.md
rename to archive-doc-gen/.github/ISSUE_TEMPLATE/bug_report.md
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/archive-doc-gen/.github/ISSUE_TEMPLATE/feature_request.md
similarity index 100%
rename from .github/ISSUE_TEMPLATE/feature_request.md
rename to archive-doc-gen/.github/ISSUE_TEMPLATE/feature_request.md
diff --git a/.github/ISSUE_TEMPLATE/subtask.md b/archive-doc-gen/.github/ISSUE_TEMPLATE/subtask.md
similarity index 100%
rename from .github/ISSUE_TEMPLATE/subtask.md
rename to archive-doc-gen/.github/ISSUE_TEMPLATE/subtask.md
diff --git a/.github/dependabot.yml b/archive-doc-gen/.github/dependabot.yml
similarity index 100%
rename from .github/dependabot.yml
rename to archive-doc-gen/.github/dependabot.yml
diff --git a/.github/pull_request_template.md b/archive-doc-gen/.github/pull_request_template.md
similarity index 100%
rename from .github/pull_request_template.md
rename to archive-doc-gen/.github/pull_request_template.md
diff --git a/.github/workflows/Scheduled-Dependabot-PRs-Auto-Merge.yml b/archive-doc-gen/.github/workflows/Scheduled-Dependabot-PRs-Auto-Merge.yml
similarity index 100%
rename from .github/workflows/Scheduled-Dependabot-PRs-Auto-Merge.yml
rename to archive-doc-gen/.github/workflows/Scheduled-Dependabot-PRs-Auto-Merge.yml
diff --git a/archive-doc-gen/.github/workflows/azure-dev.yml b/archive-doc-gen/.github/workflows/azure-dev.yml
new file mode 100644
index 000000000..6f1c6305f
--- /dev/null
+++ b/archive-doc-gen/.github/workflows/azure-dev.yml
@@ -0,0 +1,35 @@
+name: Azure Template Validation
+on:
+ workflow_dispatch:
+
+permissions:
+ contents: read
+ id-token: write
+ pull-requests: write
+
+jobs:
+ template_validation_job:
+ runs-on: ubuntu-latest
+ name: Template validation
+
+ steps:
+ # Step 1: Checkout the code from your repository
+ - name: Checkout code
+ uses: actions/checkout@v6
+
+ # Step 2: Validate the Azure template using microsoft/template-validation-action
+ - name: Validate Azure Template
+ uses: microsoft/template-validation-action@v0.4.4
+ id: validation
+ env:
+ AZURE_CLIENT_ID: ${{ secrets.AZURE_CLIENT_ID }}
+ AZURE_TENANT_ID: ${{ secrets.AZURE_TENANT_ID }}
+ AZURE_SUBSCRIPTION_ID: ${{ secrets.AZURE_SUBSCRIPTION_ID }}
+ AZURE_ENV_NAME: ${{ secrets.AZURE_ENV_NAME }}
+ AZURE_LOCATION: ${{ secrets.AZURE_LOCATION }}
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ AZURE_DEV_COLLECT_TELEMETRY: ${{ vars.AZURE_DEV_COLLECT_TELEMETRY }}
+
+ # Step 3: Print the result of the validation
+ - name: Print result
+ run: cat ${{ steps.validation.outputs.resultFile }}
\ No newline at end of file
diff --git a/.github/workflows/broken-links-checker.yml b/archive-doc-gen/.github/workflows/broken-links-checker.yml
similarity index 100%
rename from .github/workflows/broken-links-checker.yml
rename to archive-doc-gen/.github/workflows/broken-links-checker.yml
diff --git a/archive-doc-gen/.github/workflows/create-release.yml b/archive-doc-gen/.github/workflows/create-release.yml
new file mode 100644
index 000000000..c45474d51
--- /dev/null
+++ b/archive-doc-gen/.github/workflows/create-release.yml
@@ -0,0 +1,64 @@
+on:
+ push:
+ branches:
+ - main
+
+permissions:
+ contents: write
+ pull-requests: write
+
+name: Create-Release
+
+jobs:
+ create-release:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v6
+ with:
+ ref: ${{ github.event.workflow_run.head_sha }}
+
+ - uses: codfish/semantic-release-action@v4
+ id: semantic
+ with:
+ tag-format: 'v${version}'
+ additional-packages: |
+ ['conventional-changelog-conventionalcommits@7']
+ plugins: |
+ [
+ [
+ "@semantic-release/commit-analyzer",
+ {
+ "preset": "conventionalcommits"
+ }
+ ],
+ [
+ "@semantic-release/release-notes-generator",
+ {
+ "preset": "conventionalcommits",
+ "presetConfig": {
+ "types": [
+ { type: 'feat', section: 'Features', hidden: false },
+ { type: 'fix', section: 'Bug Fixes', hidden: false },
+ { type: 'perf', section: 'Performance Improvements', hidden: false },
+ { type: 'revert', section: 'Reverts', hidden: false },
+ { type: 'docs', section: 'Other Updates', hidden: false },
+ { type: 'style', section: 'Other Updates', hidden: false },
+ { type: 'chore', section: 'Other Updates', hidden: false },
+ { type: 'refactor', section: 'Other Updates', hidden: false },
+ { type: 'test', section: 'Other Updates', hidden: false },
+ { type: 'build', section: 'Other Updates', hidden: false },
+ { type: 'ci', section: 'Other Updates', hidden: false }
+ ]
+ }
+ }
+ ],
+ '@semantic-release/github'
+ ]
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ - run: echo ${{ steps.semantic.outputs.release-version }}
+
+ - run: echo "$OUTPUTS"
+ env:
+ OUTPUTS: ${{ toJson(steps.semantic.outputs) }}
diff --git a/archive-doc-gen/.github/workflows/deploy-linux.yml b/archive-doc-gen/.github/workflows/deploy-linux.yml
new file mode 100644
index 000000000..c45aae3f5
--- /dev/null
+++ b/archive-doc-gen/.github/workflows/deploy-linux.yml
@@ -0,0 +1,283 @@
+name: Deploy-Test-Cleanup (v2) Linux
+on:
+ pull_request:
+ branches:
+ - main
+ paths:
+ - 'src/frontend/**'
+ - 'src/**/*.py'
+ - 'src/requirements*.txt'
+ - 'src/WebApp.Dockerfile'
+ - '!src/tests/**'
+ - 'infra/**/*.bicep'
+ - 'infra/**/*.json'
+ - '*.yaml'
+ - '.github/workflows/deploy-*.yml'
+ workflow_run:
+ workflows: ["Build Docker and Optional Push"]
+ types:
+ - completed
+ branches:
+ - main
+ - dev
+ - demo
+ workflow_dispatch:
+ inputs:
+ azure_location:
+ description: 'Azure Location For Deployment'
+ required: false
+ default: 'australiaeast'
+ type: choice
+ options:
+ - 'australiaeast'
+ - 'centralus'
+ - 'eastasia'
+ - 'eastus2'
+ - 'japaneast'
+ - 'northeurope'
+ - 'southeastasia'
+ - 'uksouth'
+ resource_group_name:
+ description: 'Resource Group Name (Optional)'
+ required: false
+ default: ''
+ type: string
+
+ waf_enabled:
+ description: 'Enable WAF'
+ required: false
+ default: false
+ type: boolean
+ EXP:
+ description: 'Enable EXP'
+ required: false
+ default: false
+ type: boolean
+ build_docker_image:
+ description: 'Build And Push Docker Image (Optional)'
+ required: false
+ default: false
+ type: boolean
+
+ cleanup_resources:
+ description: 'Cleanup Deployed Resources'
+ required: false
+ default: false
+ type: boolean
+
+ run_e2e_tests:
+ description: 'Run End-to-End Tests'
+ required: false
+ default: 'GoldenPath-Testing'
+ type: choice
+ options:
+ - 'GoldenPath-Testing'
+ - 'Smoke-Testing'
+ - 'None'
+
+ AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID:
+ description: 'Log Analytics Workspace ID (Optional)'
+ required: false
+ default: ''
+ type: string
+ AZURE_EXISTING_AI_PROJECT_RESOURCE_ID:
+ description: 'AI Project Resource ID (Optional)'
+ required: false
+ default: ''
+ type: string
+ existing_webapp_url:
+ description: 'Existing WebApp URL (Skips Deployment)'
+ required: false
+ default: ''
+ type: string
+
+ schedule:
+ - cron: '0 9,21 * * *' # Runs at 9:00 AM and 9:00 PM GMT
+permissions:
+ contents: read
+ actions: read
+jobs:
+ validate-inputs:
+ runs-on: ubuntu-latest
+ outputs:
+ validation_passed: ${{ steps.validate.outputs.passed }}
+ azure_location: ${{ steps.validate.outputs.azure_location }}
+ resource_group_name: ${{ steps.validate.outputs.resource_group_name }}
+ waf_enabled: ${{ steps.validate.outputs.waf_enabled }}
+ exp: ${{ steps.validate.outputs.exp }}
+ build_docker_image: ${{ steps.validate.outputs.build_docker_image }}
+ cleanup_resources: ${{ steps.validate.outputs.cleanup_resources }}
+ run_e2e_tests: ${{ steps.validate.outputs.run_e2e_tests }}
+ azure_env_log_analytics_workspace_id: ${{ steps.validate.outputs.azure_env_log_analytics_workspace_id }}
+ azure_existing_ai_project_resource_id: ${{ steps.validate.outputs.azure_existing_ai_project_resource_id }}
+ existing_webapp_url: ${{ steps.validate.outputs.existing_webapp_url }}
+ steps:
+ - name: Validate Workflow Input Parameters
+ id: validate
+ shell: bash
+ env:
+ INPUT_AZURE_LOCATION: ${{ github.event.inputs.azure_location }}
+ INPUT_RESOURCE_GROUP_NAME: ${{ github.event.inputs.resource_group_name }}
+ INPUT_WAF_ENABLED: ${{ github.event.inputs.waf_enabled }}
+ INPUT_EXP: ${{ github.event.inputs.EXP }}
+ INPUT_BUILD_DOCKER_IMAGE: ${{ github.event.inputs.build_docker_image }}
+ INPUT_CLEANUP_RESOURCES: ${{ github.event.inputs.cleanup_resources }}
+ INPUT_RUN_E2E_TESTS: ${{ github.event.inputs.run_e2e_tests }}
+ INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID: ${{ github.event.inputs.AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID }}
+ INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID: ${{ github.event.inputs.AZURE_EXISTING_AI_PROJECT_RESOURCE_ID }}
+ INPUT_EXISTING_WEBAPP_URL: ${{ github.event.inputs.existing_webapp_url }}
+ run: |
+ echo "🔍 Validating workflow input parameters..."
+ VALIDATION_FAILED=false
+
+ # Validate azure_location (Azure region format)
+ LOCATION="${INPUT_AZURE_LOCATION:-australiaeast}"
+
+ if [[ ! "$LOCATION" =~ ^[a-z0-9]+$ ]]; then
+ echo "❌ ERROR: azure_location '$LOCATION' is invalid. Must contain only lowercase letters and numbers"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ azure_location: '$LOCATION' is valid"
+ fi
+
+ # Validate resource_group_name (Azure naming convention, optional)
+ if [[ -n "$INPUT_RESOURCE_GROUP_NAME" ]]; then
+ if [[ ! "$INPUT_RESOURCE_GROUP_NAME" =~ ^[a-zA-Z0-9._\(\)-]+$ ]] || [[ "$INPUT_RESOURCE_GROUP_NAME" =~ \.$ ]]; then
+ echo "❌ ERROR: resource_group_name '$INPUT_RESOURCE_GROUP_NAME' is invalid. Must contain only alphanumerics, periods, underscores, hyphens, and parentheses. Cannot end with period."
+ VALIDATION_FAILED=true
+ elif [[ ${#INPUT_RESOURCE_GROUP_NAME} -gt 90 ]]; then
+ echo "❌ ERROR: resource_group_name '$INPUT_RESOURCE_GROUP_NAME' exceeds 90 characters (length: ${#INPUT_RESOURCE_GROUP_NAME})"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ resource_group_name: '$INPUT_RESOURCE_GROUP_NAME' is valid"
+ fi
+ else
+ echo "✅ resource_group_name: Not provided (will be auto-generated)"
+ fi
+
+ # Validate waf_enabled (boolean)
+ WAF_ENABLED="${INPUT_WAF_ENABLED:-false}"
+ if [[ "$WAF_ENABLED" != "true" && "$WAF_ENABLED" != "false" ]]; then
+ echo "❌ ERROR: waf_enabled must be 'true' or 'false', got: '$WAF_ENABLED'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ waf_enabled: '$WAF_ENABLED' is valid"
+ fi
+
+ # Validate EXP (boolean)
+ EXP_ENABLED="${INPUT_EXP:-false}"
+ if [[ "$EXP_ENABLED" != "true" && "$EXP_ENABLED" != "false" ]]; then
+ echo "❌ ERROR: EXP must be 'true' or 'false', got: '$EXP_ENABLED'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ EXP: '$EXP_ENABLED' is valid"
+ fi
+
+ # Validate build_docker_image (boolean)
+ BUILD_DOCKER="${INPUT_BUILD_DOCKER_IMAGE:-false}"
+ if [[ "$BUILD_DOCKER" != "true" && "$BUILD_DOCKER" != "false" ]]; then
+ echo "❌ ERROR: build_docker_image must be 'true' or 'false', got: '$BUILD_DOCKER'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ build_docker_image: '$BUILD_DOCKER' is valid"
+ fi
+
+ # Validate cleanup_resources (boolean)
+ CLEANUP_RESOURCES="${INPUT_CLEANUP_RESOURCES:-false}"
+ if [[ "$CLEANUP_RESOURCES" != "true" && "$CLEANUP_RESOURCES" != "false" ]]; then
+ echo "❌ ERROR: cleanup_resources must be 'true' or 'false', got: '$CLEANUP_RESOURCES'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ cleanup_resources: '$CLEANUP_RESOURCES' is valid"
+ fi
+
+ # Validate run_e2e_tests (specific allowed values)
+ TEST_OPTION="${INPUT_RUN_E2E_TESTS:-GoldenPath-Testing}"
+ if [[ "$TEST_OPTION" != "GoldenPath-Testing" && "$TEST_OPTION" != "Smoke-Testing" && "$TEST_OPTION" != "None" ]]; then
+ echo "❌ ERROR: run_e2e_tests must be one of: GoldenPath-Testing, Smoke-Testing, None, got: '$TEST_OPTION'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ run_e2e_tests: '$TEST_OPTION' is valid"
+ fi
+
+ # Validate AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID (optional, Azure Resource ID format)
+ if [[ -n "$INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID" ]]; then
+ if [[ ! "$INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID" =~ ^/subscriptions/[a-fA-F0-9-]+/[Rr]esource[Gg]roups/[^/]+/providers/[Mm]icrosoft\.[Oo]perational[Ii]nsights/[Ww]orkspaces/[^/]+$ ]]; then
+ echo "❌ ERROR: AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID is invalid. Must be a valid Azure Resource ID format:"
+ echo " /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}"
+ echo " Got: '$INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID: Valid Resource ID format"
+ fi
+ else
+ echo "✅ AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID: Not provided (optional)"
+ fi
+
+ # Validate AZURE_EXISTING_AI_PROJECT_RESOURCE_ID (optional, Azure Resource ID format)
+ if [[ -n "$INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID" ]]; then
+ if [[ ! "$INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID" =~ ^/subscriptions/[a-fA-F0-9-]+/[Rr]esource[Gg]roups/[^/]+/providers/([Mm]icrosoft\.[Mm]achine[Ll]earning[Ss]ervices/([Ww]orkspaces|[Pp]rojects)/[^/]+|[Mm]icrosoft\.[Cc]ognitive[Ss]ervices/[Aa]ccounts/[^/]+/[Pp]rojects/[^/]+)$ ]]; then
+ echo "❌ ERROR: AZURE_EXISTING_AI_PROJECT_RESOURCE_ID is invalid. Must be a valid Azure Resource ID format:"
+ echo " /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}"
+ echo " Got: '$INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ AZURE_EXISTING_AI_PROJECT_RESOURCE_ID: Valid Resource ID format"
+ fi
+ else
+ echo "✅ AZURE_EXISTING_AI_PROJECT_RESOURCE_ID: Not provided (optional)"
+ fi
+
+ # Validate existing_webapp_url (optional, must start with https)
+ if [[ -n "$INPUT_EXISTING_WEBAPP_URL" ]]; then
+ if [[ ! "$INPUT_EXISTING_WEBAPP_URL" =~ ^https:// ]]; then
+ echo "❌ ERROR: existing_webapp_url must start with 'https://', got: '$INPUT_EXISTING_WEBAPP_URL'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ existing_webapp_url: '$INPUT_EXISTING_WEBAPP_URL' is valid"
+ fi
+ else
+ echo "✅ existing_webapp_url: Not provided (will perform deployment)"
+ fi
+
+ # Fail workflow if any validation failed
+ if [[ "$VALIDATION_FAILED" == "true" ]]; then
+ echo ""
+ echo "❌ Parameter validation failed. Please correct the errors above and try again."
+ exit 1
+ fi
+
+ echo ""
+ echo "✅ All input parameters validated successfully!"
+
+ # Output validated values
+ echo "passed=true" >> $GITHUB_OUTPUT
+ echo "azure_location=$LOCATION" >> $GITHUB_OUTPUT
+ echo "resource_group_name=$INPUT_RESOURCE_GROUP_NAME" >> $GITHUB_OUTPUT
+ echo "waf_enabled=$WAF_ENABLED" >> $GITHUB_OUTPUT
+ echo "exp=$EXP_ENABLED" >> $GITHUB_OUTPUT
+ echo "build_docker_image=$BUILD_DOCKER" >> $GITHUB_OUTPUT
+ echo "cleanup_resources=$CLEANUP_RESOURCES" >> $GITHUB_OUTPUT
+ echo "run_e2e_tests=$TEST_OPTION" >> $GITHUB_OUTPUT
+ echo "azure_env_log_analytics_workspace_id=$INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID" >> $GITHUB_OUTPUT
+ echo "azure_existing_ai_project_resource_id=$INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID" >> $GITHUB_OUTPUT
+ echo "existing_webapp_url=$INPUT_EXISTING_WEBAPP_URL" >> $GITHUB_OUTPUT
+
+ Run:
+ needs: validate-inputs
+ if: needs.validate-inputs.outputs.validation_passed == 'true'
+ uses: ./.github/workflows/deploy-orchestrator.yml
+ with:
+ runner_os: ubuntu-latest
+ azure_location: ${{ needs.validate-inputs.outputs.azure_location || 'australiaeast' }}
+ resource_group_name: ${{ needs.validate-inputs.outputs.resource_group_name || '' }}
+ waf_enabled: ${{ needs.validate-inputs.outputs.waf_enabled == 'true' }}
+ EXP: ${{ needs.validate-inputs.outputs.exp == 'true' }}
+ build_docker_image: ${{ needs.validate-inputs.outputs.build_docker_image == 'true' }}
+ cleanup_resources: ${{ needs.validate-inputs.outputs.cleanup_resources == 'true' }}
+ run_e2e_tests: ${{ needs.validate-inputs.outputs.run_e2e_tests || 'GoldenPath-Testing' }}
+ AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID: ${{ needs.validate-inputs.outputs.azure_env_log_analytics_workspace_id || '' }}
+ AZURE_EXISTING_AI_PROJECT_RESOURCE_ID: ${{ needs.validate-inputs.outputs.azure_existing_ai_project_resource_id || '' }}
+ existing_webapp_url: ${{ needs.validate-inputs.outputs.existing_webapp_url || '' }}
+ trigger_type: ${{ github.event_name }}
+ secrets: inherit
diff --git a/archive-doc-gen/.github/workflows/deploy-orchestrator.yml b/archive-doc-gen/.github/workflows/deploy-orchestrator.yml
new file mode 100644
index 000000000..31741f3b4
--- /dev/null
+++ b/archive-doc-gen/.github/workflows/deploy-orchestrator.yml
@@ -0,0 +1,141 @@
+name: Deployment orchestrator
+
+on:
+ workflow_call:
+ inputs:
+ runner_os:
+ description: 'Runner OS (ubuntu-latest or windows-latest)'
+ required: true
+ type: string
+ azure_location:
+ description: 'Azure Location For Deployment'
+ required: false
+ default: 'australiaeast'
+ type: string
+ resource_group_name:
+ description: 'Resource Group Name (Optional)'
+ required: false
+ default: ''
+ type: string
+ waf_enabled:
+ description: 'Enable WAF'
+ required: false
+ default: false
+ type: boolean
+ EXP:
+ description: 'Enable EXP'
+ required: false
+ default: false
+ type: boolean
+ build_docker_image:
+ description: 'Build And Push Docker Image (Optional)'
+ required: false
+ default: false
+ type: boolean
+ cleanup_resources:
+ description: 'Cleanup Deployed Resources'
+ required: false
+ default: false
+ type: boolean
+ run_e2e_tests:
+ description: 'Run End-to-End Tests'
+ required: false
+ default: 'GoldenPath-Testing'
+ type: string
+ AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID:
+ description: 'Log Analytics Workspace ID (Optional)'
+ required: false
+ default: ''
+ type: string
+ AZURE_EXISTING_AI_PROJECT_RESOURCE_ID:
+ description: 'AI Project Resource ID (Optional)'
+ required: false
+ default: ''
+ type: string
+ existing_webapp_url:
+ description: 'Existing Container WebApp URL (Skips Deployment)'
+ required: false
+ default: ''
+ type: string
+ trigger_type:
+ description: 'Trigger type (workflow_dispatch, pull_request, schedule)'
+ required: true
+ type: string
+
+env:
+ AZURE_DEV_COLLECT_TELEMETRY: ${{ vars.AZURE_DEV_COLLECT_TELEMETRY }}
+permissions:
+ contents: read
+ actions: read
+
+jobs:
+ docker-build:
+ uses: ./.github/workflows/job-docker-build.yml
+ with:
+ trigger_type: ${{ inputs.trigger_type }}
+ build_docker_image: ${{ inputs.build_docker_image }}
+ secrets: inherit
+
+ deploy:
+ if: "!cancelled() && (needs.docker-build.result == 'success' || needs.docker-build.result == 'skipped') && (inputs.trigger_type != 'workflow_dispatch' || inputs.existing_webapp_url == '' || inputs.existing_webapp_url == null)"
+ needs: docker-build
+ uses: ./.github/workflows/job-deploy.yml
+ with:
+ trigger_type: ${{ inputs.trigger_type }}
+ runner_os: ${{ inputs.runner_os }}
+ azure_location: ${{ inputs.azure_location }}
+ resource_group_name: ${{ inputs.resource_group_name }}
+ waf_enabled: ${{ inputs.waf_enabled }}
+ EXP: ${{ inputs.EXP }}
+ build_docker_image: ${{ inputs.build_docker_image }}
+ existing_webapp_url: ${{ inputs.existing_webapp_url }}
+ AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID: ${{ inputs.AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID }}
+ AZURE_EXISTING_AI_PROJECT_RESOURCE_ID: ${{ inputs.AZURE_EXISTING_AI_PROJECT_RESOURCE_ID }}
+ docker_image_tag: ${{ needs.docker-build.outputs.IMAGE_TAG }}
+ run_e2e_tests: ${{ inputs.run_e2e_tests }}
+ cleanup_resources: ${{ inputs.cleanup_resources }}
+ secrets: inherit
+
+ e2e-test:
+ if: "!cancelled() && ((needs.deploy.result == 'success' && needs.deploy.outputs.WEB_APPURL != '') || (inputs.existing_webapp_url != '' && inputs.existing_webapp_url != null)) && (inputs.trigger_type != 'workflow_dispatch' || (inputs.run_e2e_tests != 'None' && inputs.run_e2e_tests != '' && inputs.run_e2e_tests != null))"
+ needs: [docker-build, deploy]
+ uses: ./.github/workflows/test-automation-v2.yml
+ with:
+ DOCGEN_URL: ${{ needs.deploy.outputs.WEB_APPURL || inputs.existing_webapp_url }}
+ TEST_SUITE: ${{ inputs.trigger_type == 'workflow_dispatch' && inputs.run_e2e_tests || 'GoldenPath-Testing' }}
+ secrets: inherit
+
+ send-notification:
+ if: "!cancelled()"
+ needs: [docker-build, deploy, e2e-test]
+ uses: ./.github/workflows/job-send-notification.yml
+ with:
+ trigger_type: ${{ inputs.trigger_type }}
+ waf_enabled: ${{ inputs.waf_enabled }}
+ EXP: ${{ inputs.EXP }}
+ run_e2e_tests: ${{ inputs.run_e2e_tests }}
+ existing_webapp_url: ${{ inputs.existing_webapp_url }}
+ deploy_result: ${{ needs.deploy.result }}
+ e2e_test_result: ${{ needs.e2e-test.result }}
+ WEB_APPURL: ${{ needs.deploy.outputs.WEB_APPURL || inputs.existing_webapp_url }}
+ RESOURCE_GROUP_NAME: ${{ needs.deploy.outputs.RESOURCE_GROUP_NAME }}
+ QUOTA_FAILED: ${{ needs.deploy.outputs.QUOTA_FAILED }}
+ TEST_SUCCESS: ${{ needs.e2e-test.outputs.TEST_SUCCESS }}
+ TEST_REPORT_URL: ${{ needs.e2e-test.outputs.TEST_REPORT_URL }}
+ secrets: inherit
+
+ cleanup-deployment:
+ if: "!cancelled() && needs.deploy.outputs.RESOURCE_GROUP_NAME != '' && inputs.existing_webapp_url == '' && (inputs.trigger_type != 'workflow_dispatch' || inputs.cleanup_resources)"
+ needs: [docker-build, deploy, e2e-test]
+ uses: ./.github/workflows/job-cleanup-deployment.yml
+ with:
+ runner_os: ${{ inputs.runner_os }}
+ trigger_type: ${{ inputs.trigger_type }}
+ cleanup_resources: ${{ inputs.cleanup_resources }}
+ existing_webapp_url: ${{ inputs.existing_webapp_url }}
+ RESOURCE_GROUP_NAME: ${{ needs.deploy.outputs.RESOURCE_GROUP_NAME }}
+ AZURE_LOCATION: ${{ needs.deploy.outputs.AZURE_LOCATION }}
+ AZURE_ENV_OPENAI_LOCATION: ${{ needs.deploy.outputs.AZURE_ENV_OPENAI_LOCATION }}
+ ENV_NAME: ${{ needs.deploy.outputs.ENV_NAME }}
+ IMAGE_TAG: ${{ needs.deploy.outputs.IMAGE_TAG }}
+ secrets: inherit
diff --git a/archive-doc-gen/.github/workflows/deploy-v2.yml b/archive-doc-gen/.github/workflows/deploy-v2.yml
new file mode 100644
index 000000000..555b7614b
--- /dev/null
+++ b/archive-doc-gen/.github/workflows/deploy-v2.yml
@@ -0,0 +1,853 @@
+name: Deploy-Test-Cleanup (v2)
+on:
+ pull_request:
+ branches:
+ - main
+ workflow_run:
+ workflows: ["Build Docker and Optional Push"]
+ types:
+ - completed
+ branches:
+ - main
+ - dev
+ - demo
+ workflow_dispatch:
+ inputs:
+ azure_location:
+ description: 'Azure Location For Deployment'
+ required: false
+ default: 'australiaeast'
+ type: choice
+ options:
+ - 'australiaeast'
+ - 'centralus'
+ - 'eastasia'
+ - 'eastus2'
+ - 'japaneast'
+ - 'northeurope'
+ - 'southeastasia'
+ - 'uksouth'
+ - 'eastus'
+ resource_group_name:
+ description: 'Resource Group Name (Optional)'
+ required: false
+ default: ''
+ type: string
+
+ waf_enabled:
+ description: 'Enable WAF'
+ required: false
+ default: false
+ type: boolean
+ EXP:
+ description: 'Enable EXP'
+ required: false
+ default: false
+ type: boolean
+ build_docker_image:
+ description: 'Build And Push Docker Image (Optional)'
+ required: false
+ default: false
+ type: boolean
+ run_e2e_tests:
+ description: 'Run End-to-End Tests'
+ required: false
+ default: true
+ type: boolean
+ cleanup_resources:
+ description: 'Cleanup Deployed Resources'
+ required: false
+ default: false
+ type: boolean
+
+ AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID:
+ description: 'Log Analytics Workspace ID (Optional)'
+ required: false
+ default: ''
+ type: string
+ AZURE_EXISTING_AI_PROJECT_RESOURCE_ID:
+ description: 'AI Project Resource ID (Optional)'
+ required: false
+ default: ''
+ type: string
+ existing_webapp_url:
+ description: 'Existing WebApp URL (Skips Deployment)'
+ required: false
+ default: ''
+ type: string
+
+ schedule:
+ - cron: '0 9,21 * * *' # Runs at 9:00 AM and 9:00 PM GMT
+env:
+ GPT_MIN_CAPACITY: 150
+ TEXT_EMBEDDING_MIN_CAPACITY: 80
+ BRANCH_NAME: ${{ github.event.workflow_run.head_branch || github.head_ref || github.ref_name }}
+ # For automatic triggers (pull_request, workflow_run, schedule): force Non-WAF + Non-EXP
+ # For manual dispatch: use input values or defaults
+ WAF_ENABLED: ${{ github.event_name == 'workflow_dispatch' && (github.event.inputs.waf_enabled || false) || false }}
+ EXP: ${{ github.event_name == 'workflow_dispatch' && (github.event.inputs.EXP || false) || false }}
+ CLEANUP_RESOURCES: ${{ github.event_name == 'workflow_dispatch' && (github.event.inputs.cleanup_resources || true) || true }}
+ RUN_E2E_TESTS: ${{ github.event_name == 'workflow_dispatch' && (github.event.inputs.run_e2e_tests || true) || true }}
+ BUILD_DOCKER_IMAGE: ${{ github.event_name == 'workflow_dispatch' && (github.event.inputs.build_docker_image || false) || false }}
+ AZURE_DEV_COLLECT_TELEMETRY: ${{ vars.AZURE_DEV_COLLECT_TELEMETRY }}
+
+jobs:
+ docker-build:
+ if: github.event_name == 'workflow_dispatch' && github.event.inputs.build_docker_image == 'true'
+ runs-on: ubuntu-latest
+ outputs:
+ IMAGE_TAG: ${{ steps.generate_docker_tag.outputs.IMAGE_TAG }}
+ steps:
+ - name: Checkout Code
+ uses: actions/checkout@v4
+
+ - name: Generate Unique Docker Image Tag
+ id: generate_docker_tag
+ run: |
+ echo "🔨 Building new Docker image - generating unique tag..."
+ # Generate unique tag for manual deployment runs
+ TIMESTAMP=$(date +%Y%m%d-%H%M%S)
+ RUN_ID="${{ github.run_id }}"
+ BRANCH_NAME="${{ github.head_ref || github.ref_name }}"
+ # Sanitize branch name for Docker tag (replace invalid characters with hyphens)
+ CLEAN_BRANCH_NAME=$(echo "$BRANCH_NAME" | sed 's/[^a-zA-Z0-9._-]/-/g' | sed 's/--*/-/g' | sed 's/^-\|-$//g')
+ UNIQUE_TAG="${CLEAN_BRANCH_NAME}-${TIMESTAMP}-${RUN_ID}"
+ echo "IMAGE_TAG=$UNIQUE_TAG" >> $GITHUB_ENV
+ echo "IMAGE_TAG=$UNIQUE_TAG" >> $GITHUB_OUTPUT
+ echo "Generated unique Docker tag: $UNIQUE_TAG"
+
+ - name: Set up Docker Buildx
+ uses: docker/setup-buildx-action@v3
+
+ - name: Log in to Azure Container Registry
+ uses: azure/docker-login@v2
+ with:
+ login-server: ${{ secrets.ACR_TEST_LOGIN_SERVER }}
+ username: ${{ secrets.ACR_TEST_USERNAME }}
+ password: ${{ secrets.ACR_TEST_PASSWORD }}
+
+ - name: Build and Push Docker Image
+ id: build_push_image
+ uses: docker/build-push-action@v6
+ env:
+ DOCKER_BUILD_SUMMARY: false
+ with:
+ context: ./src
+ file: ./src/WebApp.Dockerfile
+ push: true
+ tags: |
+ ${{ secrets.ACR_TEST_LOGIN_SERVER }}/webapp:${{ steps.generate_docker_tag.outputs.IMAGE_TAG }}
+ ${{ secrets.ACR_TEST_LOGIN_SERVER }}/webapp:${{ steps.generate_docker_tag.outputs.IMAGE_TAG }}_${{ github.run_number }}
+
+ - name: Verify Docker Image Build
+ run: |
+ echo "✅ Docker image successfully built and pushed"
+ echo "Image tag: ${{ steps.generate_docker_tag.outputs.IMAGE_TAG }}"
+ echo "Run number: ${{ github.run_number }}"
+
+ - name: Generate Docker Build Summary
+ if: always()
+ run: |
+ # Extract ACR name from the secret
+ ACR_NAME=$(echo "${{ secrets.ACR_TEST_LOGIN_SERVER }}" | cut -d'.' -f1)
+ echo "## 🐳 Docker Build Job Summary" >> $GITHUB_STEP_SUMMARY
+ echo "" >> $GITHUB_STEP_SUMMARY
+ echo "| Field | Value |" >> $GITHUB_STEP_SUMMARY
+ echo "|-------|--------|" >> $GITHUB_STEP_SUMMARY
+ echo "| **Job Status** | ${{ job.status == 'success' && '✅ Success' || '❌ Failed' }} |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Image Tag** | \`${{ steps.generate_docker_tag.outputs.IMAGE_TAG }}\` |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Registry** | \`${ACR_NAME}.azurecr.io\` |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Full Image Path** | \`${ACR_NAME}.azurecr.io/webapp:${{ steps.generate_docker_tag.outputs.IMAGE_TAG }}\` |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Trigger** | ${{ github.event_name }} |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Branch** | ${{ env.BRANCH_NAME }} |" >> $GITHUB_STEP_SUMMARY
+ echo "" >> $GITHUB_STEP_SUMMARY
+ if [[ "${{ job.status }}" == "success" ]]; then
+ echo "### ✅ Build Details" >> $GITHUB_STEP_SUMMARY
+ echo "- Docker image successfully built and pushed to ACR" >> $GITHUB_STEP_SUMMARY
+ echo "- Generated unique tag: \`${{ steps.generate_docker_tag.outputs.IMAGE_TAG }}\`" >> $GITHUB_STEP_SUMMARY
+ else
+ echo "### ❌ Build Failed" >> $GITHUB_STEP_SUMMARY
+ echo "- Docker build process encountered an error" >> $GITHUB_STEP_SUMMARY
+ echo "- Check the docker-build job for detailed error information" >> $GITHUB_STEP_SUMMARY
+ fi
+
+ deploy:
+ if: always() && (github.event_name != 'workflow_dispatch' || github.event.inputs.existing_webapp_url == '' || github.event.inputs.existing_webapp_url == null)
+ needs: [docker-build]
+ runs-on: ubuntu-latest
+ outputs:
+ RESOURCE_GROUP_NAME: ${{ steps.check_create_rg.outputs.RESOURCE_GROUP_NAME }}
+ WEBAPP_URL: ${{ steps.get_output.outputs.WEBAPP_URL }}
+ ENV_NAME: ${{ steps.generate_env_name.outputs.ENV_NAME }}
+ AZURE_LOCATION: ${{ steps.set_region.outputs.AZURE_LOCATION }}
+ AZURE_ENV_OPENAI_LOCATION: ${{ steps.set_region.outputs.AZURE_ENV_OPENAI_LOCATION }}
+ IMAGE_TAG: ${{ steps.determine_image_tag.outputs.IMAGE_TAG }}
+ QUOTA_FAILED: ${{ steps.quota_failure_output.outputs.QUOTA_FAILED }}
+ env:
+ # For automatic triggers: force Non-WAF + Non-EXP, for manual dispatch: use inputs
+ WAF_ENABLED: ${{ github.event_name == 'workflow_dispatch' && (github.event.inputs.waf_enabled || false) || false }}
+ EXP: ${{ github.event_name == 'workflow_dispatch' && (github.event.inputs.EXP || false) || false }}
+ CLEANUP_RESOURCES: ${{ github.event_name == 'workflow_dispatch' && (github.event.inputs.cleanup_resources || true) || true }}
+
+ steps:
+ - name: Display Workflow Configuration
+ run: |
+ echo "🚀 ==================================="
+ echo "📋 WORKFLOW CONFIGURATION SUMMARY"
+ echo "🚀 ==================================="
+ echo "Trigger Type: ${{ github.event_name }}"
+ echo "Branch: ${{ env.BRANCH_NAME }}"
+ echo ""
+ echo "Configuration Settings:"
+ echo " • WAF Enabled: ${{ env.WAF_ENABLED }}"
+ echo " • EXP Enabled: ${{ env.EXP }}"
+ echo " • Run E2E Tests: ${{ env.RUN_E2E_TESTS }}"
+ echo " • Cleanup Resources: ${{ env.CLEANUP_RESOURCES }}"
+ echo " • Build Docker Image: ${{ env.BUILD_DOCKER_IMAGE }}"
+ if [[ "${{ github.event_name }}" == "workflow_dispatch" && -n "${{ github.event.inputs.azure_location }}" ]]; then
+ echo " • Selected Azure Location: ${{ github.event.inputs.azure_location }}"
+ else
+ echo " • Azure Location: Will be determined by quota check"
+ fi
+ if [[ "${{ github.event.inputs.existing_webapp_url }}" != "" ]]; then
+ echo " • Using Existing Webapp URL: ${{ github.event.inputs.existing_webapp_url }}"
+ echo " • Skip Deployment: Yes"
+ else
+ echo " • Skip Deployment: No"
+ fi
+ echo ""
+ if [[ "${{ github.event_name }}" != "workflow_dispatch" ]]; then
+ echo "ℹ️ Automatic Trigger: Using Non-WAF + Non-EXP configuration"
+ else
+ echo "ℹ️ Manual Trigger: Using user-specified configuration"
+ # Check if EXP was auto-enabled after user input validation
+ if [[ "${{ env.EXP }}" == "true" && "${{ github.event.inputs.EXP }}" != "true" ]]; then
+ echo "🔧 Note: EXP was automatically enabled due to provided parameter values"
+ fi
+ fi
+ echo "🚀 ==================================="
+
+ - name: Validate and Auto-Configure EXP
+ run: |
+ echo "🔍 Validating EXP configuration..."
+
+ # Check if EXP values were provided but EXP is disabled
+ if [[ "${{ github.event.inputs.EXP }}" != "true" ]]; then
+ if [[ -n "${{ github.event.inputs.AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID }}" ]] || [[ -n "${{ github.event.inputs.AZURE_EXISTING_AI_PROJECT_RESOURCE_ID }}" ]]; then
+ echo "🔧 AUTO-ENABLING EXP: EXP parameter values were provided but EXP was not explicitly enabled."
+ echo ""
+ echo "You provided values for:"
+ [[ -n "${{ github.event.inputs.AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID }}" ]] && echo " - Azure Log Analytics Workspace ID: '${{ github.event.inputs.AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID }}'"
+ [[ -n "${{ github.event.inputs.AZURE_EXISTING_AI_PROJECT_RESOURCE_ID }}" ]] && echo " - Azure AI Project Resource ID: '${{ github.event.inputs.AZURE_EXISTING_AI_PROJECT_RESOURCE_ID }}'"
+ echo ""
+ echo "✅ Automatically enabling EXP to use these values."
+ echo "EXP=true" >> $GITHUB_ENV
+ echo "📌 EXP has been automatically enabled for this deployment."
+ fi
+ fi
+
+ - name: Checkout Code
+ uses: actions/checkout@v4
+
+ - name: Setup Azure CLI
+ run: |
+ curl -sL https://aka.ms/InstallAzureCLIDeb | sudo bash
+ az --version # Verify installation
+
+ - name: Run Quota Check
+ id: quota-check
+ run: |
+ export AZURE_CLIENT_ID=${{ secrets.AZURE_CLIENT_ID }}
+ export AZURE_TENANT_ID=${{ secrets.AZURE_TENANT_ID }}
+ export AZURE_CLIENT_SECRET=${{ secrets.AZURE_CLIENT_SECRET }}
+ export AZURE_SUBSCRIPTION_ID="${{ secrets.AZURE_SUBSCRIPTION_ID }}"
+ export GPT_MIN_CAPACITY=${{ env.GPT_MIN_CAPACITY }}
+ export TEXT_EMBEDDING_MIN_CAPACITY=${{ env.TEXT_EMBEDDING_MIN_CAPACITY }}
+ export AZURE_REGIONS="${{ vars.AZURE_REGIONS }}"
+
+ chmod +x scripts/checkquota.sh
+ if ! scripts/checkquota.sh; then
+ # If quota check fails due to insufficient quota, set the flag
+ if grep -q "No region with sufficient quota found" scripts/checkquota.sh; then
+ echo "QUOTA_FAILED=true" >> $GITHUB_ENV
+ fi
+ exit 1 # Fail the pipeline if any other failure occurs
+ fi
+
+
+
+
+ - name: Set Quota Failure Output
+ id: quota_failure_output
+ if: env.QUOTA_FAILED == 'true'
+ run: |
+ echo "QUOTA_FAILED=true" >> $GITHUB_OUTPUT
+ echo "Quota check failed - will notify via separate notification job"
+
+ - name: Fail Pipeline if Quota Check Fails
+ if: env.QUOTA_FAILED == 'true'
+ run: exit 1
+
+ - name: Set Deployment Region
+ id: set_region
+ run: |
+ # Set AZURE_ENV_OPENAI_LOCATION from quota check result
+ echo "Selected Region from Quota Check: $VALID_REGION"
+ echo "AZURE_ENV_OPENAI_LOCATION=$VALID_REGION" >> $GITHUB_ENV
+ echo "AZURE_ENV_OPENAI_LOCATION=$VALID_REGION" >> $GITHUB_OUTPUT
+
+ # Set AZURE_LOCATION from user input (for manual dispatch) or default to quota check result (for automatic triggers)
+ if [[ "${{ github.event_name }}" == "workflow_dispatch" && -n "${{ github.event.inputs.azure_location }}" ]]; then
+ USER_SELECTED_LOCATION="${{ github.event.inputs.azure_location }}"
+ echo "Using user-selected Azure location: $USER_SELECTED_LOCATION"
+ echo "AZURE_LOCATION=$USER_SELECTED_LOCATION" >> $GITHUB_ENV
+ echo "AZURE_LOCATION=$USER_SELECTED_LOCATION" >> $GITHUB_OUTPUT
+ else
+ echo "Using location from quota check for automatic triggers: $VALID_REGION"
+ echo "AZURE_LOCATION=$VALID_REGION" >> $GITHUB_ENV
+ echo "AZURE_LOCATION=$VALID_REGION" >> $GITHUB_OUTPUT
+ fi
+
+ - name: Generate Resource Group Name
+ id: generate_rg_name
+ run: |
+ # Check if a resource group name was provided as input
+ if [[ -n "${{ github.event.inputs.resource_group_name }}" ]]; then
+ echo "Using provided Resource Group name: ${{ github.event.inputs.resource_group_name }}"
+ echo "RESOURCE_GROUP_NAME=${{ github.event.inputs.resource_group_name }}" >> $GITHUB_ENV
+ else
+ echo "Generating a unique resource group name..."
+ ACCL_NAME="docgen" # Account name as specified
+ SHORT_UUID=$(uuidgen | cut -d'-' -f1)
+ UNIQUE_RG_NAME="arg-${ACCL_NAME}-${SHORT_UUID}"
+ echo "RESOURCE_GROUP_NAME=${UNIQUE_RG_NAME}" >> $GITHUB_ENV
+ echo "Generated RESOURCE_GROUP_NAME: ${UNIQUE_RG_NAME}"
+ fi
+
+ - name: Setup Azure Developer CLI
+ run: |
+ curl -fsSL https://aka.ms/install-azd.sh | sudo bash
+ azd version
+
+ - name: Login to Azure
+ id: login-azure
+ run: |
+ az login --service-principal -u ${{ secrets.AZURE_CLIENT_ID }} -p ${{ secrets.AZURE_CLIENT_SECRET }} --tenant ${{ secrets.AZURE_TENANT_ID }}
+ azd auth login --client-id ${{ secrets.AZURE_CLIENT_ID }} --client-secret ${{ secrets.AZURE_CLIENT_SECRET }} --tenant-id ${{ secrets.AZURE_TENANT_ID }}
+
+ - name: Install Bicep CLI
+ run: az bicep install
+
+ - name: Check and Create Resource Group
+ id: check_create_rg
+ run: |
+ set -e
+ echo "🔍 Checking if resource group '$RESOURCE_GROUP_NAME' exists..."
+ rg_exists=$(az group exists --name $RESOURCE_GROUP_NAME)
+ if [ "$rg_exists" = "false" ]; then
+ echo "📦 Resource group does not exist. Creating new resource group '$RESOURCE_GROUP_NAME' in location '$AZURE_LOCATION'..."
+ az group create --name $RESOURCE_GROUP_NAME --location $AZURE_LOCATION || { echo "❌ Error creating resource group"; exit 1; }
+ echo "✅ Resource group '$RESOURCE_GROUP_NAME' created successfully."
+ else
+ echo "✅ Resource group '$RESOURCE_GROUP_NAME' already exists. Deploying to existing resource group."
+ fi
+ echo "RESOURCE_GROUP_NAME=$RESOURCE_GROUP_NAME" >> $GITHUB_OUTPUT
+
+ - name: Generate Unique Solution Prefix
+ id: generate_solution_prefix
+ run: |
+ set -e
+ COMMON_PART="psldg"
+ TIMESTAMP=$(date +%s)
+ UPDATED_TIMESTAMP=$(echo $TIMESTAMP | tail -c 6)
+ UNIQUE_SOLUTION_PREFIX="${COMMON_PART}${UPDATED_TIMESTAMP}"
+ echo "SOLUTION_PREFIX=${UNIQUE_SOLUTION_PREFIX}" >> $GITHUB_ENV
+ echo "Generated SOLUTION_PREFIX: ${UNIQUE_SOLUTION_PREFIX}"
+
+ - name: Determine Docker Image Tag
+ id: determine_image_tag
+ run: |
+ if [[ "${{ env.BUILD_DOCKER_IMAGE }}" == "true" ]]; then
+ # Use the tag from docker-build job if it was built
+ if [[ "${{ needs.docker-build.result }}" == "success" ]]; then
+ IMAGE_TAG="${{ needs.docker-build.outputs.IMAGE_TAG }}"
+ echo "🔗 Using Docker image tag from build job: $IMAGE_TAG"
+ else
+ echo "❌ Docker build job failed or was skipped, but BUILD_DOCKER_IMAGE is true"
+ exit 1
+ fi
+ else
+ echo "🏷️ Using existing Docker image based on branch..."
+ BRANCH_NAME="${{ env.BRANCH_NAME }}"
+ echo "Current branch: $BRANCH_NAME"
+
+ # Determine image tag based on branch
+ if [[ "$BRANCH_NAME" == "main" ]]; then
+ IMAGE_TAG="latest_waf"
+ echo "Using main branch - image tag: latest_waf"
+ elif [[ "$BRANCH_NAME" == "dev" ]]; then
+ IMAGE_TAG="dev"
+ echo "Using dev branch - image tag: dev"
+ elif [[ "$BRANCH_NAME" == "demo" ]]; then
+ IMAGE_TAG="demo"
+ echo "Using demo branch - image tag: demo"
+ else
+ IMAGE_TAG="latest_waf"
+ echo "Using default for branch '$BRANCH_NAME' - image tag: latest_waf"
+ fi
+
+ echo "Using existing Docker image tag: $IMAGE_TAG"
+ fi
+
+ echo "IMAGE_TAG=$IMAGE_TAG" >> $GITHUB_ENV
+ echo "IMAGE_TAG=$IMAGE_TAG" >> $GITHUB_OUTPUT
+
+ - name: Generate Unique Environment Name
+ id: generate_env_name
+ run: |
+ COMMON_PART="pslc"
+ TIMESTAMP=$(date +%s)
+ UPDATED_TIMESTAMP=$(echo $TIMESTAMP | tail -c 6)
+ UNIQUE_ENV_NAME="${COMMON_PART}${UPDATED_TIMESTAMP}"
+ echo "ENV_NAME=${UNIQUE_ENV_NAME}" >> $GITHUB_ENV
+ echo "Generated Environment Name: ${UNIQUE_ENV_NAME}"
+ echo "ENV_NAME=${UNIQUE_ENV_NAME}" >> $GITHUB_OUTPUT
+
+ - name: Configure Parameters Based on WAF Setting
+ run: |
+ if [[ "${{ env.WAF_ENABLED }}" == "true" ]]; then
+ echo "🔧 Configuring WAF deployment - copying main.waf.parameters.json to main.parameters.json..."
+ cp infra/main.waf.parameters.json infra/main.parameters.json
+ echo "✅ Successfully copied WAF parameters to main parameters file"
+ else
+ echo "🔧 Configuring Non-WAF deployment - using default main.parameters.json..."
+ # Ensure we have the original parameters file if it was overwritten
+ if [[ -f infra/main.waf.parameters.json ]] && [[ ! -f infra/main.parameters.json.backup ]]; then
+ echo "Backing up original parameters file..."
+ git checkout HEAD -- infra/main.parameters.json || echo "Using existing main.parameters.json"
+ fi
+ fi
+
+ - name: Display Docker Image Tag
+ run: |
+ echo "=== Docker Image Information ==="
+ echo "Docker Image Tag: ${{ steps.determine_image_tag.outputs.IMAGE_TAG }}"
+ echo "Registry: ${{ secrets.ACR_TEST_LOGIN_SERVER }}"
+ echo "Full Image: ${{ secrets.ACR_TEST_LOGIN_SERVER }}/webapp:${{ steps.determine_image_tag.outputs.IMAGE_TAG }}"
+ echo "================================"
+
+ - name: Deploy using azd up and extract values (${{ github.event.inputs.waf_enabled == 'true' && 'WAF' || 'Non-WAF' }}+${{ (github.event.inputs.EXP == 'true' || github.event.inputs.AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID != '' || github.event.inputs.AZURE_EXISTING_AI_PROJECT_RESOURCE_ID != '') && 'EXP' || 'Non-EXP' }})
+ id: get_output
+ run: |
+ set -e
+ echo "Starting azd deployment..."
+ echo "WAF Enabled: ${{ env.WAF_ENABLED }}"
+ echo "EXP: ${{ env.EXP }}"
+ echo "Using Docker Image Tag: ${{ steps.determine_image_tag.outputs.IMAGE_TAG }}"
+
+ # Install azd (Azure Developer CLI)
+ curl -fsSL https://aka.ms/install-azd.sh | bash
+
+ # Generate current timestamp in desired format: YYYY-MM-DDTHH:MM:SS.SSSSSSSZ
+ current_date=$(date -u +"%Y-%m-%dT%H:%M:%S.%7NZ")
+
+ echo "Creating environment..."
+ azd env new $ENV_NAME --no-prompt
+ echo "Environment created: $ENV_NAME"
+
+ echo "Setting default subscription..."
+ azd config set defaults.subscription ${{ secrets.AZURE_SUBSCRIPTION_ID }}
+
+ # Set additional parameters
+ azd env set AZURE_SUBSCRIPTION_ID="${{ secrets.AZURE_SUBSCRIPTION_ID }}"
+ azd env set AZURE_ENV_OPENAI_LOCATION="$AZURE_ENV_OPENAI_LOCATION"
+ azd env set AZURE_LOCATION="$AZURE_LOCATION"
+ azd env set AZURE_RESOURCE_GROUP="$RESOURCE_GROUP_NAME"
+ azd env set AZURE_ENV_IMAGETAG="${{ steps.determine_image_tag.outputs.IMAGE_TAG }}"
+
+ # Set ACR name only when building Docker image
+ if [[ "${{ env.BUILD_DOCKER_IMAGE }}" == "true" ]]; then
+ # Extract ACR name from login server and set as environment variable
+ ACR_NAME=$(echo "${{ secrets.ACR_TEST_LOGIN_SERVER }}" | cut -d'.' -f1)
+ azd env set AZURE_ENV_ACR_NAME="$ACR_NAME"
+ echo "Set ACR name to: $ACR_NAME"
+ else
+ echo "Skipping ACR name configuration (using existing image)"
+ fi
+
+ if [[ "${{ env.EXP }}" == "true" ]]; then
+ echo "✅ EXP ENABLED - Setting EXP parameters..."
+
+ # Set EXP variables dynamically
+ if [[ -n "${{ github.event.inputs.AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID }}" ]]; then
+ EXP_LOG_ANALYTICS_ID="${{ github.event.inputs.AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID }}"
+ else
+ EXP_LOG_ANALYTICS_ID="${{ secrets.EXP_LOG_ANALYTICS_WORKSPACE_ID }}"
+ fi
+
+ if [[ -n "${{ github.event.inputs.AZURE_EXISTING_AI_PROJECT_RESOURCE_ID }}" ]]; then
+ EXP_AI_PROJECT_ID="${{ github.event.inputs.AZURE_EXISTING_AI_PROJECT_RESOURCE_ID }}"
+ else
+ EXP_AI_PROJECT_ID="${{ secrets.EXP_AI_PROJECT_RESOURCE_ID }}"
+ fi
+
+ echo "AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID: $EXP_LOG_ANALYTICS_ID"
+ echo "AZURE_EXISTING_AI_PROJECT_RESOURCE_ID: $EXP_AI_PROJECT_ID"
+ azd env set AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID="$EXP_LOG_ANALYTICS_ID"
+ azd env set AZURE_EXISTING_AI_PROJECT_RESOURCE_ID="$EXP_AI_PROJECT_ID"
+ else
+ echo "❌ EXP DISABLED - Skipping EXP parameters"
+ if [[ -n "${{ github.event.inputs.AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID }}" ]] || [[ -n "${{ github.event.inputs.AZURE_EXISTING_AI_PROJECT_RESOURCE_ID }}" ]]; then
+ echo "⚠️ Warning: EXP parameter values provided but EXP is disabled. These values will be ignored."
+ fi
+ fi
+
+ # Deploy using azd up
+ azd up --no-prompt
+
+ # Get deployment outputs using azd
+ echo "Extracting deployment outputs..."
+ DEPLOY_OUTPUT=$(azd env get-values --output json)
+ echo "Deployment output: $DEPLOY_OUTPUT"
+
+ if [[ -z "$DEPLOY_OUTPUT" ]]; then
+ echo "Error: Deployment output is empty. Please check the deployment logs."
+ exit 1
+ fi
+
+ # Extract values from azd output (adjust these based on actual output variable names)
+ export AI_FOUNDRY_RESOURCE_ID=$(echo "$DEPLOY_OUTPUT" | jq -r '.AI_FOUNDRY_RESOURCE_ID // empty')
+ echo "AI_FOUNDRY_RESOURCE_ID=$AI_FOUNDRY_RESOURCE_ID" >> $GITHUB_ENV
+ export AI_SEARCH_SERVICE_NAME=$(echo "$DEPLOY_OUTPUT" | jq -r '.AI_SEARCH_SERVICE_NAME // empty')
+ echo "AI_SEARCH_SERVICE_NAME=$AI_SEARCH_SERVICE_NAME" >> $GITHUB_ENV
+ export AZURE_COSMOSDB_ACCOUNT=$(echo "$DEPLOY_OUTPUT" | jq -r '.AZURE_COSMOSDB_ACCOUNT // empty')
+ echo "AZURE_COSMOSDB_ACCOUNT=$AZURE_COSMOSDB_ACCOUNT" >> $GITHUB_ENV
+ export STORAGE_ACCOUNT_NAME=$(echo "$DEPLOY_OUTPUT" | jq -r '.STORAGE_ACCOUNT_NAME // empty')
+ echo "STORAGE_ACCOUNT_NAME=$STORAGE_ACCOUNT_NAME" >> $GITHUB_ENV
+ export STORAGE_CONTAINER_NAME=$(echo "$DEPLOY_OUTPUT" | jq -r '.STORAGE_CONTAINER_NAME // empty')
+ echo "STORAGE_CONTAINER_NAME=$STORAGE_CONTAINER_NAME" >> $GITHUB_ENV
+ export KEY_VAULT_NAME=$(echo "$DEPLOY_OUTPUT" | jq -r '.KEY_VAULT_NAME // empty')
+ echo "KEY_VAULT_NAME=$KEY_VAULT_NAME" >> $GITHUB_ENV
+ export RESOURCE_GROUP_NAME=$(echo "$DEPLOY_OUTPUT" | jq -r '.RESOURCE_GROUP_NAME // .AZURE_RESOURCE_GROUP // empty')
+ [[ -z "$RESOURCE_GROUP_NAME" ]] && export RESOURCE_GROUP_NAME="$RESOURCE_GROUP_NAME"
+ echo "RESOURCE_GROUP_NAME=$RESOURCE_GROUP_NAME" >> $GITHUB_ENV
+ WEBAPP_URL=$(echo "$DEPLOY_OUTPUT" | jq -r '.WEB_APP_URL // .SERVICE_BACKEND_ENDPOINT_URL // empty')
+ echo "WEBAPP_URL=$WEBAPP_URL" >> $GITHUB_OUTPUT
+ sleep 30
+
+ - name: Run Post-Deployment Script
+ id: post_deploy
+ env:
+ AZURE_SUBSCRIPTION_ID: ${{ secrets.AZURE_SUBSCRIPTION_ID }}
+ run: |
+ set -e
+ az account set --subscription "${{ secrets.AZURE_SUBSCRIPTION_ID }}"
+
+ echo "Running post-deployment script..."
+
+ bash ./infra/scripts/process_sample_data.sh \
+ "$STORAGE_ACCOUNT_NAME" \
+ "$STORAGE_CONTAINER_NAME" \
+ "$KEY_VAULT_NAME" \
+ "$AZURE_COSMOSDB_ACCOUNT" \
+ "$RESOURCE_GROUP_NAME" \
+ "$AI_SEARCH_SERVICE_NAME" \
+ "${{ secrets.AZURE_CLIENT_ID }}" \
+ "$AI_FOUNDRY_RESOURCE_ID"
+
+ - name: Logout from Azure
+ if: always()
+ run: |
+ az logout
+ echo "Logged out from Azure."
+
+
+
+ - name: Generate Deploy Job Summary
+ if: always()
+ run: |
+ echo "## 🚀 Deploy Job Summary" >> $GITHUB_STEP_SUMMARY
+ echo "" >> $GITHUB_STEP_SUMMARY
+ echo "| Field | Value |" >> $GITHUB_STEP_SUMMARY
+ echo "|-------|--------|" >> $GITHUB_STEP_SUMMARY
+ echo "| **Job Status** | ${{ job.status == 'success' && '✅ Success' || '❌ Failed' }} |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Environment Name** | \`${{ steps.generate_env_name.outputs.ENV_NAME }}\` |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Resource Group** | \`${{ steps.check_create_rg.outputs.RESOURCE_GROUP_NAME }}\` |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Azure Region (Infrastructure)** | \`${{ steps.set_region.outputs.AZURE_LOCATION }}\` |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Azure OpenAI Region** | \`${{ steps.set_region.outputs.AZURE_ENV_OPENAI_LOCATION }}\` |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Docker Image Tag** | \`${{ steps.determine_image_tag.outputs.IMAGE_TAG }}\` |" >> $GITHUB_STEP_SUMMARY
+ echo "| **WAF Enabled** | ${{ env.WAF_ENABLED == 'true' && '✅ Yes' || '❌ No' }} |" >> $GITHUB_STEP_SUMMARY
+ echo "| **EXP Enabled** | ${{ env.EXP == 'true' && '✅ Yes' || '❌ No' }} |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Trigger** | ${{ github.event_name }} |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Branch** | ${{ env.BRANCH_NAME }} |" >> $GITHUB_STEP_SUMMARY
+ echo "" >> $GITHUB_STEP_SUMMARY
+ if [[ "${{ job.status }}" == "success" ]]; then
+ echo "### ✅ Deployment Details" >> $GITHUB_STEP_SUMMARY
+ echo "- **Web App URL**: [${{ steps.get_output.outputs.WEBAPP_URL }}](${{ steps.get_output.outputs.WEBAPP_URL }})" >> $GITHUB_STEP_SUMMARY
+ echo "- **Configuration**: ${{ env.WAF_ENABLED == 'true' && 'WAF' || 'Non-WAF' }}+${{ env.EXP == 'true' && 'EXP' || 'Non-EXP' }}" >> $GITHUB_STEP_SUMMARY
+ echo "- Successfully deployed to Azure with all resources configured" >> $GITHUB_STEP_SUMMARY
+ echo "- Post-deployment scripts executed successfully" >> $GITHUB_STEP_SUMMARY
+ else
+ echo "### ❌ Deployment Failed" >> $GITHUB_STEP_SUMMARY
+ echo "- Deployment process encountered an error" >> $GITHUB_STEP_SUMMARY
+ echo "- Check the deploy job for detailed error information" >> $GITHUB_STEP_SUMMARY
+ fi
+
+ e2e-test:
+ if: always() && ((needs.deploy.result == 'success' && needs.deploy.outputs.WEBAPP_URL != '') || (github.event.inputs.existing_webapp_url != '' && github.event.inputs.existing_webapp_url != null)) && (github.event_name != 'workflow_dispatch' || github.event.inputs.run_e2e_tests == 'true' || github.event.inputs.run_e2e_tests == null)
+ needs: [docker-build, deploy]
+ uses: ./.github/workflows/test-automation.yml
+ with:
+ DOCGEN_URL: ${{ github.event.inputs.existing_webapp_url || needs.deploy.outputs.WEBAPP_URL }}
+ secrets: inherit
+
+ cleanup-deployment:
+ if: always() && needs.deploy.result == 'success' && needs.deploy.outputs.RESOURCE_GROUP_NAME != '' && github.event.inputs.existing_webapp_url == '' && (github.event_name != 'workflow_dispatch' || github.event.inputs.cleanup_resources == 'true' || github.event.inputs.cleanup_resources == null)
+ needs: [docker-build, deploy, e2e-test]
+ runs-on: ubuntu-latest
+ env:
+ RESOURCE_GROUP_NAME: ${{ needs.deploy.outputs.RESOURCE_GROUP_NAME }}
+ AZURE_LOCATION: ${{ needs.deploy.outputs.AZURE_LOCATION }}
+ AZURE_ENV_OPENAI_LOCATION: ${{ needs.deploy.outputs.AZURE_ENV_OPENAI_LOCATION }}
+ ENV_NAME: ${{ needs.deploy.outputs.ENV_NAME }}
+ IMAGE_TAG: ${{ needs.deploy.outputs.IMAGE_TAG }}
+ steps:
+ - name: Checkout Code
+ uses: actions/checkout@v4
+
+ - name: Setup Azure Developer CLI
+ run: |
+ curl -fsSL https://aka.ms/install-azd.sh | sudo bash
+ azd version
+
+ - name: Login to Azure
+ run: |
+ azd auth login --client-id ${{ secrets.AZURE_CLIENT_ID }} --client-secret ${{ secrets.AZURE_CLIENT_SECRET }} --tenant-id ${{ secrets.AZURE_TENANT_ID }}
+ azd config set defaults.subscription ${{ secrets.AZURE_SUBSCRIPTION_ID }}
+
+ - name: Setup Azure CLI for Docker cleanup
+ run: |
+ curl -sL https://aka.ms/InstallAzureCLIDeb | sudo bash
+ az --version
+
+ - name: Login to Azure CLI for Docker cleanup
+ run: |
+ az login --service-principal -u ${{ secrets.AZURE_CLIENT_ID }} -p ${{ secrets.AZURE_CLIENT_SECRET }} --tenant ${{ secrets.AZURE_TENANT_ID }}
+
+ - name: Delete Docker Images from ACR
+ if: github.event.inputs.existing_webapp_url == ''
+ run: |
+ set -e
+ echo "🗑️ Cleaning up Docker images from Azure Container Registry..."
+
+ # Determine the image tag to delete - check if docker-build job ran
+ if [[ "${{ needs.docker-build.result }}" == "success" ]]; then
+ IMAGE_TAG="${{ needs.docker-build.outputs.IMAGE_TAG }}"
+ echo "Using image tag from docker-build job: $IMAGE_TAG"
+ else
+ IMAGE_TAG="${{ needs.deploy.outputs.IMAGE_TAG }}"
+ echo "Using image tag from deploy job: $IMAGE_TAG"
+ fi
+
+ if [[ -n "$IMAGE_TAG" && "$IMAGE_TAG" != "latest_waf" && "$IMAGE_TAG" != "dev" && "$IMAGE_TAG" != "demo" ]]; then
+ echo "Deleting Docker images with tag: $IMAGE_TAG"
+
+ # Delete the main image
+ echo "Deleting image: ${{ secrets.ACR_TEST_LOGIN_SERVER }}/webapp:$IMAGE_TAG"
+ az acr repository delete --name $(echo "${{ secrets.ACR_TEST_LOGIN_SERVER }}" | cut -d'.' -f1) \
+ --image webapp:$IMAGE_TAG --yes || echo "Warning: Failed to delete main image or image not found"
+
+ echo "✅ Docker images cleanup completed"
+ else
+ echo "⚠️ Skipping Docker image cleanup (using standard branch image: $IMAGE_TAG)"
+ fi
+
+ - name: Select Environment and Delete deployment using azd
+ run: |
+ set -e
+ # Try to select the environment if it exists, otherwise create a minimal environment for cleanup
+ azd env list
+ if azd env list | grep -q "${{ env.ENV_NAME }}"; then
+ echo "Environment ${{ env.ENV_NAME }} found, selecting it..."
+ azd env select ${{ env.ENV_NAME }}
+ else
+ echo "Environment ${{ env.ENV_NAME }} not found, creating minimal environment for cleanup..."
+ azd env new ${{ env.ENV_NAME }} --no-prompt
+ azd env set AZURE_RESOURCE_GROUP "${{ env.RESOURCE_GROUP_NAME }}"
+ azd env set AZURE_SUBSCRIPTION_ID "${{ secrets.AZURE_SUBSCRIPTION_ID }}"
+ azd env set AZURE_ENV_OPENAI_LOCATION="${{ env.AZURE_ENV_OPENAI_LOCATION }}"
+ azd env set AZURE_LOCATION="${{ env.AZURE_LOCATION }}"
+ fi
+
+ echo "Deleting deployment..."
+ azd down --purge --force --no-prompt
+ echo "Deployment deleted successfully."
+
+
+
+ - name: Logout from Azure
+ if: always()
+ run: |
+ azd auth logout
+ az logout || echo "Warning: Failed to logout from Azure CLI"
+ echo "Logged out from Azure."
+ - name: Generate Cleanup Job Summary
+ if: always()
+ run: |
+ echo "## 🧹 Cleanup Job Summary" >> $GITHUB_STEP_SUMMARY
+ echo "" >> $GITHUB_STEP_SUMMARY
+ echo "| Field | Value |" >> $GITHUB_STEP_SUMMARY
+ echo "|-------|--------|" >> $GITHUB_STEP_SUMMARY
+ echo "| **Job Status** | ${{ job.status == 'success' && '✅ Success' || '❌ Failed' }} |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Resource Group** | \`${{ env.RESOURCE_GROUP_NAME }}\` |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Environment Name** | \`${{ env.ENV_NAME }}\` |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Azure Region (Infrastructure)** | \`${{ env.AZURE_LOCATION }}\` |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Azure OpenAI Region** | \`${{ env.AZURE_ENV_OPENAI_LOCATION }}\` |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Docker Image Tag** | \`${{ env.IMAGE_TAG }}\` |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Trigger** | ${{ github.event_name }} |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Branch** | ${{ env.BRANCH_NAME }} |" >> $GITHUB_STEP_SUMMARY
+ echo "" >> $GITHUB_STEP_SUMMARY
+ if [[ "${{ job.status }}" == "success" ]]; then
+ echo "### ✅ Cleanup Details" >> $GITHUB_STEP_SUMMARY
+ echo "- Successfully deleted Azure resource group: \`${{ env.RESOURCE_GROUP_NAME }}\`" >> $GITHUB_STEP_SUMMARY
+ if [[ "${{ env.IMAGE_TAG }}" != "latest_waf" && "${{ env.IMAGE_TAG }}" != "dev" && "${{ env.IMAGE_TAG }}" != "demo" ]]; then
+ echo "- Removed custom Docker images from ACR with tag: \`${{ env.IMAGE_TAG }}\`" >> $GITHUB_STEP_SUMMARY
+ else
+ echo "- Preserved standard Docker image (using branch tag: \`${{ env.IMAGE_TAG }}\`)" >> $GITHUB_STEP_SUMMARY
+ fi
+ echo "- All deployed resources have been successfully cleaned up" >> $GITHUB_STEP_SUMMARY
+ else
+ echo "### ❌ Cleanup Failed" >> $GITHUB_STEP_SUMMARY
+ echo "- Cleanup process encountered an error" >> $GITHUB_STEP_SUMMARY
+ echo "- Manual cleanup may be required" >> $GITHUB_STEP_SUMMARY
+ echo "- ⬇️ Check the cleanup-deployment job for detailed error information" >> $GITHUB_STEP_SUMMARY
+
+ fi
+
+ send-notification:
+ if: always()
+ needs: [docker-build, deploy, e2e-test]
+ runs-on: ubuntu-latest
+ steps:
+ - name: Send Quota Failure Notification
+ if: needs.deploy.result == 'failure' && needs.deploy.outputs.QUOTA_FAILED == 'true'
+ run: |
+ RUN_URL="https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}"
+ EMAIL_BODY=$(cat <Dear Team,We would like to inform you that the DocGen deployment has failed due to insufficient quota in the requested regions.
Issue Details:
• Quota check failed for GPT and Text Embedding models
• Required GPT Capacity: ${{ env.GPT_MIN_CAPACITY }}
• Required Text Embedding Capacity: ${{ env.TEXT_EMBEDDING_MIN_CAPACITY }}
• Checked Regions: ${{ vars.AZURE_REGIONS }}
Run URL: ${RUN_URL}
Please resolve the quota issue and retry the deployment.
Best regards,
Your Automation Team
",
+ "subject": "DocGen Pipeline - Failed (Insufficient Quota)"
+ }
+ EOF
+ )
+
+ curl -X POST "${{ secrets.EMAILNOTIFICATION_LOGICAPP_URL_TA }}" \
+ -H "Content-Type: application/json" \
+ -d "$EMAIL_BODY" || echo "Failed to send quota failure notification"
+
+ - name: Send Deployment Failure Notification
+ if: needs.deploy.result == 'failure' && needs.deploy.outputs.QUOTA_FAILED != 'true'
+ run: |
+ RUN_URL="https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}"
+ RESOURCE_GROUP="${{ needs.deploy.outputs.RESOURCE_GROUP_NAME }}"
+
+ EMAIL_BODY=$(cat <Dear Team,We would like to inform you that the DocGen deployment process has encountered an issue and has failed to complete successfully.
Deployment Details:
• Resource Group: ${RESOURCE_GROUP}
• WAF Enabled: ${{ env.WAF_ENABLED }}
• EXP Enabled: ${{ env.EXP }}
Run URL: ${RUN_URL}
Please investigate the deployment failure at your earliest convenience.
Best regards,
Your Automation Team
",
+ "subject": "DocGen Pipeline - Failed"
+ }
+ EOF
+ )
+
+ curl -X POST "${{ secrets.EMAILNOTIFICATION_LOGICAPP_URL_TA }}" \
+ -H "Content-Type: application/json" \
+ -d "$EMAIL_BODY" || echo "Failed to send deployment failure notification"
+
+ - name: Send Success Notification
+ if: needs.deploy.result == 'success' && (needs.e2e-test.result == 'skipped' || needs.e2e-test.outputs.TEST_SUCCESS == 'true')
+ run: |
+ RUN_URL="https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}"
+ WEBAPP_URL="${{ needs.deploy.outputs.WEBAPP_URL || github.event.inputs.existing_webapp_url }}"
+ RESOURCE_GROUP="${{ needs.deploy.outputs.RESOURCE_GROUP_NAME }}"
+ TEST_REPORT_URL="${{ needs.e2e-test.outputs.TEST_REPORT_URL }}"
+
+ # Create email body based on test result
+ if [ "${{ needs.e2e-test.result }}" = "skipped" ]; then
+ EMAIL_BODY=$(cat <Dear Team,We would like to inform you that the DocGen deployment has completed successfully.
Deployment Details:
• Resource Group: ${RESOURCE_GROUP}
• Web App URL: ${WEBAPP_URL}
• E2E Tests: Skipped (as configured)
Configuration:
• WAF Enabled: ${{ env.WAF_ENABLED }}
• EXP Enabled: ${{ env.EXP }}
Run URL: ${RUN_URL}
Best regards,
Your Automation Team
",
+ "subject": "DocGen Pipeline - Deployment Success"
+ }
+ EOF
+ )
+ else
+ EMAIL_BODY=$(cat <Dear Team,We would like to inform you that the DocGen deployment and testing process has completed successfully.
Deployment Details:
• Resource Group: ${RESOURCE_GROUP}
• Web App URL: ${WEBAPP_URL}
• E2E Tests: Passed
• Test Report: View Report
Configuration:
• WAF Enabled: ${{ env.WAF_ENABLED }}
• EXP Enabled: ${{ env.EXP }}
Run URL: ${RUN_URL}
Best regards,
Your Automation Team
",
+ "subject": "DocGen Pipeline - Test Automation - Success"
+ }
+ EOF
+ )
+ fi
+
+ curl -X POST "${{ secrets.EMAILNOTIFICATION_LOGICAPP_URL_TA }}" \
+ -H "Content-Type: application/json" \
+ -d "$EMAIL_BODY" || echo "Failed to send success notification"
+
+ - name: Send Test Failure Notification
+ if: needs.deploy.result == 'success' && needs.e2e-test.result != 'skipped' && needs.e2e-test.outputs.TEST_SUCCESS != 'true'
+ run: |
+ RUN_URL="https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}"
+ TEST_REPORT_URL="${{ needs.e2e-test.outputs.TEST_REPORT_URL }}"
+ WEBAPP_URL="${{ needs.deploy.outputs.WEBAPP_URL || github.event.inputs.existing_webapp_url }}"
+ RESOURCE_GROUP="${{ needs.deploy.outputs.RESOURCE_GROUP_NAME }}"
+
+ EMAIL_BODY=$(cat <Dear Team,We would like to inform you that test automation process has encountered issues and failed to complete successfully.
Deployment Details:
• Resource Group: ${RESOURCE_GROUP}
• Web App URL: ${WEBAPP_URL}
• Deployment Status: ✅ Success
• E2E Tests: ❌ Failed
Test Details:
• Test Report: View Report
Run URL: ${RUN_URL}
Please investigate the matter at your earliest convenience.
Best regards,
Your Automation Team
",
+ "subject": "DocGen Pipeline - Test Automation - Failed"
+ }
+ EOF
+ )
+
+ curl -X POST "${{ secrets.EMAILNOTIFICATION_LOGICAPP_URL_TA }}" \
+ -H "Content-Type: application/json" \
+ -d "$EMAIL_BODY" || echo "Failed to send test failure notification"
+
+ - name: Send Existing URL Success Notification
+ # Scenario: Deployment skipped (existing URL provided) AND e2e tests passed
+ if: needs.deploy.result == 'skipped' && github.event.inputs.existing_webapp_url != '' && needs.e2e-test.result == 'success' && (needs.e2e-test.outputs.TEST_SUCCESS == 'true' || needs.e2e-test.outputs.TEST_SUCCESS == '')
+ run: |
+ RUN_URL="https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}"
+ EXISTING_URL="${{ github.event.inputs.existing_webapp_url }}"
+ TEST_REPORT_URL="${{ needs.e2e-test.outputs.TEST_REPORT_URL }}"
+ EMAIL_BODY=$(cat <Dear Team,The DocGen pipeline executed against the existing WebApp URL and testing process has completed successfully.
Test Results:
• Status: ✅ Passed
${TEST_REPORT_URL:+• Test Report: View Report}
• Target URL: ${EXISTING_URL}
Deployment: Skipped
Run URL: ${RUN_URL}
Best regards,
Your Automation Team
",
+ "subject": "DocGen Pipeline - Test Automation Passed (Existing URL)"
+ }
+ EOF
+ )
+
+ curl -X POST "${{ secrets.EMAILNOTIFICATION_LOGICAPP_URL_TA }}" \
+ -H "Content-Type: application/json" \
+ -d "$EMAIL_BODY" || echo "Failed to send existing URL success notification"
+
+ - name: Send Existing URL Test Failure Notification
+ # Scenario: Deployment skipped (existing URL provided) AND e2e tests failed
+ if: needs.deploy.result == 'skipped' && github.event.inputs.existing_webapp_url != '' && needs.e2e-test.result == 'failure'
+ run: |
+ RUN_URL="https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}"
+ EXISTING_URL="${{ github.event.inputs.existing_webapp_url }}"
+ TEST_REPORT_URL="${{ needs.e2e-test.outputs.TEST_REPORT_URL }}"
+ EMAIL_BODY=$(cat <Dear Team,The DocGen pipeline executed against the existing WebApp URL and the test automation has encountered issues and failed to complete successfully.
Failure Details:
• Target URL: ${EXISTING_URL}
${TEST_REPORT_URL:+• Test Report: View Report}
• Deployment: Skipped
Run URL: ${RUN_URL}
Best regards,
Your Automation Team
",
+ "subject": "DocGen Pipeline - Test Automation Failed (Existing URL)"
+ }
+ EOF
+ )
+
+ curl -X POST "${{ secrets.EMAILNOTIFICATION_LOGICAPP_URL_TA }}" \
+ -H "Content-Type: application/json" \
+ -d "$EMAIL_BODY" || echo "Failed to send existing URL test failure notification"
\ No newline at end of file
diff --git a/archive-doc-gen/.github/workflows/deploy-windows.yml b/archive-doc-gen/.github/workflows/deploy-windows.yml
new file mode 100644
index 000000000..9aec336a2
--- /dev/null
+++ b/archive-doc-gen/.github/workflows/deploy-windows.yml
@@ -0,0 +1,274 @@
+name: Deploy-Test-Cleanup (v2) Windows
+on:
+ # pull_request:
+ # branches:
+ # - main
+ # workflow_run:
+ # workflows: ["Build Docker and Optional Push"]
+ # types:
+ # - completed
+ # branches:
+ # - main
+ # - dev
+ # - demo
+ workflow_dispatch:
+ inputs:
+ azure_location:
+ description: 'Azure Location For Deployment'
+ required: false
+ default: 'australiaeast'
+ type: choice
+ options:
+ - 'australiaeast'
+ - 'centralus'
+ - 'eastasia'
+ - 'eastus2'
+ - 'japaneast'
+ - 'northeurope'
+ - 'southeastasia'
+ - 'uksouth'
+ resource_group_name:
+ description: 'Resource Group Name (Optional)'
+ required: false
+ default: ''
+ type: string
+
+ waf_enabled:
+ description: 'Enable WAF'
+ required: false
+ default: false
+ type: boolean
+ EXP:
+ description: 'Enable EXP'
+ required: false
+ default: false
+ type: boolean
+ build_docker_image:
+ description: 'Build And Push Docker Image (Optional)'
+ required: false
+ default: false
+ type: boolean
+
+ cleanup_resources:
+ description: 'Cleanup Deployed Resources'
+ required: false
+ default: false
+ type: boolean
+
+ run_e2e_tests:
+ description: 'Run End-to-End Tests'
+ required: false
+ default: 'GoldenPath-Testing'
+ type: choice
+ options:
+ - 'GoldenPath-Testing'
+ - 'Smoke-Testing'
+ - 'None'
+
+ AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID:
+ description: 'Log Analytics Workspace ID (Optional)'
+ required: false
+ default: ''
+ type: string
+ AZURE_EXISTING_AI_PROJECT_RESOURCE_ID:
+ description: 'AI Project Resource ID (Optional)'
+ required: false
+ default: ''
+ type: string
+ existing_webapp_url:
+ description: 'Existing WebApp URL (Skips Deployment)'
+ required: false
+ default: ''
+ type: string
+
+ # schedule:
+ # - cron: '0 9,21 * * *' # Runs at 9:00 AM and 9:00 PM GMT
+permissions:
+ contents: read
+ actions: read
+
+jobs:
+ validate-inputs:
+ runs-on: ubuntu-latest
+ outputs:
+ validation_passed: ${{ steps.validate.outputs.passed }}
+ azure_location: ${{ steps.validate.outputs.azure_location }}
+ resource_group_name: ${{ steps.validate.outputs.resource_group_name }}
+ waf_enabled: ${{ steps.validate.outputs.waf_enabled }}
+ exp: ${{ steps.validate.outputs.exp }}
+ build_docker_image: ${{ steps.validate.outputs.build_docker_image }}
+ cleanup_resources: ${{ steps.validate.outputs.cleanup_resources }}
+ run_e2e_tests: ${{ steps.validate.outputs.run_e2e_tests }}
+ azure_env_log_analytics_workspace_id: ${{ steps.validate.outputs.azure_env_log_analytics_workspace_id }}
+ azure_existing_ai_project_resource_id: ${{ steps.validate.outputs.azure_existing_ai_project_resource_id }}
+ existing_webapp_url: ${{ steps.validate.outputs.existing_webapp_url }}
+ steps:
+ - name: Validate Workflow Input Parameters
+ id: validate
+ shell: bash
+ env:
+ INPUT_AZURE_LOCATION: ${{ github.event.inputs.azure_location }}
+ INPUT_RESOURCE_GROUP_NAME: ${{ github.event.inputs.resource_group_name }}
+ INPUT_WAF_ENABLED: ${{ github.event.inputs.waf_enabled }}
+ INPUT_EXP: ${{ github.event.inputs.EXP }}
+ INPUT_BUILD_DOCKER_IMAGE: ${{ github.event.inputs.build_docker_image }}
+ INPUT_CLEANUP_RESOURCES: ${{ github.event.inputs.cleanup_resources }}
+ INPUT_RUN_E2E_TESTS: ${{ github.event.inputs.run_e2e_tests }}
+ INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID: ${{ github.event.inputs.AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID }}
+ INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID: ${{ github.event.inputs.AZURE_EXISTING_AI_PROJECT_RESOURCE_ID }}
+ INPUT_EXISTING_WEBAPP_URL: ${{ github.event.inputs.existing_webapp_url }}
+ run: |
+ echo "🔍 Validating workflow input parameters..."
+ VALIDATION_FAILED=false
+
+ # Validate azure_location (Azure region format)
+ LOCATION="${INPUT_AZURE_LOCATION:-australiaeast}"
+
+ if [[ ! "$LOCATION" =~ ^[a-z0-9]+$ ]]; then
+ echo "❌ ERROR: azure_location '$LOCATION' is invalid. Must contain only lowercase letters and numbers"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ azure_location: '$LOCATION' is valid"
+ fi
+
+ # Validate resource_group_name (Azure naming convention, optional)
+ if [[ -n "$INPUT_RESOURCE_GROUP_NAME" ]]; then
+ if [[ ! "$INPUT_RESOURCE_GROUP_NAME" =~ ^[a-zA-Z0-9._\(\)-]+$ ]] || [[ "$INPUT_RESOURCE_GROUP_NAME" =~ \.$ ]]; then
+ echo "❌ ERROR: resource_group_name '$INPUT_RESOURCE_GROUP_NAME' is invalid. Must contain only alphanumerics, periods, underscores, hyphens, and parentheses. Cannot end with period."
+ VALIDATION_FAILED=true
+ elif [[ ${#INPUT_RESOURCE_GROUP_NAME} -gt 90 ]]; then
+ echo "❌ ERROR: resource_group_name '$INPUT_RESOURCE_GROUP_NAME' exceeds 90 characters (length: ${#INPUT_RESOURCE_GROUP_NAME})"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ resource_group_name: '$INPUT_RESOURCE_GROUP_NAME' is valid"
+ fi
+ else
+ echo "✅ resource_group_name: Not provided (will be auto-generated)"
+ fi
+
+ # Validate waf_enabled (boolean)
+ WAF_ENABLED="${INPUT_WAF_ENABLED:-false}"
+ if [[ "$WAF_ENABLED" != "true" && "$WAF_ENABLED" != "false" ]]; then
+ echo "❌ ERROR: waf_enabled must be 'true' or 'false', got: '$WAF_ENABLED'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ waf_enabled: '$WAF_ENABLED' is valid"
+ fi
+
+ # Validate EXP (boolean)
+ EXP_ENABLED="${INPUT_EXP:-false}"
+ if [[ "$EXP_ENABLED" != "true" && "$EXP_ENABLED" != "false" ]]; then
+ echo "❌ ERROR: EXP must be 'true' or 'false', got: '$EXP_ENABLED'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ EXP: '$EXP_ENABLED' is valid"
+ fi
+
+ # Validate build_docker_image (boolean)
+ BUILD_DOCKER="${INPUT_BUILD_DOCKER_IMAGE:-false}"
+ if [[ "$BUILD_DOCKER" != "true" && "$BUILD_DOCKER" != "false" ]]; then
+ echo "❌ ERROR: build_docker_image must be 'true' or 'false', got: '$BUILD_DOCKER'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ build_docker_image: '$BUILD_DOCKER' is valid"
+ fi
+
+ # Validate cleanup_resources (boolean)
+ CLEANUP_RESOURCES="${INPUT_CLEANUP_RESOURCES:-false}"
+ if [[ "$CLEANUP_RESOURCES" != "true" && "$CLEANUP_RESOURCES" != "false" ]]; then
+ echo "❌ ERROR: cleanup_resources must be 'true' or 'false', got: '$CLEANUP_RESOURCES'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ cleanup_resources: '$CLEANUP_RESOURCES' is valid"
+ fi
+
+ # Validate run_e2e_tests (specific allowed values)
+ TEST_OPTION="${INPUT_RUN_E2E_TESTS:-GoldenPath-Testing}"
+ if [[ "$TEST_OPTION" != "GoldenPath-Testing" && "$TEST_OPTION" != "Smoke-Testing" && "$TEST_OPTION" != "None" ]]; then
+ echo "❌ ERROR: run_e2e_tests must be one of: GoldenPath-Testing, Smoke-Testing, None, got: '$TEST_OPTION'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ run_e2e_tests: '$TEST_OPTION' is valid"
+ fi
+
+ # Validate AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID (optional, Azure Resource ID format)
+ if [[ -n "$INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID" ]]; then
+ if [[ ! "$INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID" =~ ^/subscriptions/[a-fA-F0-9-]+/[Rr]esource[Gg]roups/[^/]+/providers/[Mm]icrosoft\.[Oo]perational[Ii]nsights/[Ww]orkspaces/[^/]+$ ]]; then
+ echo "❌ ERROR: AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID is invalid. Must be a valid Azure Resource ID format:"
+ echo " /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}"
+ echo " Got: '$INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID: Valid Resource ID format"
+ fi
+ else
+ echo "✅ AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID: Not provided (optional)"
+ fi
+
+ # Validate AZURE_EXISTING_AI_PROJECT_RESOURCE_ID (optional, Azure Resource ID format)
+ if [[ -n "$INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID" ]]; then
+ if [[ ! "$INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID" =~ ^/subscriptions/[a-fA-F0-9-]+/[Rr]esource[Gg]roups/[^/]+/providers/([Mm]icrosoft\.[Mm]achine[Ll]earning[Ss]ervices/([Ww]orkspaces|[Pp]rojects)/[^/]+|[Mm]icrosoft\.[Cc]ognitive[Ss]ervices/[Aa]ccounts/[^/]+/[Pp]rojects/[^/]+)$ ]]; then
+ echo "❌ ERROR: AZURE_EXISTING_AI_PROJECT_RESOURCE_ID is invalid. Must be a valid Azure Resource ID format:"
+ echo " /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}"
+ echo " Got: '$INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ AZURE_EXISTING_AI_PROJECT_RESOURCE_ID: Valid Resource ID format"
+ fi
+ else
+ echo "✅ AZURE_EXISTING_AI_PROJECT_RESOURCE_ID: Not provided (optional)"
+ fi
+
+ # Validate existing_webapp_url (optional, must start with https)
+ if [[ -n "$INPUT_EXISTING_WEBAPP_URL" ]]; then
+ if [[ ! "$INPUT_EXISTING_WEBAPP_URL" =~ ^https:// ]]; then
+ echo "❌ ERROR: existing_webapp_url must start with 'https://', got: '$INPUT_EXISTING_WEBAPP_URL'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ existing_webapp_url: '$INPUT_EXISTING_WEBAPP_URL' is valid"
+ fi
+ else
+ echo "✅ existing_webapp_url: Not provided (will perform deployment)"
+ fi
+
+ # Fail workflow if any validation failed
+ if [[ "$VALIDATION_FAILED" == "true" ]]; then
+ echo ""
+ echo "❌ Parameter validation failed. Please correct the errors above and try again."
+ exit 1
+ fi
+
+ echo ""
+ echo "✅ All input parameters validated successfully!"
+
+ # Output validated values
+ echo "passed=true" >> $GITHUB_OUTPUT
+ echo "azure_location=$LOCATION" >> $GITHUB_OUTPUT
+ echo "resource_group_name=$INPUT_RESOURCE_GROUP_NAME" >> $GITHUB_OUTPUT
+ echo "waf_enabled=$WAF_ENABLED" >> $GITHUB_OUTPUT
+ echo "exp=$EXP_ENABLED" >> $GITHUB_OUTPUT
+ echo "build_docker_image=$BUILD_DOCKER" >> $GITHUB_OUTPUT
+ echo "cleanup_resources=$CLEANUP_RESOURCES" >> $GITHUB_OUTPUT
+ echo "run_e2e_tests=$TEST_OPTION" >> $GITHUB_OUTPUT
+ echo "azure_env_log_analytics_workspace_id=$INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID" >> $GITHUB_OUTPUT
+ echo "azure_existing_ai_project_resource_id=$INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID" >> $GITHUB_OUTPUT
+ echo "existing_webapp_url=$INPUT_EXISTING_WEBAPP_URL" >> $GITHUB_OUTPUT
+
+ Run:
+ needs: validate-inputs
+ if: needs.validate-inputs.outputs.validation_passed == 'true'
+ uses: ./.github/workflows/deploy-orchestrator.yml
+ with:
+ runner_os: windows-latest
+ azure_location: ${{ needs.validate-inputs.outputs.azure_location || 'australiaeast' }}
+ resource_group_name: ${{ needs.validate-inputs.outputs.resource_group_name || '' }}
+ waf_enabled: ${{ needs.validate-inputs.outputs.waf_enabled == 'true' }}
+ EXP: ${{ needs.validate-inputs.outputs.exp == 'true' }}
+ build_docker_image: ${{ needs.validate-inputs.outputs.build_docker_image == 'true' }}
+ cleanup_resources: ${{ needs.validate-inputs.outputs.cleanup_resources == 'true' }}
+ run_e2e_tests: ${{ needs.validate-inputs.outputs.run_e2e_tests || 'GoldenPath-Testing' }}
+ AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID: ${{ needs.validate-inputs.outputs.azure_env_log_analytics_workspace_id || '' }}
+ AZURE_EXISTING_AI_PROJECT_RESOURCE_ID: ${{ needs.validate-inputs.outputs.azure_existing_ai_project_resource_id || '' }}
+ existing_webapp_url: ${{ needs.validate-inputs.outputs.existing_webapp_url || '' }}
+ trigger_type: ${{ github.event_name }}
+ secrets: inherit
diff --git a/.github/workflows/deploy.yml b/archive-doc-gen/.github/workflows/deploy.yml
similarity index 94%
rename from .github/workflows/deploy.yml
rename to archive-doc-gen/.github/workflows/deploy.yml
index 56910420f..ab8bf299a 100644
--- a/.github/workflows/deploy.yml
+++ b/archive-doc-gen/.github/workflows/deploy.yml
@@ -20,7 +20,10 @@ env:
GPT_MIN_CAPACITY: 150
TEXT_EMBEDDING_MIN_CAPACITY: 80
BRANCH_NAME: ${{ github.event.workflow_run.head_branch || github.head_ref || github.ref_name }}
-
+permissions:
+ contents: read
+ actions: read
+
jobs:
deploy:
runs-on: ubuntu-latest
@@ -31,26 +34,21 @@ jobs:
- name: Checkout Code
uses: actions/checkout@v6
- - name: Setup Azure CLI
- run: |
- curl -sL https://aka.ms/InstallAzureCLIDeb | sudo bash
- az --version # Verify installation
-
- name: Login to Azure
run: |
az login --service-principal -u ${{ secrets.AZURE_CLIENT_ID }} -p ${{ secrets.AZURE_CLIENT_SECRET }} --tenant ${{ secrets.AZURE_TENANT_ID }}
- name: Run Quota Check
id: quota-check
+ env:
+ AZURE_CLIENT_ID: ${{ secrets.AZURE_CLIENT_ID }}
+ AZURE_TENANT_ID: ${{ secrets.AZURE_TENANT_ID }}
+ AZURE_CLIENT_SECRET: ${{ secrets.AZURE_CLIENT_SECRET }}
+ AZURE_SUBSCRIPTION_ID: ${{ secrets.AZURE_SUBSCRIPTION_ID }}
+ GPT_MIN_CAPACITY: ${{ env.GPT_MIN_CAPACITY }}
+ TEXT_EMBEDDING_MIN_CAPACITY: ${{ env.TEXT_EMBEDDING_MIN_CAPACITY }}
+ AZURE_REGIONS: ${{ vars.AZURE_REGIONS }}
run: |
- export AZURE_CLIENT_ID=${{ secrets.AZURE_CLIENT_ID }}
- export AZURE_TENANT_ID=${{ secrets.AZURE_TENANT_ID }}
- export AZURE_CLIENT_SECRET=${{ secrets.AZURE_CLIENT_SECRET }}
- export AZURE_SUBSCRIPTION_ID="${{ secrets.AZURE_SUBSCRIPTION_ID }}"
- export GPT_MIN_CAPACITY=${{ env.GPT_MIN_CAPACITY }}
- export TEXT_EMBEDDING_MIN_CAPACITY=${{ env.TEXT_EMBEDDING_MIN_CAPACITY }}
- export AZURE_REGIONS="${{ vars.AZURE_REGIONS }}"
-
chmod +x scripts/checkquota.sh
if ! scripts/checkquota.sh; then
# If quota check fails due to insufficient quota, set the flag
@@ -158,7 +156,7 @@ jobs:
azureAiServiceLocation=${{ env.AZURE_AI_LOCATION }} \
imageTag="${IMAGE_TAG}"\
createdBy="Pipeline" \
- tags="{'SecurityControl':'Ignore','Purpose':'Deploying and Cleaning Up Resources for Validation','CreatedDate':'$current_date'}"
+ tags="{'Purpose':'Deploying and Cleaning Up Resources for Validation','CreatedDate':'$current_date'}"
- name: Get Deployment Output and extract Values
id: get_output
@@ -224,11 +222,6 @@ jobs:
env:
RESOURCE_GROUP_NAME: ${{ needs.deploy.outputs.RESOURCE_GROUP_NAME }}
steps:
- - name: Setup Azure CLI
- run: |
- curl -sL https://aka.ms/InstallAzureCLIDeb | sudo bash
- az --version # Verify installation
-
- name: Login to Azure
run: |
az login --service-principal -u ${{ secrets.AZURE_CLIENT_ID }} -p ${{ secrets.AZURE_CLIENT_SECRET }} --tenant ${{ secrets.AZURE_TENANT_ID }}
diff --git a/.github/workflows/docker-build-and-push.yml b/archive-doc-gen/.github/workflows/docker-build-and-push.yml
similarity index 98%
rename from .github/workflows/docker-build-and-push.yml
rename to archive-doc-gen/.github/workflows/docker-build-and-push.yml
index b04d18ea6..07fe2858d 100644
--- a/.github/workflows/docker-build-and-push.yml
+++ b/archive-doc-gen/.github/workflows/docker-build-and-push.yml
@@ -26,7 +26,10 @@ on:
- '!src/tests/**'
merge_group:
workflow_dispatch:
-
+permissions:
+ contents: read
+ actions: read
+
jobs:
build-and-push:
runs-on: ubuntu-latest
diff --git a/archive-doc-gen/.github/workflows/job-cleanup-deployment.yml b/archive-doc-gen/.github/workflows/job-cleanup-deployment.yml
new file mode 100644
index 000000000..0e8aef426
--- /dev/null
+++ b/archive-doc-gen/.github/workflows/job-cleanup-deployment.yml
@@ -0,0 +1,109 @@
+name: Cleanup Deployment Job
+on:
+ workflow_call:
+ inputs:
+ runner_os:
+ description: 'Runner OS (ubuntu-latest or windows-latest)'
+ required: true
+ type: string
+ trigger_type:
+ description: 'Trigger type (workflow_dispatch, pull_request, schedule)'
+ required: true
+ type: string
+ cleanup_resources:
+ description: 'Cleanup Deployed Resources'
+ required: false
+ default: false
+ type: boolean
+ existing_webapp_url:
+ description: 'Existing Container WebApp URL (Skips Deployment)'
+ required: false
+ default: ''
+ type: string
+ RESOURCE_GROUP_NAME:
+ description: 'Resource Group Name to cleanup'
+ required: true
+ type: string
+ AZURE_LOCATION:
+ description: 'Azure Location'
+ required: true
+ type: string
+ AZURE_ENV_OPENAI_LOCATION:
+ description: 'Azure OpenAI Location'
+ required: true
+ type: string
+ ENV_NAME:
+ description: 'Environment Name'
+ required: true
+ type: string
+ IMAGE_TAG:
+ description: 'Docker Image Tag'
+ required: true
+ type: string
+permissions:
+ contents: read
+ actions: read
+
+jobs:
+ cleanup-deployment:
+ runs-on: ${{ inputs.runner_os }}
+ continue-on-error: true
+ env:
+ RESOURCE_GROUP_NAME: ${{ inputs.RESOURCE_GROUP_NAME }}
+ AZURE_LOCATION: ${{ inputs.AZURE_LOCATION }}
+ AZURE_ENV_OPENAI_LOCATION: ${{ inputs.AZURE_ENV_OPENAI_LOCATION }}
+ ENV_NAME: ${{ inputs.ENV_NAME }}
+ IMAGE_TAG: ${{ inputs.IMAGE_TAG }}
+ steps:
+ - name: Login to Azure
+ shell: bash
+ run: |
+ az login --service-principal -u ${{ secrets.AZURE_CLIENT_ID }} -p ${{ secrets.AZURE_CLIENT_SECRET }} --tenant ${{ secrets.AZURE_TENANT_ID }}
+ az account set --subscription ${{ secrets.AZURE_SUBSCRIPTION_ID }}
+
+ - name: Delete Resource Group (Optimized Cleanup)
+ id: delete_rg
+ shell: bash
+ run: |
+ set -e
+ echo "🗑️ Starting optimized resource cleanup..."
+ echo "Deleting resource group: ${{ env.RESOURCE_GROUP_NAME }}"
+
+ az group delete \
+ --name "${{ env.RESOURCE_GROUP_NAME }}" \
+ --yes \
+ --no-wait
+
+ echo "✅ Resource group deletion initiated (running asynchronously)"
+ echo "Note: Resources will be cleaned up in the background"
+
+ - name: Logout from Azure
+ if: always()
+ shell: bash
+ run: |
+ azd auth logout || true
+ az logout || echo "Warning: Failed to logout from Azure CLI"
+ echo "Logged out from Azure."
+
+ - name: Generate Cleanup Job Summary
+ if: always()
+ shell: bash
+ run: |
+ echo "## 🧹 Cleanup Job Summary" >> $GITHUB_STEP_SUMMARY
+ echo "" >> $GITHUB_STEP_SUMMARY
+ echo "| Field | Value |" >> $GITHUB_STEP_SUMMARY
+ echo "|-------|--------|" >> $GITHUB_STEP_SUMMARY
+ echo "| **Resource Group deletion Status** | ${{ steps.delete_rg.outcome == 'success' && '✅ Initiated' || '❌ Failed' }} |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Resource Group** | \`${{ env.RESOURCE_GROUP_NAME }}\` |" >> $GITHUB_STEP_SUMMARY
+ echo "" >> $GITHUB_STEP_SUMMARY
+ if [[ "${{ steps.delete_rg.outcome }}" == "success" ]]; then
+ echo "### ✅ Cleanup Details" >> $GITHUB_STEP_SUMMARY
+ echo "- Successfully initiated deletion for Resource Group \`${{ env.RESOURCE_GROUP_NAME }}\`" >> $GITHUB_STEP_SUMMARY
+ echo "" >> $GITHUB_STEP_SUMMARY
+ else
+ echo "### ❌ Cleanup Failed" >> $GITHUB_STEP_SUMMARY
+ echo "- Cleanup process encountered an error" >> $GITHUB_STEP_SUMMARY
+ echo "- Manual cleanup may be required for:" >> $GITHUB_STEP_SUMMARY
+ echo " - Resource Group: \`${{ env.RESOURCE_GROUP_NAME }}\`" >> $GITHUB_STEP_SUMMARY
+ echo "- Check the cleanup-deployment job logs for detailed error information" >> $GITHUB_STEP_SUMMARY
+ fi
diff --git a/archive-doc-gen/.github/workflows/job-deploy-linux.yml b/archive-doc-gen/.github/workflows/job-deploy-linux.yml
new file mode 100644
index 000000000..37d1b82a2
--- /dev/null
+++ b/archive-doc-gen/.github/workflows/job-deploy-linux.yml
@@ -0,0 +1,403 @@
+name: Deploy Steps - Linux
+
+on:
+ workflow_call:
+ inputs:
+ ENV_NAME:
+ required: true
+ type: string
+ AZURE_ENV_OPENAI_LOCATION:
+ required: true
+ type: string
+ AZURE_LOCATION:
+ required: true
+ type: string
+ RESOURCE_GROUP_NAME:
+ required: true
+ type: string
+ IMAGE_TAG:
+ required: true
+ type: string
+ BUILD_DOCKER_IMAGE:
+ required: true
+ type: string
+ EXP:
+ required: true
+ type: string
+ WAF_ENABLED:
+ required: false
+ type: string
+ default: 'false'
+ AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID:
+ required: false
+ type: string
+ AZURE_EXISTING_AI_PROJECT_RESOURCE_ID:
+ required: false
+ type: string
+ outputs:
+ WEB_APPURL:
+ description: "Container Web App URL"
+ value: ${{ jobs.deploy-linux.outputs.WEB_APPURL }}
+permissions:
+ contents: read
+ actions: read
+
+jobs:
+ deploy-linux:
+ runs-on: ubuntu-latest
+ env:
+ AZURE_DEV_COLLECT_TELEMETRY: ${{ vars.AZURE_DEV_COLLECT_TELEMETRY }}
+ outputs:
+ WEB_APPURL: ${{ steps.get_output_linux.outputs.WEB_APPURL }}
+ steps:
+ - name: Validate Workflow Input Parameters
+ shell: bash
+ env:
+ INPUT_ENV_NAME: ${{ inputs.ENV_NAME }}
+ INPUT_AZURE_ENV_OPENAI_LOCATION: ${{ inputs.AZURE_ENV_OPENAI_LOCATION }}
+ INPUT_AZURE_LOCATION: ${{ inputs.AZURE_LOCATION }}
+ INPUT_RESOURCE_GROUP_NAME: ${{ inputs.RESOURCE_GROUP_NAME }}
+ INPUT_IMAGE_TAG: ${{ inputs.IMAGE_TAG }}
+ INPUT_BUILD_DOCKER_IMAGE: ${{ inputs.BUILD_DOCKER_IMAGE }}
+ INPUT_EXP: ${{ inputs.EXP }}
+ INPUT_WAF_ENABLED: ${{ inputs.WAF_ENABLED }}
+ INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID: ${{ inputs.AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID }}
+ INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID: ${{ inputs.AZURE_EXISTING_AI_PROJECT_RESOURCE_ID }}
+ run: |
+ echo "🔍 Validating workflow input parameters..."
+ VALIDATION_FAILED=false
+
+ # Validate ENV_NAME (required, alphanumeric and hyphens)
+ if [[ -z "$INPUT_ENV_NAME" ]]; then
+ echo "❌ ERROR: ENV_NAME is required but not provided"
+ VALIDATION_FAILED=true
+ elif [[ ! "$INPUT_ENV_NAME" =~ ^[a-zA-Z0-9-]+$ ]]; then
+ echo "❌ ERROR: ENV_NAME '$INPUT_ENV_NAME' is invalid. Must contain only alphanumerics and hyphens"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ ENV_NAME: '$INPUT_ENV_NAME' is valid"
+ fi
+
+ # Validate AZURE_ENV_OPENAI_LOCATION (required, Azure region format)
+ if [[ -z "$INPUT_AZURE_ENV_OPENAI_LOCATION" ]]; then
+ echo "❌ ERROR: AZURE_ENV_OPENAI_LOCATION is required but not provided"
+ VALIDATION_FAILED=true
+ elif [[ ! "$INPUT_AZURE_ENV_OPENAI_LOCATION" =~ ^[a-z0-9]+$ ]]; then
+ echo "❌ ERROR: AZURE_ENV_OPENAI_LOCATION '$INPUT_AZURE_ENV_OPENAI_LOCATION' is invalid. Must contain only lowercase letters and numbers"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ AZURE_ENV_OPENAI_LOCATION: '$INPUT_AZURE_ENV_OPENAI_LOCATION' is valid"
+ fi
+
+ # Validate AZURE_LOCATION (required, Azure region format)
+ if [[ -z "$INPUT_AZURE_LOCATION" ]]; then
+ echo "❌ ERROR: AZURE_LOCATION is required but not provided"
+ VALIDATION_FAILED=true
+ elif [[ ! "$INPUT_AZURE_LOCATION" =~ ^[a-z0-9]+$ ]]; then
+ echo "❌ ERROR: AZURE_LOCATION '$INPUT_AZURE_LOCATION' is invalid. Must contain only lowercase letters and numbers"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ AZURE_LOCATION: '$INPUT_AZURE_LOCATION' is valid"
+ fi
+
+ # Validate RESOURCE_GROUP_NAME (required, Azure naming convention)
+ if [[ -z "$INPUT_RESOURCE_GROUP_NAME" ]]; then
+ echo "❌ ERROR: RESOURCE_GROUP_NAME is required but not provided"
+ VALIDATION_FAILED=true
+ elif [[ ! "$INPUT_RESOURCE_GROUP_NAME" =~ ^[a-zA-Z0-9._\(\)-]+$ ]] || [[ "$INPUT_RESOURCE_GROUP_NAME" =~ \.$ ]]; then
+ echo "❌ ERROR: RESOURCE_GROUP_NAME '$INPUT_RESOURCE_GROUP_NAME' is invalid. Must contain only alphanumerics, periods, underscores, hyphens, and parentheses. Cannot end with period."
+ VALIDATION_FAILED=true
+ elif [[ ${#INPUT_RESOURCE_GROUP_NAME} -gt 90 ]]; then
+ echo "❌ ERROR: RESOURCE_GROUP_NAME '$INPUT_RESOURCE_GROUP_NAME' exceeds 90 characters"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ RESOURCE_GROUP_NAME: '$INPUT_RESOURCE_GROUP_NAME' is valid"
+ fi
+
+ # Validate IMAGE_TAG (required, Docker tag pattern)
+ if [[ -z "$INPUT_IMAGE_TAG" ]]; then
+ echo "❌ ERROR: IMAGE_TAG is required but not provided"
+ VALIDATION_FAILED=true
+ elif [[ ! "$INPUT_IMAGE_TAG" =~ ^[a-zA-Z0-9_][a-zA-Z0-9._-]{0,127}$ ]]; then
+ echo "❌ ERROR: IMAGE_TAG '$INPUT_IMAGE_TAG' is invalid. Must start with alphanumeric or underscore, max 128 characters"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ IMAGE_TAG: '$INPUT_IMAGE_TAG' is valid"
+ fi
+
+ # Validate BUILD_DOCKER_IMAGE (required, must be 'true' or 'false')
+ if [[ "$INPUT_BUILD_DOCKER_IMAGE" != "true" && "$INPUT_BUILD_DOCKER_IMAGE" != "false" ]]; then
+ echo "❌ ERROR: BUILD_DOCKER_IMAGE must be 'true' or 'false', got: '$INPUT_BUILD_DOCKER_IMAGE'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ BUILD_DOCKER_IMAGE: '$INPUT_BUILD_DOCKER_IMAGE' is valid"
+ fi
+
+ # Validate EXP (required, must be 'true' or 'false')
+ if [[ "$INPUT_EXP" != "true" && "$INPUT_EXP" != "false" ]]; then
+ echo "❌ ERROR: EXP must be 'true' or 'false', got: '$INPUT_EXP'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ EXP: '$INPUT_EXP' is valid"
+ fi
+
+ # Validate WAF_ENABLED (must be 'true' or 'false')
+ if [[ "$INPUT_WAF_ENABLED" != "true" && "$INPUT_WAF_ENABLED" != "false" ]]; then
+ echo "❌ ERROR: WAF_ENABLED must be 'true' or 'false', got: '$INPUT_WAF_ENABLED'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ WAF_ENABLED: '$INPUT_WAF_ENABLED' is valid"
+ fi
+
+ # Validate AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID (optional, if provided must be valid Resource ID)
+ if [[ -n "$INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID" ]]; then
+ if [[ ! "$INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID" =~ ^/subscriptions/[a-fA-F0-9-]+/[Rr]esource[Gg]roups/[^/]+/providers/[Mm]icrosoft\.[Oo]perational[Ii]nsights/[Ww]orkspaces/[^/]+$ ]]; then
+ echo "❌ ERROR: AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID is invalid. Must be a valid Azure Resource ID format:"
+ echo " /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}"
+ echo " Got: '$INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID: Valid Resource ID format"
+ fi
+ fi
+
+ # Validate AZURE_EXISTING_AI_PROJECT_RESOURCE_ID (optional, if provided must be valid Resource ID)
+ if [[ -n "$INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID" ]]; then
+ if [[ ! "$INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID" =~ ^/subscriptions/[a-fA-F0-9-]+/[Rr]esource[Gg]roups/[^/]+/providers/([Mm]icrosoft\.[Mm]achine[Ll]earning[Ss]ervices/([Ww]orkspaces|[Pp]rojects)/[^/]+|[Mm]icrosoft\.[Cc]ognitive[Ss]ervices/[Aa]ccounts/[^/]+/[Pp]rojects/[^/]+)$ ]]; then
+ echo "❌ ERROR: AZURE_EXISTING_AI_PROJECT_RESOURCE_ID is invalid. Must be a valid Azure Resource ID format:"
+ echo " /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}"
+ echo " Got: '$INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ AZURE_EXISTING_AI_PROJECT_RESOURCE_ID: Valid Resource ID format"
+ fi
+ fi
+
+ # Fail workflow if any validation failed
+ if [[ "$VALIDATION_FAILED" == "true" ]]; then
+ echo ""
+ echo "❌ Parameter validation failed. Please correct the errors above and try again."
+ exit 1
+ fi
+
+ echo ""
+ echo "✅ All input parameters validated successfully!"
+ - name: Checkout Code
+ uses: actions/checkout@v4
+
+ - name: Configure Parameters Based on WAF Setting
+ shell: bash
+ env:
+ WAF_ENABLED: ${{ inputs.WAF_ENABLED }}
+ run: |
+ if [[ "$WAF_ENABLED" == "true" ]]; then
+ cp infra/main.waf.parameters.json infra/main.parameters.json
+ echo "✅ Successfully copied WAF parameters to main parameters file"
+ else
+ echo "🔧 Configuring Non-WAF deployment - using default main.parameters.json..."
+ fi
+
+ - name: Install azd
+ uses: Azure/setup-azd@v2
+
+ - name: Login to AZD
+ id: login-azure
+ shell: bash
+ run: |
+ az login --service-principal -u ${{ secrets.AZURE_CLIENT_ID }} -p ${{ secrets.AZURE_CLIENT_SECRET }} --tenant ${{ secrets.AZURE_TENANT_ID }}
+ az account set --subscription ${{ secrets.AZURE_SUBSCRIPTION_ID }}
+ azd auth login --client-id ${{ secrets.AZURE_CLIENT_ID }} --client-secret ${{ secrets.AZURE_CLIENT_SECRET }} --tenant-id ${{ secrets.AZURE_TENANT_ID }}
+
+ - name: Deploy using azd up and extract values (Linux)
+ id: get_output_linux
+ shell: bash
+ env:
+ ENV_NAME: ${{ inputs.ENV_NAME }}
+ AZURE_ENV_OPENAI_LOCATION: ${{ inputs.AZURE_ENV_OPENAI_LOCATION }}
+ AZURE_LOCATION: ${{ inputs.AZURE_LOCATION }}
+ RESOURCE_GROUP_NAME: ${{ inputs.RESOURCE_GROUP_NAME }}
+ IMAGE_TAG: ${{ inputs.IMAGE_TAG }}
+ BUILD_DOCKER_IMAGE: ${{ inputs.BUILD_DOCKER_IMAGE }}
+ EXP: ${{ inputs.EXP }}
+ INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID: ${{ inputs.AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID }}
+ INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID: ${{ inputs.AZURE_EXISTING_AI_PROJECT_RESOURCE_ID }}
+ run: |
+ set -e
+
+ echo "Creating environment..."
+ azd env new "$ENV_NAME" --no-prompt
+ echo "Environment created: $ENV_NAME"
+
+ echo "Setting default subscription..."
+ azd config set defaults.subscription "${{ secrets.AZURE_SUBSCRIPTION_ID }}"
+
+ # Set additional parameters
+ azd env set AZURE_SUBSCRIPTION_ID="${{ secrets.AZURE_SUBSCRIPTION_ID }}"
+ azd env set AZURE_ENV_OPENAI_LOCATION="$AZURE_ENV_OPENAI_LOCATION"
+ azd env set AZURE_LOCATION="$AZURE_LOCATION"
+ azd env set AZURE_RESOURCE_GROUP="$RESOURCE_GROUP_NAME"
+ azd env set AZURE_ENV_IMAGETAG="$IMAGE_TAG"
+
+ # Set ACR name only when building Docker image
+ if [[ "$BUILD_DOCKER_IMAGE" == "true" ]]; then
+ # Extract ACR name from login server and set as environment variable
+ ACR_NAME="${{ secrets.ACR_TEST_USERNAME }}"
+ azd env set AZURE_ENV_ACR_NAME="$ACR_NAME"
+ echo "Set ACR name to: $ACR_NAME"
+ else
+ echo "Skipping ACR name configuration (using existing image)"
+ fi
+
+ if [[ "$EXP" == "true" ]]; then
+ echo "✅ EXP ENABLED - Setting EXP parameters..."
+
+ # Set EXP variables dynamically
+ if [[ -n "$INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID" ]]; then
+ EXP_LOG_ANALYTICS_ID="$INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID"
+ else
+ EXP_LOG_ANALYTICS_ID="${{ secrets.AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID }}"
+ fi
+
+ if [[ -n "$INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID" ]]; then
+ EXP_AI_PROJECT_ID="$INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID"
+ else
+ EXP_AI_PROJECT_ID="${{ secrets.AZURE_EXISTING_AI_PROJECT_RESOURCE_ID }}"
+ fi
+
+ echo "AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID: $EXP_LOG_ANALYTICS_ID"
+ echo "AZURE_EXISTING_AI_PROJECT_RESOURCE_ID: $EXP_AI_PROJECT_ID"
+ azd env set AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID="$EXP_LOG_ANALYTICS_ID"
+ azd env set AZURE_EXISTING_AI_PROJECT_RESOURCE_ID="$EXP_AI_PROJECT_ID"
+ else
+ echo "❌ EXP DISABLED - Skipping EXP parameters"
+ if [[ -n "$INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID" ]] || [[ -n "$INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID" ]]; then
+ echo "⚠️ Warning: EXP parameter values provided but EXP is disabled. These values will be ignored."
+ fi
+ fi
+
+ # Deploy using azd up
+ azd up --no-prompt
+
+ # Get deployment outputs using azd
+ echo "Extracting deployment outputs..."
+ DEPLOY_OUTPUT=$(azd env get-values --output json)
+ echo "Deployment output: $DEPLOY_OUTPUT"
+
+ if [[ -z "$DEPLOY_OUTPUT" ]]; then
+ echo "Error: Deployment output is empty. Please check the deployment logs."
+ exit 1
+ fi
+
+ # Extract values from azd output (adjust these based on actual output variable names)
+ AI_FOUNDRY_RESOURCE_ID=$(echo "$DEPLOY_OUTPUT" | jq -r '.AI_FOUNDRY_RESOURCE_ID // empty')
+ echo "AI_FOUNDRY_RESOURCE_ID=$AI_FOUNDRY_RESOURCE_ID" >> $GITHUB_ENV
+
+ AI_SEARCH_SERVICE_NAME=$(echo "$DEPLOY_OUTPUT" | jq -r '.AI_SEARCH_SERVICE_NAME // empty')
+ echo "AI_SEARCH_SERVICE_NAME=$AI_SEARCH_SERVICE_NAME" >> $GITHUB_ENV
+
+ AZURE_COSMOSDB_ACCOUNT=$(echo "$DEPLOY_OUTPUT" | jq -r '.AZURE_COSMOSDB_ACCOUNT // empty')
+ echo "AZURE_COSMOSDB_ACCOUNT=$AZURE_COSMOSDB_ACCOUNT" >> $GITHUB_ENV
+
+ STORAGE_ACCOUNT_NAME=$(echo "$DEPLOY_OUTPUT" | jq -r '.STORAGE_ACCOUNT_NAME // empty')
+ echo "STORAGE_ACCOUNT_NAME=$STORAGE_ACCOUNT_NAME" >> $GITHUB_ENV
+
+ STORAGE_CONTAINER_NAME=$(echo "$DEPLOY_OUTPUT" | jq -r '.STORAGE_CONTAINER_NAME // empty')
+ echo "STORAGE_CONTAINER_NAME=$STORAGE_CONTAINER_NAME" >> $GITHUB_ENV
+
+ KEY_VAULT_NAME=$(echo "$DEPLOY_OUTPUT" | jq -r '.KEY_VAULT_NAME // empty')
+ echo "KEY_VAULT_NAME=$KEY_VAULT_NAME" >> $GITHUB_ENV
+
+ RESOURCE_GROUP_NAME=$(echo "$DEPLOY_OUTPUT" | jq -r '.RESOURCE_GROUP_NAME // empty')
+ echo "RESOURCE_GROUP_NAME=$RESOURCE_GROUP_NAME" >> $GITHUB_ENV
+
+ WEB_APPURL=$(echo "$DEPLOY_OUTPUT" | jq -r '.WEB_APP_URL // .SERVICE_BACKEND_ENDPOINT_URL // empty')
+ echo "WEB_APPURL=$WEB_APPURL" >> $GITHUB_OUTPUT
+ sleep 30
+
+ - name: Run Post-Deployment Script
+ id: post_deploy
+ env:
+ AZURE_SUBSCRIPTION_ID: ${{ secrets.AZURE_SUBSCRIPTION_ID }}
+ AZURE_CLIENT_ID: ${{ secrets.AZURE_CLIENT_ID }}
+ STORAGE_ACCOUNT_NAME: ${{ env.STORAGE_ACCOUNT_NAME }}
+ STORAGE_CONTAINER_NAME: ${{ env.STORAGE_CONTAINER_NAME }}
+ KEY_VAULT_NAME: ${{ env.KEY_VAULT_NAME }}
+ AZURE_COSMOSDB_ACCOUNT: ${{ env.AZURE_COSMOSDB_ACCOUNT }}
+ RESOURCE_GROUP_NAME: ${{ env.RESOURCE_GROUP_NAME }}
+ AI_SEARCH_SERVICE_NAME: ${{ env.AI_SEARCH_SERVICE_NAME }}
+ AI_FOUNDRY_RESOURCE_ID: ${{ env.AI_FOUNDRY_RESOURCE_ID }}
+ run: |
+ set -e
+ az account set --subscription "$AZURE_SUBSCRIPTION_ID"
+
+ echo "Running post-deployment script..."
+
+ bash ./infra/scripts/process_sample_data.sh \
+ "$STORAGE_ACCOUNT_NAME" \
+ "$STORAGE_CONTAINER_NAME" \
+ "$KEY_VAULT_NAME" \
+ "$AZURE_COSMOSDB_ACCOUNT" \
+ "$RESOURCE_GROUP_NAME" \
+ "$AI_SEARCH_SERVICE_NAME" \
+ "$AZURE_CLIENT_ID" \
+ "$AI_FOUNDRY_RESOURCE_ID"
+
+ - name: Generate Deploy Job Summary
+ if: always()
+ env:
+ RESOURCE_GROUP_NAME: ${{ inputs.RESOURCE_GROUP_NAME }}
+ WAF_ENABLED: ${{ inputs.WAF_ENABLED }}
+ EXP: ${{ inputs.EXP }}
+ AZURE_LOCATION: ${{ inputs.AZURE_LOCATION }}
+ AZURE_ENV_OPENAI_LOCATION: ${{ inputs.AZURE_ENV_OPENAI_LOCATION }}
+ IMAGE_TAG: ${{ inputs.IMAGE_TAG }}
+ JOB_STATUS: ${{ job.status }}
+ WEB_APPURL: ${{ steps.get_output_linux.outputs.WEB_APPURL }}
+ run: |
+ echo "## 🚀 Deploy Job Summary (Linux)" >> $GITHUB_STEP_SUMMARY
+ echo "" >> $GITHUB_STEP_SUMMARY
+ echo "| Field | Value |" >> $GITHUB_STEP_SUMMARY
+ echo "|-------|--------|" >> $GITHUB_STEP_SUMMARY
+
+ if [[ "$JOB_STATUS" == "success" ]]; then
+ echo "| **Job Status** | ✅ Success |" >> $GITHUB_STEP_SUMMARY
+ else
+ echo "| **Job Status** | ❌ Failed |" >> $GITHUB_STEP_SUMMARY
+ fi
+
+ echo "| **Resource Group** | \`$RESOURCE_GROUP_NAME\` |" >> $GITHUB_STEP_SUMMARY
+
+ # Determine configuration type
+ if [[ "$WAF_ENABLED" == "true" && "$EXP" == "true" ]]; then
+ CONFIG_TYPE="WAF + EXP"
+ elif [[ "$WAF_ENABLED" == "true" && "$EXP" != "true" ]]; then
+ CONFIG_TYPE="WAF + Non-EXP"
+ elif [[ "$WAF_ENABLED" != "true" && "$EXP" == "true" ]]; then
+ CONFIG_TYPE="Non-WAF + EXP"
+ else
+ CONFIG_TYPE="Non-WAF + Non-EXP"
+ fi
+ echo "| **Configuration Type** | \`$CONFIG_TYPE\` |" >> $GITHUB_STEP_SUMMARY
+
+ echo "| **Azure Region (Infrastructure)** | \`$AZURE_LOCATION\` |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Azure OpenAI Region** | \`$AZURE_ENV_OPENAI_LOCATION\` |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Docker Image Tag** | \`$IMAGE_TAG\` |" >> $GITHUB_STEP_SUMMARY
+ echo "" >> $GITHUB_STEP_SUMMARY
+
+ if [[ "$JOB_STATUS" == "success" ]]; then
+ echo "### ✅ Deployment Details" >> $GITHUB_STEP_SUMMARY
+ echo "- **Web App URL**: [$WEB_APPURL]($WEB_APPURL)" >> $GITHUB_STEP_SUMMARY
+ echo "- Successfully deployed to Azure with all resources configured" >> $GITHUB_STEP_SUMMARY
+ echo "- Post-deployment scripts executed successfully" >> $GITHUB_STEP_SUMMARY
+ else
+ echo "### ❌ Deployment Failed" >> $GITHUB_STEP_SUMMARY
+ echo "- Deployment process encountered an error" >> $GITHUB_STEP_SUMMARY
+ echo "- Check the deploy job for detailed error information" >> $GITHUB_STEP_SUMMARY
+ fi
+
+ - name: Logout from Azure
+ if: always()
+ shell: bash
+ run: |
+ az logout || true
+ echo "Logged out from Azure."
diff --git a/archive-doc-gen/.github/workflows/job-deploy-windows.yml b/archive-doc-gen/.github/workflows/job-deploy-windows.yml
new file mode 100644
index 000000000..e9dda12d4
--- /dev/null
+++ b/archive-doc-gen/.github/workflows/job-deploy-windows.yml
@@ -0,0 +1,394 @@
+name: Deploy Steps - Windows
+
+on:
+ workflow_call:
+ inputs:
+ ENV_NAME:
+ required: true
+ type: string
+ AZURE_ENV_OPENAI_LOCATION:
+ required: true
+ type: string
+ AZURE_LOCATION:
+ required: true
+ type: string
+ RESOURCE_GROUP_NAME:
+ required: true
+ type: string
+ IMAGE_TAG:
+ required: true
+ type: string
+ BUILD_DOCKER_IMAGE:
+ required: true
+ type: string
+ EXP:
+ required: true
+ type: string
+ WAF_ENABLED:
+ required: false
+ type: string
+ default: 'false'
+ AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID:
+ required: false
+ type: string
+ AZURE_EXISTING_AI_PROJECT_RESOURCE_ID:
+ required: false
+ type: string
+ outputs:
+ WEB_APPURL:
+ description: "Container Web App URL"
+ value: ${{ jobs.deploy-windows.outputs.WEB_APPURL }}
+permissions:
+ contents: read
+ actions: read
+
+jobs:
+ deploy-windows:
+ runs-on: windows-latest
+ env:
+ AZURE_DEV_COLLECT_TELEMETRY: ${{ vars.AZURE_DEV_COLLECT_TELEMETRY }}
+ outputs:
+ WEB_APPURL: ${{ steps.get_output_windows.outputs.WEB_APPURL }}
+ steps:
+ - name: Validate Workflow Input Parameters
+ shell: bash
+ env:
+ INPUT_ENV_NAME: ${{ inputs.ENV_NAME }}
+ INPUT_AZURE_ENV_OPENAI_LOCATION: ${{ inputs.AZURE_ENV_OPENAI_LOCATION }}
+ INPUT_AZURE_LOCATION: ${{ inputs.AZURE_LOCATION }}
+ INPUT_RESOURCE_GROUP_NAME: ${{ inputs.RESOURCE_GROUP_NAME }}
+ INPUT_IMAGE_TAG: ${{ inputs.IMAGE_TAG }}
+ INPUT_BUILD_DOCKER_IMAGE: ${{ inputs.BUILD_DOCKER_IMAGE }}
+ INPUT_EXP: ${{ inputs.EXP }}
+ INPUT_WAF_ENABLED: ${{ inputs.WAF_ENABLED }}
+ INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID: ${{ inputs.AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID }}
+ INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID: ${{ inputs.AZURE_EXISTING_AI_PROJECT_RESOURCE_ID }}
+ run: |
+ echo "🔍 Validating workflow input parameters..."
+ VALIDATION_FAILED=false
+
+ # Validate ENV_NAME (required, alphanumeric and hyphens)
+ if [[ -z "$INPUT_ENV_NAME" ]]; then
+ echo "❌ ERROR: ENV_NAME is required but not provided"
+ VALIDATION_FAILED=true
+ elif [[ ! "$INPUT_ENV_NAME" =~ ^[a-zA-Z0-9-]+$ ]]; then
+ echo "❌ ERROR: ENV_NAME '$INPUT_ENV_NAME' is invalid. Must contain only alphanumerics and hyphens"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ ENV_NAME: '$INPUT_ENV_NAME' is valid"
+ fi
+
+ # Validate AZURE_ENV_OPENAI_LOCATION (required, Azure region format)
+ if [[ -z "$INPUT_AZURE_ENV_OPENAI_LOCATION" ]]; then
+ echo "❌ ERROR: AZURE_ENV_OPENAI_LOCATION is required but not provided"
+ VALIDATION_FAILED=true
+ elif [[ ! "$INPUT_AZURE_ENV_OPENAI_LOCATION" =~ ^[a-z0-9]+$ ]]; then
+ echo "❌ ERROR: AZURE_ENV_OPENAI_LOCATION '$INPUT_AZURE_ENV_OPENAI_LOCATION' is invalid. Must contain only lowercase letters and numbers"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ AZURE_ENV_OPENAI_LOCATION: '$INPUT_AZURE_ENV_OPENAI_LOCATION' is valid"
+ fi
+
+ # Validate AZURE_LOCATION (required, Azure region format)
+ if [[ -z "$INPUT_AZURE_LOCATION" ]]; then
+ echo "❌ ERROR: AZURE_LOCATION is required but not provided"
+ VALIDATION_FAILED=true
+ elif [[ ! "$INPUT_AZURE_LOCATION" =~ ^[a-z0-9]+$ ]]; then
+ echo "❌ ERROR: AZURE_LOCATION '$INPUT_AZURE_LOCATION' is invalid. Must contain only lowercase letters and numbers"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ AZURE_LOCATION: '$INPUT_AZURE_LOCATION' is valid"
+ fi
+
+ # Validate RESOURCE_GROUP_NAME (required, Azure naming convention)
+ if [[ -z "$INPUT_RESOURCE_GROUP_NAME" ]]; then
+ echo "❌ ERROR: RESOURCE_GROUP_NAME is required but not provided"
+ VALIDATION_FAILED=true
+ elif [[ ! "$INPUT_RESOURCE_GROUP_NAME" =~ ^[a-zA-Z0-9._\(\)-]+$ ]] || [[ "$INPUT_RESOURCE_GROUP_NAME" =~ \.$ ]]; then
+ echo "❌ ERROR: RESOURCE_GROUP_NAME '$INPUT_RESOURCE_GROUP_NAME' is invalid. Must contain only alphanumerics, periods, underscores, hyphens, and parentheses. Cannot end with period."
+ VALIDATION_FAILED=true
+ elif [[ ${#INPUT_RESOURCE_GROUP_NAME} -gt 90 ]]; then
+ echo "❌ ERROR: RESOURCE_GROUP_NAME '$INPUT_RESOURCE_GROUP_NAME' exceeds 90 characters"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ RESOURCE_GROUP_NAME: '$INPUT_RESOURCE_GROUP_NAME' is valid"
+ fi
+
+ # Validate IMAGE_TAG (required, Docker tag pattern)
+ if [[ -z "$INPUT_IMAGE_TAG" ]]; then
+ echo "❌ ERROR: IMAGE_TAG is required but not provided"
+ VALIDATION_FAILED=true
+ elif [[ ! "$INPUT_IMAGE_TAG" =~ ^[a-zA-Z0-9_][a-zA-Z0-9._-]{0,127}$ ]]; then
+ echo "❌ ERROR: IMAGE_TAG '$INPUT_IMAGE_TAG' is invalid. Must start with alphanumeric or underscore, max 128 characters"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ IMAGE_TAG: '$INPUT_IMAGE_TAG' is valid"
+ fi
+
+ # Validate BUILD_DOCKER_IMAGE (required, must be 'true' or 'false')
+ if [[ "$INPUT_BUILD_DOCKER_IMAGE" != "true" && "$INPUT_BUILD_DOCKER_IMAGE" != "false" ]]; then
+ echo "❌ ERROR: BUILD_DOCKER_IMAGE must be 'true' or 'false', got: '$INPUT_BUILD_DOCKER_IMAGE'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ BUILD_DOCKER_IMAGE: '$INPUT_BUILD_DOCKER_IMAGE' is valid"
+ fi
+
+ # Validate EXP (required, must be 'true' or 'false')
+ if [[ "$INPUT_EXP" != "true" && "$INPUT_EXP" != "false" ]]; then
+ echo "❌ ERROR: EXP must be 'true' or 'false', got: '$INPUT_EXP'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ EXP: '$INPUT_EXP' is valid"
+ fi
+
+ # Validate WAF_ENABLED (must be 'true' or 'false')
+ if [[ "$INPUT_WAF_ENABLED" != "true" && "$INPUT_WAF_ENABLED" != "false" ]]; then
+ echo "❌ ERROR: WAF_ENABLED must be 'true' or 'false', got: '$INPUT_WAF_ENABLED'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ WAF_ENABLED: '$INPUT_WAF_ENABLED' is valid"
+ fi
+
+ # Validate AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID (optional, if provided must be valid Resource ID)
+ if [[ -n "$INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID" ]]; then
+ if [[ ! "$INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID" =~ ^/subscriptions/[a-fA-F0-9-]+/[Rr]esource[Gg]roups/[^/]+/providers/[Mm]icrosoft\.[Oo]perational[Ii]nsights/[Ww]orkspaces/[^/]+$ ]]; then
+ echo "❌ ERROR: AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID is invalid. Must be a valid Azure Resource ID format:"
+ echo " /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}"
+ echo " Got: '$INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID: Valid Resource ID format"
+ fi
+ fi
+
+ # Validate AZURE_EXISTING_AI_PROJECT_RESOURCE_ID (optional, if provided must be valid Resource ID)
+ if [[ -n "$INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID" ]]; then
+ if [[ ! "$INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID" =~ ^/subscriptions/[a-fA-F0-9-]+/[Rr]esource[Gg]roups/[^/]+/providers/([Mm]icrosoft\.[Mm]achine[Ll]earning[Ss]ervices/([Ww]orkspaces|[Pp]rojects)/[^/]+|[Mm]icrosoft\.[Cc]ognitive[Ss]ervices/[Aa]ccounts/[^/]+/[Pp]rojects/[^/]+)$ ]]; then
+ echo "❌ ERROR: AZURE_EXISTING_AI_PROJECT_RESOURCE_ID is invalid. Must be a valid Azure Resource ID format:"
+ echo " /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}"
+ echo " Got: '$INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ AZURE_EXISTING_AI_PROJECT_RESOURCE_ID: Valid Resource ID format"
+ fi
+ fi
+
+ # Fail workflow if any validation failed
+ if [[ "$VALIDATION_FAILED" == "true" ]]; then
+ echo ""
+ echo "❌ Parameter validation failed. Please correct the errors above and try again."
+ exit 1
+ fi
+
+ echo ""
+ echo "✅ All input parameters validated successfully!"
+
+ - name: Checkout Code
+ uses: actions/checkout@v4
+
+ - name: Configure Parameters Based on WAF Setting
+ shell: bash
+ env:
+ WAF_ENABLED: ${{ inputs.WAF_ENABLED }}
+ run: |
+ if [[ "$WAF_ENABLED" == "true" ]]; then
+ cp infra/main.waf.parameters.json infra/main.parameters.json
+ echo "✅ Successfully copied WAF parameters to main parameters file"
+ else
+ echo "🔧 Configuring Non-WAF deployment - using default main.parameters.json..."
+ fi
+
+ - name: Setup Azure Developer CLI (Windows)
+ uses: Azure/setup-azd@v2
+
+ - name: Login to AZD
+ id: login-azure
+ shell: bash
+ run: |
+ az login --service-principal -u ${{ secrets.AZURE_CLIENT_ID }} -p ${{ secrets.AZURE_CLIENT_SECRET }} --tenant ${{ secrets.AZURE_TENANT_ID }}
+ az account set --subscription ${{ secrets.AZURE_SUBSCRIPTION_ID }}
+ azd auth login --client-id ${{ secrets.AZURE_CLIENT_ID }} --client-secret ${{ secrets.AZURE_CLIENT_SECRET }} --tenant-id ${{ secrets.AZURE_TENANT_ID }}
+
+
+ - name: Deploy using azd up and extract values (Windows)
+ id: get_output_windows
+ shell: pwsh
+ env:
+ ENV_NAME: ${{ inputs.ENV_NAME }}
+ AZURE_ENV_OPENAI_LOCATION: ${{ inputs.AZURE_ENV_OPENAI_LOCATION }}
+ AZURE_LOCATION: ${{ inputs.AZURE_LOCATION }}
+ RESOURCE_GROUP_NAME: ${{ inputs.RESOURCE_GROUP_NAME }}
+ IMAGE_TAG: ${{ inputs.IMAGE_TAG }}
+ BUILD_DOCKER_IMAGE: ${{ inputs.BUILD_DOCKER_IMAGE }}
+ EXP: ${{ inputs.EXP }}
+ INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID: ${{ inputs.AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID }}
+ INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID: ${{ inputs.AZURE_EXISTING_AI_PROJECT_RESOURCE_ID }}
+ run: |
+ $ErrorActionPreference = "Stop"
+
+ Write-Host "Creating environment..."
+ azd env new $env:ENV_NAME --no-prompt
+ Write-Host "Environment created: $env:ENV_NAME"
+
+ Write-Host "Setting default subscription..."
+ azd config set defaults.subscription ${{ secrets.AZURE_SUBSCRIPTION_ID }}
+
+ # Set additional parameters
+ azd env set AZURE_SUBSCRIPTION_ID="${{ secrets.AZURE_SUBSCRIPTION_ID }}"
+ azd env set AZURE_ENV_OPENAI_LOCATION="$env:AZURE_ENV_OPENAI_LOCATION"
+ azd env set AZURE_LOCATION="$env:AZURE_LOCATION"
+ azd env set AZURE_RESOURCE_GROUP="$env:RESOURCE_GROUP_NAME"
+ azd env set AZURE_ENV_IMAGETAG="$env:IMAGE_TAG"
+
+ # Set ACR name only when building Docker image
+ if ($env:BUILD_DOCKER_IMAGE -eq "true") {
+ $ACR_NAME = "${{ secrets.ACR_TEST_USERNAME }}"
+ azd env set AZURE_ENV_ACR_NAME="$ACR_NAME"
+ Write-Host "Set ACR name to: $ACR_NAME"
+ } else {
+ Write-Host "Skipping ACR name configuration (using existing image)"
+ }
+
+ if ($env:EXP -eq "true") {
+ Write-Host "✅ EXP ENABLED - Setting EXP parameters..."
+
+ # Set EXP variables dynamically
+ if ($env:INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID -ne "") {
+ $EXP_LOG_ANALYTICS_ID = $env:INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID
+ } else {
+ $EXP_LOG_ANALYTICS_ID = "${{ secrets.AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID }}"
+ }
+
+ if ($env:INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID -ne "") {
+ $EXP_AI_PROJECT_ID = $env:INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID
+ } else {
+ $EXP_AI_PROJECT_ID = "${{ secrets.AZURE_EXISTING_AI_PROJECT_RESOURCE_ID }}"
+ }
+
+ Write-Host "AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID: $EXP_LOG_ANALYTICS_ID"
+ Write-Host "AZURE_EXISTING_AI_PROJECT_RESOURCE_ID: $EXP_AI_PROJECT_ID"
+ azd env set AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID="$EXP_LOG_ANALYTICS_ID"
+ azd env set AZURE_EXISTING_AI_PROJECT_RESOURCE_ID="$EXP_AI_PROJECT_ID"
+ } else {
+ Write-Host "❌ EXP DISABLED - Skipping EXP parameters"
+ }
+
+ # Deploy using azd up
+ azd up --no-prompt
+
+ Write-Host "✅ Deployment succeeded."
+
+ # Get deployment outputs using azd
+ Write-Host "Extracting deployment outputs..."
+ $DEPLOY_OUTPUT = azd env get-values --output json | ConvertFrom-Json
+ Write-Host "Deployment output: $($DEPLOY_OUTPUT | ConvertTo-Json -Depth 10)"
+
+ if (-not $DEPLOY_OUTPUT) {
+ Write-Host "Error: Deployment output is empty. Please check the deployment logs."
+ exit 1
+ }
+
+
+ $AI_FOUNDRY_RESOURCE_ID = $DEPLOY_OUTPUT.AI_FOUNDRY_RESOURCE_ID
+ "AI_FOUNDRY_RESOURCE_ID=$AI_FOUNDRY_RESOURCE_ID" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
+
+ $AI_SEARCH_SERVICE_NAME = $DEPLOY_OUTPUT.AI_SEARCH_SERVICE_NAME
+ "AI_SEARCH_SERVICE_NAME=$AI_SEARCH_SERVICE_NAME" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
+
+ $AZURE_COSMOSDB_ACCOUNT = $DEPLOY_OUTPUT.AZURE_COSMOSDB_ACCOUNT
+ "AZURE_COSMOSDB_ACCOUNT=$AZURE_COSMOSDB_ACCOUNT" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
+
+ $STORAGE_ACCOUNT_NAME = $DEPLOY_OUTPUT.STORAGE_ACCOUNT_NAME
+ "STORAGE_ACCOUNT_NAME=$STORAGE_ACCOUNT_NAME" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
+
+ $STORAGE_CONTAINER_NAME = $DEPLOY_OUTPUT.STORAGE_CONTAINER_NAME
+ "STORAGE_CONTAINER_NAME=$STORAGE_CONTAINER_NAME" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
+
+ $KEY_VAULT_NAME = $DEPLOY_OUTPUT.KEY_VAULT_NAME
+ "KEY_VAULT_NAME=$KEY_VAULT_NAME" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
+
+ $RESOURCE_GROUP_NAME = $DEPLOY_OUTPUT.RESOURCE_GROUP_NAME
+ "RESOURCE_GROUP_NAME=$RESOURCE_GROUP_NAME" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
+
+ $WEB_APP_URL = $DEPLOY_OUTPUT.WEB_APP_URL
+ "WEB_APPURL=$WEB_APP_URL" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
+ "WEB_APPURL=$WEB_APP_URL" | Out-File -FilePath $env:GITHUB_OUTPUT -Encoding utf8 -Append
+
+ - name: Run Post-Deployment Script
+ id: post_deploy
+ env:
+ AZURE_SUBSCRIPTION_ID: ${{ secrets.AZURE_SUBSCRIPTION_ID }}
+ shell: bash
+ run: |
+ set -e
+ az account set --subscription "${{ secrets.AZURE_SUBSCRIPTION_ID }}"
+
+ echo "Running post-deployment script..."
+
+ bash ./infra/scripts/process_sample_data.sh \
+ "${{ env.STORAGE_ACCOUNT_NAME }}" \
+ "${{ env.STORAGE_CONTAINER_NAME }}" \
+ "${{ env.KEY_VAULT_NAME }}" \
+ "${{ env.AZURE_COSMOSDB_ACCOUNT }}" \
+ "${{ env.RESOURCE_GROUP_NAME }}" \
+ "${{ env.AI_SEARCH_SERVICE_NAME }}" \
+ "${{ secrets.AZURE_CLIENT_ID }}" \
+ "${{ env.AI_FOUNDRY_RESOURCE_ID }}"
+
+ - name: Generate Deploy Job Summary
+ if: always()
+ shell: bash
+ env:
+ RESOURCE_GROUP_NAME: ${{ inputs.RESOURCE_GROUP_NAME }}
+ WAF_ENABLED: ${{ inputs.WAF_ENABLED }}
+ EXP: ${{ inputs.EXP }}
+ AZURE_LOCATION: ${{ inputs.AZURE_LOCATION }}
+ AZURE_ENV_OPENAI_LOCATION: ${{ inputs.AZURE_ENV_OPENAI_LOCATION }}
+ IMAGE_TAG: ${{ inputs.IMAGE_TAG }}
+ JOB_STATUS: ${{ job.status }}
+ WEB_APPURL: ${{ steps.get_output_windows.outputs.WEB_APPURL }}
+ run: |
+ echo "## 🚀 Deploy Job Summary (Windows)" >> $GITHUB_STEP_SUMMARY
+ echo "" >> $GITHUB_STEP_SUMMARY
+ echo "| Field | Value |" >> $GITHUB_STEP_SUMMARY
+ echo "|-------|--------|" >> $GITHUB_STEP_SUMMARY
+ if [[ "$JOB_STATUS" == "success" ]]; then
+ echo "| **Job Status** | ✅ Success |" >> $GITHUB_STEP_SUMMARY
+ else
+ echo "| **Job Status** | ❌ Failed |" >> $GITHUB_STEP_SUMMARY
+ fi
+ echo "| **Resource Group** | \`$RESOURCE_GROUP_NAME\` |" >> $GITHUB_STEP_SUMMARY
+
+ # Determine configuration type
+ if [[ "$WAF_ENABLED" == "true" && "$EXP" == "true" ]]; then
+ CONFIG_TYPE="WAF + EXP"
+ elif [[ "$WAF_ENABLED" == "true" && "$EXP" != "true" ]]; then
+ CONFIG_TYPE="WAF + Non-EXP"
+ elif [[ "$WAF_ENABLED" != "true" && "$EXP" == "true" ]]; then
+ CONFIG_TYPE="Non-WAF + EXP"
+ else
+ CONFIG_TYPE="Non-WAF + Non-EXP"
+ fi
+ echo "| **Configuration Type** | \`$CONFIG_TYPE\` |" >> $GITHUB_STEP_SUMMARY
+
+ echo "| **Azure Region (Infrastructure)** | \`$AZURE_LOCATION\` |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Azure OpenAI Region** | \`$AZURE_ENV_OPENAI_LOCATION\` |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Docker Image Tag** | \`$IMAGE_TAG\` |" >> $GITHUB_STEP_SUMMARY
+ echo "" >> $GITHUB_STEP_SUMMARY
+ if [[ "$JOB_STATUS" == "success" ]]; then
+ echo "### ✅ Deployment Details" >> $GITHUB_STEP_SUMMARY
+ echo "- **Web App URL**: [$WEB_APPURL]($WEB_APPURL)" >> $GITHUB_STEP_SUMMARY
+ echo "- Successfully deployed to Azure with all resources configured" >> $GITHUB_STEP_SUMMARY
+ echo "- Post-deployment scripts executed successfully" >> $GITHUB_STEP_SUMMARY
+ else
+ echo "### ❌ Deployment Failed" >> $GITHUB_STEP_SUMMARY
+ echo "- Deployment process encountered an error" >> $GITHUB_STEP_SUMMARY
+ echo "- Check the deploy job for detailed error information" >> $GITHUB_STEP_SUMMARY
+ fi
+
+ - name: Logout from Azure
+ if: always()
+ shell: bash
+ run: |
+ az logout || true
+ echo "Logged out from Azure."
diff --git a/archive-doc-gen/.github/workflows/job-deploy.yml b/archive-doc-gen/.github/workflows/job-deploy.yml
new file mode 100644
index 000000000..a54023768
--- /dev/null
+++ b/archive-doc-gen/.github/workflows/job-deploy.yml
@@ -0,0 +1,554 @@
+name: Deploy Job
+
+on:
+ workflow_call:
+ inputs:
+ trigger_type:
+ description: 'Trigger type (workflow_dispatch, pull_request, schedule)'
+ required: true
+ type: string
+ runner_os:
+ description: 'Runner OS (ubuntu-latest or windows-latest)'
+ required: true
+ type: string
+ azure_location:
+ description: 'Azure Location For Deployment'
+ required: false
+ default: 'australiaeast'
+ type: string
+ resource_group_name:
+ description: 'Resource Group Name (Optional)'
+ required: false
+ default: ''
+ type: string
+ waf_enabled:
+ description: 'Enable WAF'
+ required: false
+ default: false
+ type: boolean
+ EXP:
+ description: 'Enable EXP'
+ required: false
+ default: false
+ type: boolean
+ build_docker_image:
+ description: 'Build And Push Docker Image (Optional)'
+ required: false
+ default: false
+ type: boolean
+ cleanup_resources:
+ description: 'Cleanup Deployed Resources'
+ required: false
+ default: false
+ type: boolean
+ run_e2e_tests:
+ description: 'Run End-to-End Tests'
+ required: false
+ default: 'GoldenPath-Testing'
+ type: string
+ existing_webapp_url:
+ description: 'Existing Container WebApp URL (Skips Deployment)'
+ required: false
+ default: ''
+ type: string
+ AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID:
+ description: 'Log Analytics Workspace ID (Optional)'
+ required: false
+ default: ''
+ type: string
+ AZURE_EXISTING_AI_PROJECT_RESOURCE_ID:
+ description: 'AI Project Resource ID (Optional)'
+ required: false
+ default: ''
+ type: string
+ docker_image_tag:
+ description: 'Docker Image Tag from build job'
+ required: false
+ default: ''
+ type: string
+ outputs:
+ RESOURCE_GROUP_NAME:
+ description: "Resource Group Name"
+ value: ${{ jobs.azure-setup.outputs.RESOURCE_GROUP_NAME }}
+ WEB_APPURL:
+ description: "Container Web App URL"
+ value: ${{ jobs.deploy-linux.outputs.WEB_APPURL || jobs.deploy-windows.outputs.WEB_APPURL }}
+ ENV_NAME:
+ description: "Environment Name"
+ value: ${{ jobs.azure-setup.outputs.ENV_NAME }}
+ AZURE_LOCATION:
+ description: "Azure Location"
+ value: ${{ jobs.azure-setup.outputs.AZURE_LOCATION }}
+ AZURE_ENV_OPENAI_LOCATION:
+ description: "Azure OpenAI Location"
+ value: ${{ jobs.azure-setup.outputs.AZURE_ENV_OPENAI_LOCATION }}
+ IMAGE_TAG:
+ description: "Docker Image Tag Used"
+ value: ${{ jobs.azure-setup.outputs.IMAGE_TAG }}
+ QUOTA_FAILED:
+ description: "Quota Check Failed Flag"
+ value: ${{ jobs.azure-setup.outputs.QUOTA_FAILED || 'false' }}
+
+env:
+ GPT_MIN_CAPACITY: 150
+ TEXT_EMBEDDING_MIN_CAPACITY: 80
+ BRANCH_NAME: ${{ github.event.workflow_run.head_branch || github.head_ref || github.ref_name }}
+ WAF_ENABLED: ${{ inputs.trigger_type == 'workflow_dispatch' && (inputs.waf_enabled || false) || false }}
+ EXP: ${{ inputs.trigger_type == 'workflow_dispatch' && (inputs.EXP || false) || false }}
+ CLEANUP_RESOURCES: ${{ inputs.trigger_type != 'workflow_dispatch' || inputs.cleanup_resources }}
+ RUN_E2E_TESTS: ${{ inputs.trigger_type == 'workflow_dispatch' && (inputs.run_e2e_tests || 'GoldenPath-Testing') || 'GoldenPath-Testing' }}
+ BUILD_DOCKER_IMAGE: ${{ inputs.trigger_type == 'workflow_dispatch' && (inputs.build_docker_image || false) || false }}
+permissions:
+ contents: read
+ actions: read
+
+jobs:
+ azure-setup:
+ name: Azure Setup
+ if: inputs.trigger_type != 'workflow_dispatch' || inputs.existing_webapp_url == '' || inputs.existing_webapp_url == null
+ runs-on: ubuntu-latest
+ outputs:
+ RESOURCE_GROUP_NAME: ${{ steps.check_create_rg.outputs.RESOURCE_GROUP_NAME }}
+ ENV_NAME: ${{ steps.generate_env_name.outputs.ENV_NAME }}
+ AZURE_LOCATION: ${{ steps.set_region.outputs.AZURE_LOCATION }}
+ AZURE_ENV_OPENAI_LOCATION: ${{ steps.set_region.outputs.AZURE_ENV_OPENAI_LOCATION }}
+ IMAGE_TAG: ${{ steps.determine_image_tag.outputs.IMAGE_TAG }}
+ QUOTA_FAILED: ${{ steps.quota_failure_output.outputs.QUOTA_FAILED }}
+ EXP_ENABLED: ${{ steps.configure_exp.outputs.EXP_ENABLED }}
+
+ steps:
+ - name: Validate Workflow Input Parameters
+ shell: bash
+ env:
+ INPUT_TRIGGER_TYPE: ${{ inputs.trigger_type }}
+ INPUT_RUNNER_OS: ${{ inputs.runner_os }}
+ INPUT_BUILD_DOCKER_IMAGE: ${{ inputs.build_docker_image }}
+ INPUT_AZURE_LOCATION: ${{ inputs.azure_location }}
+ INPUT_RESOURCE_GROUP_NAME: ${{ inputs.resource_group_name }}
+ INPUT_WAF_ENABLED: ${{ inputs.waf_enabled }}
+ INPUT_EXP: ${{ inputs.EXP }}
+ INPUT_CLEANUP_RESOURCES: ${{ inputs.cleanup_resources }}
+ INPUT_RUN_E2E_TESTS: ${{ inputs.run_e2e_tests }}
+ INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID: ${{ inputs.AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID }}
+ INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID: ${{ inputs.AZURE_EXISTING_AI_PROJECT_RESOURCE_ID }}
+ INPUT_EXISTING_WEBAPP_URL: ${{ inputs.existing_webapp_url }}
+ INPUT_DOCKER_IMAGE_TAG: ${{ inputs.docker_image_tag }}
+ run: |
+ echo "🔍 Validating workflow input parameters..."
+ VALIDATION_FAILED=false
+
+ # Validate trigger_type (required - alphanumeric with underscores)
+ if [[ -z "$INPUT_TRIGGER_TYPE" ]]; then
+ echo "❌ ERROR: trigger_type is required but was not provided"
+ VALIDATION_FAILED=true
+ elif [[ ! "$INPUT_TRIGGER_TYPE" =~ ^[a-zA-Z0-9_]+$ ]]; then
+ echo "❌ ERROR: trigger_type '$INPUT_TRIGGER_TYPE' is invalid. Must contain only alphanumeric characters and underscores"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ trigger_type: '$INPUT_TRIGGER_TYPE' is valid"
+ fi
+
+ # Validate runner_os (required - must be specific values)
+ ALLOWED_RUNNER_OS=("ubuntu-latest" "windows-latest")
+ if [[ -z "$INPUT_RUNNER_OS" ]]; then
+ echo "❌ ERROR: runner_os is required but was not provided"
+ VALIDATION_FAILED=true
+ elif [[ ! " ${ALLOWED_RUNNER_OS[@]} " =~ " ${INPUT_RUNNER_OS} " ]]; then
+ echo "❌ ERROR: runner_os '$INPUT_RUNNER_OS' is invalid. Allowed values: ${ALLOWED_RUNNER_OS[*]}"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ runner_os: '$INPUT_RUNNER_OS' is valid"
+ fi
+
+ # Validate build_docker_image (boolean)
+ if [[ "$INPUT_BUILD_DOCKER_IMAGE" != "true" && "$INPUT_BUILD_DOCKER_IMAGE" != "false" ]]; then
+ echo "❌ ERROR: build_docker_image must be 'true' or 'false', got: '$INPUT_BUILD_DOCKER_IMAGE'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ build_docker_image: '$INPUT_BUILD_DOCKER_IMAGE' is valid"
+ fi
+
+ # Validate azure_location (Azure region format)
+ if [[ -n "$INPUT_AZURE_LOCATION" ]]; then
+ if [[ ! "$INPUT_AZURE_LOCATION" =~ ^[a-z0-9]+$ ]]; then
+ echo "❌ ERROR: azure_location '$INPUT_AZURE_LOCATION' is invalid. Must contain only lowercase letters and numbers (e.g., 'australiaeast', 'westus2')"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ azure_location: '$INPUT_AZURE_LOCATION' is valid"
+ fi
+ fi
+
+ # Validate resource_group_name (Azure resource group naming convention)
+ if [[ -n "$INPUT_RESOURCE_GROUP_NAME" ]]; then
+ if [[ ! "$INPUT_RESOURCE_GROUP_NAME" =~ ^[a-zA-Z0-9._\(\)-]+$ ]] || [[ "$INPUT_RESOURCE_GROUP_NAME" =~ \.$ ]]; then
+ echo "❌ ERROR: resource_group_name '$INPUT_RESOURCE_GROUP_NAME' is invalid. Must contain only alphanumerics, periods, underscores, hyphens, and parentheses. Cannot end with period."
+ VALIDATION_FAILED=true
+ elif [[ ${#INPUT_RESOURCE_GROUP_NAME} -gt 90 ]]; then
+ echo "❌ ERROR: resource_group_name '$INPUT_RESOURCE_GROUP_NAME' exceeds 90 characters"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ resource_group_name: '$INPUT_RESOURCE_GROUP_NAME' is valid"
+ fi
+ fi
+
+ # Validate waf_enabled (boolean)
+ if [[ "$INPUT_WAF_ENABLED" != "true" && "$INPUT_WAF_ENABLED" != "false" ]]; then
+ echo "❌ ERROR: waf_enabled must be 'true' or 'false', got: '$INPUT_WAF_ENABLED'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ waf_enabled: '$INPUT_WAF_ENABLED' is valid"
+ fi
+
+ # Validate EXP (boolean)
+ if [[ "$INPUT_EXP" != "true" && "$INPUT_EXP" != "false" ]]; then
+ echo "❌ ERROR: EXP must be 'true' or 'false', got: '$INPUT_EXP'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ EXP: '$INPUT_EXP' is valid"
+ fi
+
+ # Validate cleanup_resources (boolean)
+ if [[ "$INPUT_CLEANUP_RESOURCES" != "true" && "$INPUT_CLEANUP_RESOURCES" != "false" ]]; then
+ echo "❌ ERROR: cleanup_resources must be 'true' or 'false', got: '$INPUT_CLEANUP_RESOURCES'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ cleanup_resources: '$INPUT_CLEANUP_RESOURCES' is valid"
+ fi
+
+ # Validate run_e2e_tests (specific allowed values)
+ if [[ -n "$INPUT_RUN_E2E_TESTS" ]]; then
+ ALLOWED_VALUES=("None" "GoldenPath-Testing" "Smoke-Testing")
+ if [[ ! " ${ALLOWED_VALUES[@]} " =~ " ${INPUT_RUN_E2E_TESTS} " ]]; then
+ echo "❌ ERROR: run_e2e_tests '$INPUT_RUN_E2E_TESTS' is invalid. Allowed values: ${ALLOWED_VALUES[*]}"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ run_e2e_tests: '$INPUT_RUN_E2E_TESTS' is valid"
+ fi
+ fi
+
+ # Validate AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID (Azure Resource ID format)
+ if [[ -n "$INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID" ]]; then
+ if [[ ! "$INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID" =~ ^/subscriptions/[a-fA-F0-9-]+/[Rr]esource[Gg]roups/[^/]+/providers/[Mm]icrosoft\.[Oo]perational[Ii]nsights/[Ww]orkspaces/[^/]+$ ]]; then
+ echo "❌ ERROR: AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID is invalid. Must be a valid Azure Resource ID format:"
+ echo " /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}"
+ echo " Got: '$INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID: Valid Resource ID format"
+ fi
+ fi
+
+ # Validate AZURE_EXISTING_AI_PROJECT_RESOURCE_ID (Azure Resource ID format)
+ if [[ -n "$INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID" ]]; then
+ if [[ ! "$INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID" =~ ^/subscriptions/[a-fA-F0-9-]+/[Rr]esource[Gg]roups/[^/]+/providers/([Mm]icrosoft\.[Mm]achine[Ll]earning[Ss]ervices/([Ww]orkspaces|[Pp]rojects)/[^/]+|[Mm]icrosoft\.[Cc]ognitive[Ss]ervices/[Aa]ccounts/[^/]+/[Pp]rojects/[^/]+)$ ]]; then
+ echo "❌ ERROR: AZURE_EXISTING_AI_PROJECT_RESOURCE_ID is invalid. Must be a valid Azure Resource ID format:"
+ echo " /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}"
+ echo " Got: '$INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ AZURE_EXISTING_AI_PROJECT_RESOURCE_ID: Valid Resource ID format"
+ fi
+ fi
+
+ # Validate existing_webapp_url (must start with https)
+ if [[ -n "$INPUT_EXISTING_WEBAPP_URL" ]]; then
+ if [[ ! "$INPUT_EXISTING_WEBAPP_URL" =~ ^https:// ]]; then
+ echo "❌ ERROR: existing_webapp_url must start with 'https://', got: '$INPUT_EXISTING_WEBAPP_URL'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ existing_webapp_url: '$INPUT_EXISTING_WEBAPP_URL' is valid"
+ fi
+ fi
+
+ # Validate docker_image_tag (Docker tag pattern)
+ if [[ -n "$INPUT_DOCKER_IMAGE_TAG" ]]; then
+ # Docker tags: lowercase and uppercase letters, digits, underscores, periods, and hyphens
+ # Cannot start with period or hyphen, max 128 characters
+ if [[ ! "$INPUT_DOCKER_IMAGE_TAG" =~ ^[a-zA-Z0-9_][a-zA-Z0-9._-]{0,127}$ ]]; then
+ echo "❌ ERROR: docker_image_tag '$INPUT_DOCKER_IMAGE_TAG' is invalid. Must:"
+ echo " - Start with alphanumeric or underscore"
+ echo " - Contain only alphanumerics, underscores, periods, hyphens"
+ echo " - Be max 128 characters"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ docker_image_tag: '$INPUT_DOCKER_IMAGE_TAG' is valid"
+ fi
+ fi
+
+ # Fail workflow if any validation failed
+ if [[ "$VALIDATION_FAILED" == "true" ]]; then
+ echo ""
+ echo "❌ Parameter validation failed. Please correct the errors above and try again."
+ exit 1
+ fi
+
+ echo ""
+ echo "✅ All input parameters validated successfully!"
+
+ - name: Validate and Auto-Configure EXP
+ id: configure_exp
+ shell: bash
+ env:
+ INPUT_EXP: ${{ inputs.EXP }}
+ INPUT_LOG_ANALYTICS_WORKSPACE_ID: ${{ inputs.AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID }}
+ INPUT_AI_PROJECT_RESOURCE_ID: ${{ inputs.AZURE_EXISTING_AI_PROJECT_RESOURCE_ID }}
+ run: |
+ echo "🔍 Validating EXP configuration..."
+
+ EXP_ENABLED="false"
+
+ if [[ "$INPUT_EXP" == "true" ]]; then
+ EXP_ENABLED="true"
+ echo "✅ EXP explicitly enabled by user input"
+ elif [[ -n "$INPUT_LOG_ANALYTICS_WORKSPACE_ID" ]] || [[ -n "$INPUT_AI_PROJECT_RESOURCE_ID" ]]; then
+ echo "🔧 AUTO-ENABLING EXP: EXP parameter values were provided but EXP was not explicitly enabled."
+ echo ""
+ echo "You provided values for:"
+ [[ -n "$INPUT_LOG_ANALYTICS_WORKSPACE_ID" ]] && echo " - Azure Log Analytics Workspace ID: '$INPUT_LOG_ANALYTICS_WORKSPACE_ID'"
+ [[ -n "$INPUT_AI_PROJECT_RESOURCE_ID" ]] && echo " - Azure AI Project Resource ID: '$INPUT_AI_PROJECT_RESOURCE_ID'"
+ echo ""
+ echo "✅ Automatically enabling EXP to use these values."
+ EXP_ENABLED="true"
+ fi
+
+ echo "EXP_ENABLED=$EXP_ENABLED" >> $GITHUB_ENV
+ echo "EXP_ENABLED=$EXP_ENABLED" >> $GITHUB_OUTPUT
+ echo "Final EXP status: $EXP_ENABLED"
+
+
+ - name: Checkout Code
+ uses: actions/checkout@v4
+
+ - name: Login to Azure
+ shell: bash
+ run: |
+ az login --service-principal -u ${{ secrets.AZURE_CLIENT_ID }} -p ${{ secrets.AZURE_CLIENT_SECRET }} --tenant ${{ secrets.AZURE_TENANT_ID }}
+ az account set --subscription ${{ secrets.AZURE_SUBSCRIPTION_ID }}
+
+ - name: Run Quota Check
+ id: quota-check
+ env:
+ AZURE_CLIENT_ID: ${{ secrets.AZURE_CLIENT_ID }}
+ AZURE_TENANT_ID: ${{ secrets.AZURE_TENANT_ID }}
+ AZURE_CLIENT_SECRET: ${{ secrets.AZURE_CLIENT_SECRET }}
+ AZURE_SUBSCRIPTION_ID: ${{ secrets.AZURE_SUBSCRIPTION_ID }}
+ GPT_MIN_CAPACITY: ${{ env.GPT_MIN_CAPACITY }}
+ TEXT_EMBEDDING_MIN_CAPACITY: ${{ env.TEXT_EMBEDDING_MIN_CAPACITY }}
+ AZURE_REGIONS: ${{ vars.AZURE_REGIONS }}
+ run: |
+ chmod +x scripts/checkquota.sh
+ if ! scripts/checkquota.sh; then
+ # If quota check fails due to insufficient quota, set the flag
+ if grep -q "No region with sufficient quota found" scripts/checkquota.sh; then
+ echo "QUOTA_FAILED=true" >> $GITHUB_ENV
+ fi
+ exit 1 # Fail the pipeline if any other failure occurs
+ fi
+
+ - name: Set Quota Failure Output
+ id: quota_failure_output
+ if: env.QUOTA_FAILED == 'true'
+ shell: bash
+ run: |
+ echo "QUOTA_FAILED=true" >> $GITHUB_OUTPUT
+ echo "Quota check failed - will notify via separate notification job"
+
+ - name: Fail Pipeline if Quota Check Fails
+ if: env.QUOTA_FAILED == 'true'
+ shell: bash
+ run: exit 1
+
+ - name: Set Deployment Region
+ id: set_region
+ shell: bash
+ env:
+ INPUT_AZURE_LOCATION: ${{ inputs.azure_location }}
+ run: |
+ echo "Selected Region from Quota Check: $VALID_REGION"
+ echo "AZURE_ENV_OPENAI_LOCATION=$VALID_REGION" >> $GITHUB_ENV
+ echo "AZURE_ENV_OPENAI_LOCATION=$VALID_REGION" >> $GITHUB_OUTPUT
+
+ if [[ "${{ inputs.trigger_type }}" == "workflow_dispatch" && -n "$INPUT_AZURE_LOCATION" ]]; then
+ USER_SELECTED_LOCATION="$INPUT_AZURE_LOCATION"
+ echo "Using user-selected Azure location: $USER_SELECTED_LOCATION"
+ echo "AZURE_LOCATION=$USER_SELECTED_LOCATION" >> $GITHUB_ENV
+ echo "AZURE_LOCATION=$USER_SELECTED_LOCATION" >> $GITHUB_OUTPUT
+ else
+ echo "Using location from quota check for automatic triggers: $VALID_REGION"
+ echo "AZURE_LOCATION=$VALID_REGION" >> $GITHUB_ENV
+ echo "AZURE_LOCATION=$VALID_REGION" >> $GITHUB_OUTPUT
+ fi
+
+ - name: Generate Resource Group Name
+ id: generate_rg_name
+ shell: bash
+ env:
+ INPUT_RESOURCE_GROUP_NAME: ${{ inputs.resource_group_name }}
+ run: |
+ # Check if a resource group name was provided as input
+ if [[ -n "$INPUT_RESOURCE_GROUP_NAME" ]]; then
+ echo "Using provided Resource Group name: $INPUT_RESOURCE_GROUP_NAME"
+ echo "RESOURCE_GROUP_NAME=$INPUT_RESOURCE_GROUP_NAME" >> $GITHUB_ENV
+ else
+ echo "Generating a unique resource group name..."
+ ACCL_NAME="docgen" # Account name as specified
+ SHORT_UUID=$(uuidgen | cut -d'-' -f1)
+ UNIQUE_RG_NAME="arg-${ACCL_NAME}-${SHORT_UUID}"
+ echo "RESOURCE_GROUP_NAME=${UNIQUE_RG_NAME}" >> $GITHUB_ENV
+ echo "Generated RESOURCE_GROUP_NAME: ${UNIQUE_RG_NAME}"
+ fi
+
+ - name: Install Bicep CLI
+ shell: bash
+ run: az bicep install
+
+ - name: Check and Create Resource Group
+ id: check_create_rg
+ shell: bash
+ run: |
+ set -e
+ echo "🔍 Checking if resource group '$RESOURCE_GROUP_NAME' exists..."
+ rg_exists=$(az group exists --name $RESOURCE_GROUP_NAME)
+ if [ "$rg_exists" = "false" ]; then
+ echo "📦 Resource group does not exist. Creating new resource group '$RESOURCE_GROUP_NAME' in location '$AZURE_LOCATION'..."
+ az group create --name $RESOURCE_GROUP_NAME --location $AZURE_LOCATION || { echo "❌ Error creating resource group"; exit 1; }
+ echo "✅ Resource group '$RESOURCE_GROUP_NAME' created successfully."
+ else
+ echo "✅ Resource group '$RESOURCE_GROUP_NAME' already exists. Deploying to existing resource group."
+ fi
+ echo "RESOURCE_GROUP_NAME=$RESOURCE_GROUP_NAME" >> $GITHUB_OUTPUT
+ echo "RESOURCE_GROUP_NAME=$RESOURCE_GROUP_NAME" >> $GITHUB_ENV
+
+ - name: Generate Unique Solution Prefix
+ id: generate_solution_prefix
+ shell: bash
+ run: |
+ set -e
+ COMMON_PART="psldg"
+ TIMESTAMP=$(date +%s)
+ UPDATED_TIMESTAMP=$(echo $TIMESTAMP | tail -c 6)
+ UNIQUE_SOLUTION_PREFIX="${COMMON_PART}${UPDATED_TIMESTAMP}"
+ echo "SOLUTION_PREFIX=${UNIQUE_SOLUTION_PREFIX}" >> $GITHUB_ENV
+ echo "Generated SOLUTION_PREFIX: ${UNIQUE_SOLUTION_PREFIX}"
+
+ - name: Determine Docker Image Tag
+ id: determine_image_tag
+ env:
+ INPUT_DOCKER_IMAGE_TAG: ${{ inputs.docker_image_tag }}
+ run: |
+ if [[ "${{ env.BUILD_DOCKER_IMAGE }}" == "true" ]]; then
+ if [[ -n "$INPUT_DOCKER_IMAGE_TAG" ]]; then
+ IMAGE_TAG="$INPUT_DOCKER_IMAGE_TAG"
+ echo "🔗 Using Docker image tag from build job: $IMAGE_TAG"
+ else
+ echo "❌ Docker build job failed or was skipped, but BUILD_DOCKER_IMAGE is true"
+ exit 1
+ fi
+ else
+ echo "🏷️ Using existing Docker image based on branch..."
+ BRANCH_NAME="${{ env.BRANCH_NAME }}"
+ echo "Current branch: $BRANCH_NAME"
+
+ # Determine image tag based on branch
+ if [[ "$BRANCH_NAME" == "main" ]]; then
+ IMAGE_TAG="latest_waf"
+ echo "Using main branch - image tag: latest_waf"
+ elif [[ "$BRANCH_NAME" == "dev" ]]; then
+ IMAGE_TAG="dev"
+ echo "Using dev branch - image tag: dev"
+ elif [[ "$BRANCH_NAME" == "demo" ]]; then
+ IMAGE_TAG="demo"
+ echo "Using demo branch - image tag: demo"
+ else
+ IMAGE_TAG="latest_waf"
+ echo "Using default for branch '$BRANCH_NAME' - image tag: latest_waf"
+ fi
+
+ echo "Using existing Docker image tag: $IMAGE_TAG"
+ fi
+
+ echo "IMAGE_TAG=$IMAGE_TAG" >> $GITHUB_ENV
+ echo "IMAGE_TAG=$IMAGE_TAG" >> $GITHUB_OUTPUT
+
+ - name: Generate Unique Environment Name
+ id: generate_env_name
+ shell: bash
+ run: |
+ COMMON_PART="pslc"
+ TIMESTAMP=$(date +%s)
+ UPDATED_TIMESTAMP=$(echo $TIMESTAMP | tail -c 6)
+ UNIQUE_ENV_NAME="${COMMON_PART}${UPDATED_TIMESTAMP}"
+ echo "ENV_NAME=${UNIQUE_ENV_NAME}" >> $GITHUB_ENV
+ echo "Generated Environment Name: ${UNIQUE_ENV_NAME}"
+ echo "ENV_NAME=${UNIQUE_ENV_NAME}" >> $GITHUB_OUTPUT
+
+ - name: Display Workflow Configuration to GitHub Summary
+ shell: bash
+ env:
+ INPUT_AZURE_LOCATION: ${{ inputs.azure_location }}
+ INPUT_RESOURCE_GROUP_NAME: ${{ inputs.resource_group_name }}
+ run: |
+ echo "## 📋 Workflow Configuration Summary" >> $GITHUB_STEP_SUMMARY
+ echo "" >> $GITHUB_STEP_SUMMARY
+ echo "| Configuration | Value |" >> $GITHUB_STEP_SUMMARY
+ echo "|---------------|-------|" >> $GITHUB_STEP_SUMMARY
+ echo "| **Branch** | \`${{ env.BRANCH_NAME }}\` |" >> $GITHUB_STEP_SUMMARY
+ echo "| **WAF Enabled** | ${{ env.WAF_ENABLED == 'true' && '✅ Yes' || '❌ No' }} |" >> $GITHUB_STEP_SUMMARY
+ echo "| **EXP Enabled** | ${{ steps.configure_exp.outputs.EXP_ENABLED == 'true' && '✅ Yes' || '❌ No' }} |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Run E2E Tests** | \`${{ env.RUN_E2E_TESTS }}\` |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Cleanup Resources** | ${{ env.CLEANUP_RESOURCES == 'true' && '✅ Yes' || '❌ No' }} |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Build Docker Image** | ${{ env.BUILD_DOCKER_IMAGE == 'true' && '✅ Yes' || '❌ No' }} |" >> $GITHUB_STEP_SUMMARY
+
+ if [[ "${{ inputs.trigger_type }}" == "workflow_dispatch" && -n "$INPUT_AZURE_LOCATION" ]]; then
+ echo "| **Azure Location** | \`$INPUT_AZURE_LOCATION\` (User Selected) |" >> $GITHUB_STEP_SUMMARY
+ fi
+
+ if [[ -n "$INPUT_RESOURCE_GROUP_NAME" ]]; then
+ echo "| **Resource Group** | \`$INPUT_RESOURCE_GROUP_NAME\` (Pre-specified) |" >> $GITHUB_STEP_SUMMARY
+ else
+ echo "| **Resource Group** | \`${{ env.RESOURCE_GROUP_NAME }}\` (Auto-generated) |" >> $GITHUB_STEP_SUMMARY
+ fi
+
+ echo "" >> $GITHUB_STEP_SUMMARY
+
+ if [[ "${{ inputs.trigger_type }}" != "workflow_dispatch" ]]; then
+ echo "ℹ️ **Note:** Automatic Trigger - Using Non-WAF + Non-EXP configuration" >> $GITHUB_STEP_SUMMARY
+ else
+ echo "ℹ️ **Note:** Manual Trigger - Using user-specified configuration" >> $GITHUB_STEP_SUMMARY
+ fi
+
+ deploy-linux:
+ name: Deploy on Linux
+ needs: azure-setup
+ if: inputs.runner_os == 'ubuntu-latest' && !cancelled() && needs.azure-setup.result == 'success'
+ uses: ./.github/workflows/job-deploy-linux.yml
+ with:
+ ENV_NAME: ${{ needs.azure-setup.outputs.ENV_NAME }}
+ AZURE_ENV_OPENAI_LOCATION: ${{ needs.azure-setup.outputs.AZURE_ENV_OPENAI_LOCATION }}
+ AZURE_LOCATION: ${{ needs.azure-setup.outputs.AZURE_LOCATION }}
+ RESOURCE_GROUP_NAME: ${{ needs.azure-setup.outputs.RESOURCE_GROUP_NAME }}
+ IMAGE_TAG: ${{ needs.azure-setup.outputs.IMAGE_TAG }}
+ BUILD_DOCKER_IMAGE: ${{ inputs.build_docker_image || 'false' }}
+ EXP: ${{ needs.azure-setup.outputs.EXP_ENABLED }}
+ WAF_ENABLED: ${{ inputs.waf_enabled == true && 'true' || 'false' }}
+ AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID: ${{ inputs.AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID }}
+ AZURE_EXISTING_AI_PROJECT_RESOURCE_ID: ${{ inputs.AZURE_EXISTING_AI_PROJECT_RESOURCE_ID }}
+ secrets: inherit
+
+ deploy-windows:
+ name: Deploy on Windows
+ needs: azure-setup
+ if: inputs.runner_os == 'windows-latest' && !cancelled() && needs.azure-setup.result == 'success'
+ uses: ./.github/workflows/job-deploy-windows.yml
+ with:
+ ENV_NAME: ${{ needs.azure-setup.outputs.ENV_NAME }}
+ AZURE_ENV_OPENAI_LOCATION: ${{ needs.azure-setup.outputs.AZURE_ENV_OPENAI_LOCATION }}
+ AZURE_LOCATION: ${{ needs.azure-setup.outputs.AZURE_LOCATION }}
+ RESOURCE_GROUP_NAME: ${{ needs.azure-setup.outputs.RESOURCE_GROUP_NAME }}
+ IMAGE_TAG: ${{ needs.azure-setup.outputs.IMAGE_TAG }}
+ BUILD_DOCKER_IMAGE: ${{ inputs.build_docker_image || 'false' }}
+ EXP: ${{ needs.azure-setup.outputs.EXP_ENABLED }}
+ WAF_ENABLED: ${{ inputs.waf_enabled == true && 'true' || 'false' }}
+ AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID: ${{ inputs.AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID }}
+ AZURE_EXISTING_AI_PROJECT_RESOURCE_ID: ${{ inputs.AZURE_EXISTING_AI_PROJECT_RESOURCE_ID }}
+ secrets: inherit
diff --git a/archive-doc-gen/.github/workflows/job-docker-build.yml b/archive-doc-gen/.github/workflows/job-docker-build.yml
new file mode 100644
index 000000000..fc564ea3f
--- /dev/null
+++ b/archive-doc-gen/.github/workflows/job-docker-build.yml
@@ -0,0 +1,102 @@
+name: Docker Build Job
+
+on:
+ workflow_call:
+ inputs:
+ trigger_type:
+ description: 'Trigger type (workflow_dispatch, pull_request, schedule)'
+ required: true
+ type: string
+ build_docker_image:
+ description: 'Build And Push Docker Image (Optional)'
+ required: false
+ default: false
+ type: boolean
+ outputs:
+ IMAGE_TAG:
+ description: "Generated Docker Image Tag"
+ value: ${{ jobs.docker-build.outputs.IMAGE_TAG }}
+
+env:
+ BRANCH_NAME: ${{ github.event.workflow_run.head_branch || github.head_ref || github.ref_name }}
+permissions:
+ contents: read
+ actions: read
+
+jobs:
+ docker-build:
+ if: inputs.trigger_type == 'workflow_dispatch' && inputs.build_docker_image == true
+ runs-on: ubuntu-latest
+ outputs:
+ IMAGE_TAG: ${{ steps.generate_docker_tag.outputs.IMAGE_TAG }}
+ steps:
+ - name: Checkout Code
+ uses: actions/checkout@v4
+
+ - name: Generate Unique Docker Image Tag
+ id: generate_docker_tag
+ shell: bash
+ run: |
+ echo "🔨 Building new Docker image - generating unique tag..."
+ TIMESTAMP=$(date +%Y%m%d-%H%M%S)
+ RUN_ID="${{ github.run_id }}"
+ BRANCH_NAME="${{ github.head_ref || github.ref_name }}"
+ CLEAN_BRANCH_NAME=$(echo "$BRANCH_NAME" | sed 's/[^a-zA-Z0-9._-]/-/g' | sed 's/--*/-/g' | sed 's/^-\|-$//g')
+ UNIQUE_TAG="${CLEAN_BRANCH_NAME}-${TIMESTAMP}-${RUN_ID}"
+ echo "IMAGE_TAG=$UNIQUE_TAG" >> $GITHUB_ENV
+ echo "IMAGE_TAG=$UNIQUE_TAG" >> $GITHUB_OUTPUT
+ echo "Generated unique Docker tag: $UNIQUE_TAG"
+
+ - name: Set up Docker Buildx
+ uses: docker/setup-buildx-action@v3
+
+ - name: Log in to Azure Container Registry
+ uses: azure/docker-login@v2
+ with:
+ login-server: ${{ secrets.ACR_TEST_LOGIN_SERVER }}
+ username: ${{ secrets.ACR_TEST_USERNAME }}
+ password: ${{ secrets.ACR_TEST_PASSWORD }}
+
+ - name: Build and Push Docker Image
+ id: build_push_image
+ uses: docker/build-push-action@v6
+ env:
+ DOCKER_BUILD_SUMMARY: false
+ with:
+ context: ./src
+ file: ./src/WebApp.Dockerfile
+ push: true
+ tags: |
+ ${{ secrets.ACR_TEST_LOGIN_SERVER }}/webapp:${{ steps.generate_docker_tag.outputs.IMAGE_TAG }}
+ ${{ secrets.ACR_TEST_LOGIN_SERVER }}/webapp:${{ steps.generate_docker_tag.outputs.IMAGE_TAG }}_${{ github.run_number }}
+
+ - name: Verify Docker Image Build
+ shell: bash
+ run: |
+ echo "✅ Docker image successfully built and pushed"
+ echo "Image tag: ${{ steps.generate_docker_tag.outputs.IMAGE_TAG }}"
+
+ - name: Generate Docker Build Summary
+ if: always()
+ shell: bash
+ run: |
+ ACR_NAME=$(echo "${{ secrets.ACR_TEST_LOGIN_SERVER }}")
+ echo "## 🐳 Docker Build Job Summary" >> $GITHUB_STEP_SUMMARY
+ echo "" >> $GITHUB_STEP_SUMMARY
+ echo "| Field | Value |" >> $GITHUB_STEP_SUMMARY
+ echo "|-------|--------|" >> $GITHUB_STEP_SUMMARY
+ echo "| **Job Status** | ${{ job.status == 'success' && '✅ Success' || '❌ Failed' }} |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Image Tag** | \`${{ steps.generate_docker_tag.outputs.IMAGE_TAG }}\` |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Branch** | ${{ env.BRANCH_NAME }} |" >> $GITHUB_STEP_SUMMARY
+ echo "" >> $GITHUB_STEP_SUMMARY
+ if [[ "${{ job.status }}" == "success" ]]; then
+ echo "### ✅ Build Details" >> $GITHUB_STEP_SUMMARY
+ echo "Successfully built and pushed one Docker image to ACR:" >> $GITHUB_STEP_SUMMARY
+ echo "" >> $GITHUB_STEP_SUMMARY
+ echo "**Built Images:**" >> $GITHUB_STEP_SUMMARY
+ echo "- \`${ACR_NAME}.azurecr.io/webapp:${{ steps.generate_docker_tag.outputs.IMAGE_TAG }}\`" >> $GITHUB_STEP_SUMMARY
+ else
+ echo "### ❌ Build Failed" >> $GITHUB_STEP_SUMMARY
+ echo "- Docker build process encountered an error" >> $GITHUB_STEP_SUMMARY
+ echo "- Check the docker-build job for detailed error information" >> $GITHUB_STEP_SUMMARY
+ fi
diff --git a/archive-doc-gen/.github/workflows/job-send-notification.yml b/archive-doc-gen/.github/workflows/job-send-notification.yml
new file mode 100644
index 000000000..e5c833a33
--- /dev/null
+++ b/archive-doc-gen/.github/workflows/job-send-notification.yml
@@ -0,0 +1,419 @@
+name: Send Notification Job
+
+on:
+ workflow_call:
+ inputs:
+ trigger_type:
+ description: 'Trigger type (workflow_dispatch, pull_request, schedule)'
+ required: true
+ type: string
+ waf_enabled:
+ description: 'Enable WAF'
+ required: false
+ default: false
+ type: boolean
+ EXP:
+ description: 'Enable EXP'
+ required: false
+ default: false
+ type: boolean
+ run_e2e_tests:
+ description: 'Run End-to-End Tests'
+ required: false
+ default: 'GoldenPath-Testing'
+ type: string
+ existing_webapp_url:
+ description: 'Existing Container WebApp URL (Skips Deployment)'
+ required: false
+ default: ''
+ type: string
+ deploy_result:
+ description: 'Deploy job result (success, failure, skipped)'
+ required: true
+ type: string
+ e2e_test_result:
+ description: 'E2E test job result (success, failure, skipped)'
+ required: true
+ type: string
+ WEB_APPURL:
+ description: 'Container Web App URL'
+ required: false
+ default: ''
+ type: string
+ RESOURCE_GROUP_NAME:
+ description: 'Resource Group Name'
+ required: false
+ default: ''
+ type: string
+ QUOTA_FAILED:
+ description: 'Quota Check Failed Flag'
+ required: false
+ default: 'false'
+ type: string
+ TEST_SUCCESS:
+ description: 'Test Success Flag'
+ required: false
+ default: ''
+ type: string
+ TEST_REPORT_URL:
+ description: 'Test Report URL'
+ required: false
+ default: ''
+ type: string
+
+env:
+ GPT_MIN_CAPACITY: 100
+ BRANCH_NAME: ${{ github.event.workflow_run.head_branch || github.head_ref || github.ref_name }}
+ WAF_ENABLED: ${{ inputs.trigger_type == 'workflow_dispatch' && (inputs.waf_enabled || false) || false }}
+ EXP: ${{ inputs.trigger_type == 'workflow_dispatch' && (inputs.EXP || false) || false }}
+ RUN_E2E_TESTS: ${{ inputs.trigger_type == 'workflow_dispatch' && (inputs.run_e2e_tests || 'GoldenPath-Testing') || 'GoldenPath-Testing' }}
+permissions:
+ contents: read
+ actions: read
+
+jobs:
+ send-notification:
+ runs-on: ubuntu-latest
+ continue-on-error: true
+ env:
+ accelerator_name: "DocGen"
+ steps:
+ - name: Validate Workflow Input Parameters
+ shell: bash
+ env:
+ INPUT_TRIGGER_TYPE: ${{ inputs.trigger_type }}
+ INPUT_WAF_ENABLED: ${{ inputs.waf_enabled }}
+ INPUT_EXP: ${{ inputs.EXP }}
+ INPUT_RUN_E2E_TESTS: ${{ inputs.run_e2e_tests }}
+ INPUT_EXISTING_WEBAPP_URL: ${{ inputs.existing_webapp_url }}
+ INPUT_DEPLOY_RESULT: ${{ inputs.deploy_result }}
+ INPUT_E2E_TEST_RESULT: ${{ inputs.e2e_test_result }}
+ INPUT_WEB_APPURL: ${{ inputs.WEB_APPURL }}
+ INPUT_RESOURCE_GROUP_NAME: ${{ inputs.RESOURCE_GROUP_NAME }}
+ INPUT_QUOTA_FAILED: ${{ inputs.QUOTA_FAILED }}
+ INPUT_TEST_SUCCESS: ${{ inputs.TEST_SUCCESS }}
+ INPUT_TEST_REPORT_URL: ${{ inputs.TEST_REPORT_URL }}
+ run: |
+ echo "🔍 Validating workflow input parameters..."
+ VALIDATION_FAILED=false
+
+ # Validate trigger_type (required - alphanumeric with underscores)
+ if [[ -z "$INPUT_TRIGGER_TYPE" ]]; then
+ echo "❌ ERROR: trigger_type is required but was not provided"
+ VALIDATION_FAILED=true
+ elif [[ ! "$INPUT_TRIGGER_TYPE" =~ ^[a-zA-Z0-9_]+$ ]]; then
+ echo "❌ ERROR: trigger_type '$INPUT_TRIGGER_TYPE' is invalid. Must contain only alphanumeric characters and underscores"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ trigger_type: '$INPUT_TRIGGER_TYPE' is valid"
+ fi
+
+ # Validate waf_enabled (boolean)
+ if [[ "$INPUT_WAF_ENABLED" != "true" && "$INPUT_WAF_ENABLED" != "false" ]]; then
+ echo "❌ ERROR: waf_enabled must be 'true' or 'false', got: '$INPUT_WAF_ENABLED'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ waf_enabled: '$INPUT_WAF_ENABLED' is valid"
+ fi
+
+ # Validate EXP (boolean)
+ if [[ "$INPUT_EXP" != "true" && "$INPUT_EXP" != "false" ]]; then
+ echo "❌ ERROR: EXP must be 'true' or 'false', got: '$INPUT_EXP'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ EXP: '$INPUT_EXP' is valid"
+ fi
+
+ # Validate run_e2e_tests (specific allowed values)
+ if [[ -n "$INPUT_RUN_E2E_TESTS" ]]; then
+ ALLOWED_VALUES=("None" "GoldenPath-Testing" "Smoke-Testing")
+ if [[ ! " ${ALLOWED_VALUES[@]} " =~ " ${INPUT_RUN_E2E_TESTS} " ]]; then
+ echo "❌ ERROR: run_e2e_tests '$INPUT_RUN_E2E_TESTS' is invalid. Allowed values: ${ALLOWED_VALUES[*]}"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ run_e2e_tests: '$INPUT_RUN_E2E_TESTS' is valid"
+ fi
+ fi
+
+ # Validate existing_webapp_url (must start with https if provided)
+ if [[ -n "$INPUT_EXISTING_WEBAPP_URL" ]]; then
+ if [[ ! "$INPUT_EXISTING_WEBAPP_URL" =~ ^https:// ]]; then
+ echo "❌ ERROR: existing_webapp_url must start with 'https://', got: '$INPUT_EXISTING_WEBAPP_URL'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ existing_webapp_url: '$INPUT_EXISTING_WEBAPP_URL' is valid"
+ fi
+ fi
+
+ # Validate deploy_result (required, must be specific values)
+ if [[ -z "$INPUT_DEPLOY_RESULT" ]]; then
+ echo "❌ ERROR: deploy_result is required but not provided"
+ VALIDATION_FAILED=true
+ else
+ ALLOWED_DEPLOY_RESULTS=("success" "failure" "skipped")
+ if [[ ! " ${ALLOWED_DEPLOY_RESULTS[@]} " =~ " ${INPUT_DEPLOY_RESULT} " ]]; then
+ echo "❌ ERROR: deploy_result '$INPUT_DEPLOY_RESULT' is invalid. Allowed values: ${ALLOWED_DEPLOY_RESULTS[*]}"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ deploy_result: '$INPUT_DEPLOY_RESULT' is valid"
+ fi
+ fi
+
+ # Validate e2e_test_result (required, must be specific values)
+ if [[ -z "$INPUT_E2E_TEST_RESULT" ]]; then
+ echo "❌ ERROR: e2e_test_result is required but not provided"
+ VALIDATION_FAILED=true
+ else
+ ALLOWED_TEST_RESULTS=("success" "failure" "skipped")
+ if [[ ! " ${ALLOWED_TEST_RESULTS[@]} " =~ " ${INPUT_E2E_TEST_RESULT} " ]]; then
+ echo "❌ ERROR: e2e_test_result '$INPUT_E2E_TEST_RESULT' is invalid. Allowed values: ${ALLOWED_TEST_RESULTS[*]}"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ e2e_test_result: '$INPUT_E2E_TEST_RESULT' is valid"
+ fi
+ fi
+
+ # Validate WEB_APPURL (must start with https if provided)
+ if [[ -n "$INPUT_WEB_APPURL" ]]; then
+ if [[ ! "$INPUT_WEB_APPURL" =~ ^https:// ]]; then
+ echo "❌ ERROR: WEB_APPURL must start with 'https://', got: '$INPUT_WEB_APPURL'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ WEB_APPURL: '$INPUT_WEB_APPURL' is valid"
+ fi
+ fi
+
+ # Validate RESOURCE_GROUP_NAME (Azure resource group naming convention if provided)
+ if [[ -n "$INPUT_RESOURCE_GROUP_NAME" ]]; then
+ if [[ ! "$INPUT_RESOURCE_GROUP_NAME" =~ ^[a-zA-Z0-9._\(\)-]+$ ]] || [[ "$INPUT_RESOURCE_GROUP_NAME" =~ \.$ ]]; then
+ echo "❌ ERROR: RESOURCE_GROUP_NAME '$INPUT_RESOURCE_GROUP_NAME' is invalid. Must contain only alphanumerics, periods, underscores, hyphens, and parentheses. Cannot end with period."
+ VALIDATION_FAILED=true
+ elif [[ ${#INPUT_RESOURCE_GROUP_NAME} -gt 90 ]]; then
+ echo "❌ ERROR: RESOURCE_GROUP_NAME '$INPUT_RESOURCE_GROUP_NAME' exceeds 90 characters"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ RESOURCE_GROUP_NAME: '$INPUT_RESOURCE_GROUP_NAME' is valid"
+ fi
+ fi
+
+ # Validate QUOTA_FAILED (must be 'true', 'false', or empty string)
+ if [[ "$INPUT_QUOTA_FAILED" != "true" && "$INPUT_QUOTA_FAILED" != "false" && "$INPUT_QUOTA_FAILED" != "" ]]; then
+ echo "❌ ERROR: QUOTA_FAILED must be 'true', 'false', or empty string, got: '$INPUT_QUOTA_FAILED'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ QUOTA_FAILED: '$INPUT_QUOTA_FAILED' is valid"
+ fi
+
+ # Validate TEST_SUCCESS (must be 'true' or 'false' or empty)
+ if [[ -n "$INPUT_TEST_SUCCESS" ]]; then
+ if [[ "$INPUT_TEST_SUCCESS" != "true" && "$INPUT_TEST_SUCCESS" != "false" ]]; then
+ echo "❌ ERROR: TEST_SUCCESS must be 'true', 'false', or empty, got: '$INPUT_TEST_SUCCESS'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ TEST_SUCCESS: '$INPUT_TEST_SUCCESS' is valid"
+ fi
+ fi
+
+ # Validate TEST_REPORT_URL (must start with https if provided)
+ if [[ -n "$INPUT_TEST_REPORT_URL" ]]; then
+ if [[ ! "$INPUT_TEST_REPORT_URL" =~ ^https:// ]]; then
+ echo "❌ ERROR: TEST_REPORT_URL must start with 'https://', got: '$INPUT_TEST_REPORT_URL'"
+ VALIDATION_FAILED=true
+ else
+ echo "✅ TEST_REPORT_URL: '$INPUT_TEST_REPORT_URL' is valid"
+ fi
+ fi
+
+ # Fail workflow if any validation failed
+ if [[ "$VALIDATION_FAILED" == "true" ]]; then
+ echo ""
+ echo "❌ Parameter validation failed. Please correct the errors above and try again."
+ exit 1
+ fi
+
+ echo ""
+ echo "✅ All input parameters validated successfully!"
+
+ - name: Determine Test Suite Display Name
+ id: test_suite
+ shell: bash
+ env:
+ RUN_E2E_TESTS_INPUT: ${{ inputs.run_e2e_tests }}
+ run: |
+ if [ "$RUN_E2E_TESTS_INPUT" = "GoldenPath-Testing" ]; then
+ TEST_SUITE_NAME="Golden Path Testing"
+ elif [ "$RUN_E2E_TESTS_INPUT" = "Smoke-Testing" ]; then
+ TEST_SUITE_NAME="Smoke Testing"
+ elif [ "$RUN_E2E_TESTS_INPUT" = "None" ]; then
+ TEST_SUITE_NAME="None"
+ else
+ TEST_SUITE_NAME="$RUN_E2E_TESTS_INPUT"
+ fi
+ echo "TEST_SUITE_NAME=$TEST_SUITE_NAME" >> $GITHUB_OUTPUT
+ echo "Test Suite: $TEST_SUITE_NAME"
+
+ - name: Send Quota Failure Notification
+ if: inputs.deploy_result == 'failure' && inputs.QUOTA_FAILED == 'true'
+ shell: bash
+ env:
+ INPUT_DEPLOY_RESULT: ${{ inputs.deploy_result }}
+ INPUT_QUOTA_FAILED: ${{ inputs.QUOTA_FAILED }}
+ run: |
+ RUN_URL="https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}"
+ EMAIL_BODY=$(cat <Dear Team,We would like to inform you that the ${{ env.accelerator_name }} deployment has failed due to insufficient quota in the requested regions.
Issue Details:
• Quota check failed for GPT model
• Required GPT Capacity: ${{ env.GPT_MIN_CAPACITY }}
• Checked Regions: ${{ vars.AZURE_REGIONS }}
Run URL: ${RUN_URL}
Please resolve the quota issue and retry the deployment.
Best regards,
Your Automation Team
",
+ "subject": "${{ env.accelerator_name }} Pipeline - Failed (Insufficient Quota)"
+ }
+ EOF
+ )
+
+ curl -X POST "${{ secrets.EMAILNOTIFICATION_LOGICAPP_URL_TA }}" \
+ -H "Content-Type: application/json" \
+ -d "$EMAIL_BODY" || echo "Failed to send quota failure notification"
+
+ - name: Send Deployment Failure Notification
+ if: inputs.deploy_result == 'failure' && inputs.QUOTA_FAILED != 'true'
+ shell: bash
+ env:
+ INPUT_DEPLOY_RESULT: ${{ inputs.deploy_result }}
+ INPUT_QUOTA_FAILED: ${{ inputs.QUOTA_FAILED }}
+ INPUT_RESOURCE_GROUP_NAME: ${{ inputs.RESOURCE_GROUP_NAME }}
+ run: |
+ RUN_URL="https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}"
+ RESOURCE_GROUP="$INPUT_RESOURCE_GROUP_NAME"
+
+ EMAIL_BODY=$(cat <Dear Team,We would like to inform you that the ${{ env.accelerator_name }} deployment process has encountered an issue and has failed to complete successfully.
Deployment Details:
• Resource Group: ${RESOURCE_GROUP}
• WAF Enabled: ${{ env.WAF_ENABLED }}
• EXP Enabled: ${{ env.EXP }}
Run URL: ${RUN_URL}
Please investigate the deployment failure at your earliest convenience.
Best regards,
Your Automation Team
",
+ "subject": "${{ env.accelerator_name }} Pipeline - Failed"
+ }
+ EOF
+ )
+
+ curl -X POST "${{ secrets.EMAILNOTIFICATION_LOGICAPP_URL_TA }}" \
+ -H "Content-Type: application/json" \
+ -d "$EMAIL_BODY" || echo "Failed to send deployment failure notification"
+
+ - name: Send Success Notification
+ if: inputs.deploy_result == 'success' && (inputs.e2e_test_result == 'skipped' || inputs.TEST_SUCCESS == 'true')
+ shell: bash
+ env:
+ INPUT_DEPLOY_RESULT: ${{ inputs.deploy_result }}
+ INPUT_E2E_TEST_RESULT: ${{ inputs.e2e_test_result }}
+ INPUT_TEST_SUCCESS: ${{ inputs.TEST_SUCCESS }}
+ INPUT_WEB_APPURL: ${{ inputs.WEB_APPURL }}
+ INPUT_EXISTING_WEBAPP_URL: ${{ inputs.existing_webapp_url }}
+ INPUT_RESOURCE_GROUP_NAME: ${{ inputs.RESOURCE_GROUP_NAME }}
+ INPUT_TEST_REPORT_URL: ${{ inputs.TEST_REPORT_URL }}
+ run: |
+ RUN_URL="https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}"
+ WEBAPP_URL="${INPUT_WEB_APPURL:-$INPUT_EXISTING_WEBAPP_URL}"
+ RESOURCE_GROUP="$INPUT_RESOURCE_GROUP_NAME"
+ TEST_REPORT_URL="$INPUT_TEST_REPORT_URL"
+ TEST_SUITE_NAME="${{ steps.test_suite.outputs.TEST_SUITE_NAME }}"
+
+ if [ "$INPUT_E2E_TEST_RESULT" = "skipped" ]; then
+ EMAIL_BODY=$(cat <Dear Team,We would like to inform you that the ${{ env.accelerator_name }} deployment has completed successfully.
Deployment Details:
• Resource Group: ${RESOURCE_GROUP}
• Web App URL: ${WEBAPP_URL}
• E2E Tests: Skipped (as configured)
Configuration:
• WAF Enabled: ${{ env.WAF_ENABLED }}
• EXP Enabled: ${{ env.EXP }}
Run URL: ${RUN_URL}
Best regards,
Your Automation Team
",
+ "subject": "${{ env.accelerator_name }} Pipeline - Deployment Success"
+ }
+ EOF
+ )
+ else
+ EMAIL_BODY=$(cat <Dear Team,We would like to inform you that the ${{ env.accelerator_name }} deployment and testing process has completed successfully.
Deployment Details:
• Resource Group: ${RESOURCE_GROUP}
• Web App URL: ${WEBAPP_URL}
• E2E Tests: Passed ✅
• Test Suite: ${TEST_SUITE_NAME}
• Test Report: View Report
Configuration:
• WAF Enabled: ${{ env.WAF_ENABLED }}
• EXP Enabled: ${{ env.EXP }}
Run URL: ${RUN_URL}
Best regards,
Your Automation Team
",
+ "subject": "${{ env.accelerator_name }} Pipeline - Test Automation - Success"
+ }
+ EOF
+ )
+ fi
+
+ curl -X POST "${{ secrets.EMAILNOTIFICATION_LOGICAPP_URL_TA }}" \
+ -H "Content-Type: application/json" \
+ -d "$EMAIL_BODY" || echo "Failed to send success notification"
+
+ - name: Send Test Failure Notification
+ if: inputs.deploy_result == 'success' && inputs.e2e_test_result != 'skipped' && inputs.TEST_SUCCESS != 'true'
+ shell: bash
+ env:
+ INPUT_DEPLOY_RESULT: ${{ inputs.deploy_result }}
+ INPUT_E2E_TEST_RESULT: ${{ inputs.e2e_test_result }}
+ INPUT_TEST_SUCCESS: ${{ inputs.TEST_SUCCESS }}
+ INPUT_WEB_APPURL: ${{ inputs.WEB_APPURL }}
+ INPUT_EXISTING_WEBAPP_URL: ${{ inputs.existing_webapp_url }}
+ INPUT_RESOURCE_GROUP_NAME: ${{ inputs.RESOURCE_GROUP_NAME }}
+ INPUT_TEST_REPORT_URL: ${{ inputs.TEST_REPORT_URL }}
+ run: |
+ RUN_URL="https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}"
+ TEST_REPORT_URL="$INPUT_TEST_REPORT_URL"
+ WEBAPP_URL="${INPUT_WEB_APPURL:-$INPUT_EXISTING_WEBAPP_URL}"
+ RESOURCE_GROUP="$INPUT_RESOURCE_GROUP_NAME"
+ TEST_SUITE_NAME="${{ steps.test_suite.outputs.TEST_SUITE_NAME }}"
+
+ EMAIL_BODY=$(cat <Dear Team,We would like to inform you that ${{ env.accelerator_name }} accelerator test automation process has encountered issues and failed to complete successfully.
Deployment Details:
• Resource Group: ${RESOURCE_GROUP}
• Web App URL: ${WEBAPP_URL}
• Deployment Status: ✅ Success
• E2E Tests: ❌ Failed
• Test Suite: ${TEST_SUITE_NAME}
Test Details:
• Test Report: View Report
Run URL: ${RUN_URL}
Please investigate the matter at your earliest convenience.
Best regards,
Your Automation Team
",
+ "subject": "${{ env.accelerator_name }} Pipeline - Test Automation - Failed"
+ }
+ EOF
+ )
+
+ curl -X POST "${{ secrets.EMAILNOTIFICATION_LOGICAPP_URL_TA }}" \
+ -H "Content-Type: application/json" \
+ -d "$EMAIL_BODY" || echo "Failed to send test failure notification"
+
+ - name: Send Existing URL Success Notification
+ if: inputs.deploy_result == 'skipped' && inputs.existing_webapp_url != '' && inputs.e2e_test_result == 'success' && (inputs.TEST_SUCCESS == 'true' || inputs.TEST_SUCCESS == '')
+ shell: bash
+ env:
+ INPUT_DEPLOY_RESULT: ${{ inputs.deploy_result }}
+ INPUT_E2E_TEST_RESULT: ${{ inputs.e2e_test_result }}
+ INPUT_TEST_SUCCESS: ${{ inputs.TEST_SUCCESS }}
+ INPUT_EXISTING_WEBAPP_URL: ${{ inputs.existing_webapp_url }}
+ INPUT_TEST_REPORT_URL: ${{ inputs.TEST_REPORT_URL }}
+ run: |
+ RUN_URL="https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}"
+ EXISTING_URL="$INPUT_EXISTING_WEBAPP_URL"
+ TEST_REPORT_URL="$INPUT_TEST_REPORT_URL"
+ TEST_SUITE_NAME="${{ steps.test_suite.outputs.TEST_SUITE_NAME }}"
+
+ EMAIL_BODY=$(cat <Dear Team,The ${{ env.accelerator_name }} pipeline executed against the specified Target URL and testing process has completed successfully.
Test Results:
• Status: ✅ Passed
• Test Suite: ${TEST_SUITE_NAME}
${TEST_REPORT_URL:+• Test Report: View Report}
• Target URL: ${EXISTING_URL}
Deployment: Skipped
Run URL: ${RUN_URL}
Best regards,
Your Automation Team
",
+ "subject": "${{ env.accelerator_name }} Pipeline - Test Automation Passed"
+ }
+ EOF
+ )
+
+ curl -X POST "${{ secrets.EMAILNOTIFICATION_LOGICAPP_URL_TA }}" \
+ -H "Content-Type: application/json" \
+ -d "$EMAIL_BODY" || echo "Failed to send existing URL success notification"
+
+ - name: Send Existing URL Test Failure Notification
+ if: inputs.deploy_result == 'skipped' && inputs.existing_webapp_url != '' && inputs.e2e_test_result == 'failure'
+ shell: bash
+ env:
+ INPUT_DEPLOY_RESULT: ${{ inputs.deploy_result }}
+ INPUT_E2E_TEST_RESULT: ${{ inputs.e2e_test_result }}
+ INPUT_EXISTING_WEBAPP_URL: ${{ inputs.existing_webapp_url }}
+ INPUT_TEST_REPORT_URL: ${{ inputs.TEST_REPORT_URL }}
+ run: |
+ RUN_URL="https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}"
+ EXISTING_URL="$INPUT_EXISTING_WEBAPP_URL"
+ TEST_REPORT_URL="$INPUT_TEST_REPORT_URL"
+ TEST_SUITE_NAME="${{ steps.test_suite.outputs.TEST_SUITE_NAME }}"
+
+ EMAIL_BODY=$(cat <Dear Team,The ${{ env.accelerator_name }} pipeline executed against the specified Target URL and the test automation has encountered issues and failed to complete successfully.
Failure Details:
• Target URL: ${EXISTING_URL}
${TEST_REPORT_URL:+• Test Report: View Report}
• Test Suite: ${TEST_SUITE_NAME}
• Deployment: Skipped
Run URL: ${RUN_URL}
Best regards,
Your Automation Team
",
+ "subject": "${{ env.accelerator_name }} Pipeline - Test Automation Failed"
+ }
+ EOF
+ )
+
+ curl -X POST "${{ secrets.EMAILNOTIFICATION_LOGICAPP_URL_TA }}" \
+ -H "Content-Type: application/json" \
+ -d "$EMAIL_BODY" || echo "Failed to send existing URL test failure notification"
diff --git a/.github/workflows/node.js.yml b/archive-doc-gen/.github/workflows/node.js.yml
similarity index 100%
rename from .github/workflows/node.js.yml
rename to archive-doc-gen/.github/workflows/node.js.yml
diff --git a/.github/workflows/pr-title-checker.yml b/archive-doc-gen/.github/workflows/pr-title-checker.yml
similarity index 100%
rename from .github/workflows/pr-title-checker.yml
rename to archive-doc-gen/.github/workflows/pr-title-checker.yml
diff --git a/.github/workflows/pylint.yml b/archive-doc-gen/.github/workflows/pylint.yml
similarity index 100%
rename from .github/workflows/pylint.yml
rename to archive-doc-gen/.github/workflows/pylint.yml
diff --git a/.github/workflows/python-app.yml b/archive-doc-gen/.github/workflows/python-app.yml
similarity index 100%
rename from .github/workflows/python-app.yml
rename to archive-doc-gen/.github/workflows/python-app.yml
diff --git a/.github/workflows/stale-bot.yml b/archive-doc-gen/.github/workflows/stale-bot.yml
similarity index 100%
rename from .github/workflows/stale-bot.yml
rename to archive-doc-gen/.github/workflows/stale-bot.yml
diff --git a/.github/workflows/telemetry-template-check.yml b/archive-doc-gen/.github/workflows/telemetry-template-check.yml
similarity index 100%
rename from .github/workflows/telemetry-template-check.yml
rename to archive-doc-gen/.github/workflows/telemetry-template-check.yml
diff --git a/archive-doc-gen/.github/workflows/test-automation-v2.yml b/archive-doc-gen/.github/workflows/test-automation-v2.yml
new file mode 100644
index 000000000..637a79fa6
--- /dev/null
+++ b/archive-doc-gen/.github/workflows/test-automation-v2.yml
@@ -0,0 +1,196 @@
+name: Test Automation DocGen-v2
+
+on:
+ workflow_call:
+ inputs:
+ DOCGEN_URL:
+ required: true
+ type: string
+ description: "Web URL for DocGen"
+ TEST_SUITE:
+ required: false
+ type: string
+ default: "GoldenPath-Testing"
+ description: "Test suite to run: 'Smoke-Testing', 'GoldenPath-Testing' "
+ outputs:
+ TEST_SUCCESS:
+ description: "Whether tests passed"
+ value: ${{ jobs.test.outputs.TEST_SUCCESS }}
+ TEST_REPORT_URL:
+ description: "URL to test report artifact"
+ value: ${{ jobs.test.outputs.TEST_REPORT_URL }}
+
+env:
+ url: ${{ inputs.DOCGEN_URL }}
+ accelerator_name: "DocGen"
+ test_suite: ${{ inputs.TEST_SUITE }}
+permissions:
+ contents: read
+ actions: read
+
+jobs:
+ test:
+ runs-on: ubuntu-latest
+ outputs:
+ TEST_SUCCESS: ${{ steps.test1.outcome == 'success' || steps.test2.outcome == 'success' || steps.test3.outcome == 'success' }}
+ TEST_REPORT_URL: ${{ steps.upload_report.outputs.artifact-url }}
+ steps:
+ - name: Checkout repository
+ uses: actions/checkout@v5
+
+ - name: Set up Python
+ uses: actions/setup-python@v6
+ with:
+ python-version: '3.13'
+
+ - name: Login to Azure
+ run: |
+ az login --service-principal -u ${{ secrets.AZURE_CLIENT_ID }} -p ${{ secrets.AZURE_CLIENT_SECRET }} --tenant ${{ secrets.AZURE_TENANT_ID }}
+ az account set --subscription ${{ secrets.AZURE_SUBSCRIPTION_ID }}
+
+ - name: Install dependencies
+ run: |
+ python -m pip install --upgrade pip
+ pip install -r tests/e2e-test/requirements.txt
+
+ - name: Ensure browsers are installed
+ run: python -m playwright install --with-deps chromium
+
+ - name: Validate URL
+ run: |
+ if [ -z "${{ env.url }}" ]; then
+ echo "ERROR: No URL provided for testing"
+ exit 1
+ fi
+ echo "Testing URL: ${{ env.url }}"
+ echo "Test Suite: ${{ env.test_suite }}"
+
+
+ - name: Wait for Application to be Ready
+ run: |
+ echo "Waiting for application to be ready at ${{ env.url }} "
+ max_attempts=10
+ attempt=1
+
+ while [ $attempt -le $max_attempts ]; do
+ echo "Attempt $attempt: Checking if application is ready..."
+ if curl -f -s "${{ env.url }}" > /dev/null; then
+ echo "Application is ready!"
+ break
+
+ fi
+
+ if [ $attempt -eq $max_attempts ]; then
+ echo "Application is not ready after $max_attempts attempts"
+ exit 1
+ fi
+
+ echo "Application not ready, waiting 30 seconds..."
+ sleep 30
+ attempt=$((attempt + 1))
+ done
+
+ - name: Run tests(1)
+ id: test1
+ run: |
+ if [ "${{ env.test_suite }}" == "GoldenPath-Testing" ]; then
+ xvfb-run pytest -m goldenpath --html=report/report.html --self-contained-html
+ else
+ xvfb-run pytest --html=report/report.html --self-contained-html
+ fi
+ working-directory: tests/e2e-test
+ continue-on-error: true
+
+ - name: Sleep for 30 seconds
+ if: ${{ steps.test1.outcome == 'failure' }}
+ run: sleep 30s
+ shell: bash
+
+ - name: Run tests(2)
+ id: test2
+ if: ${{ steps.test1.outcome == 'failure' }}
+ run: |
+ if [ "${{ env.test_suite }}" == "GoldenPath-Testing" ]; then
+ xvfb-run pytest -m goldenpath --html=report/report.html --self-contained-html
+ else
+ xvfb-run pytest --html=report/report.html --self-contained-html
+ fi
+ working-directory: tests/e2e-test
+ continue-on-error: true
+
+ - name: Sleep for 60 seconds
+ if: ${{ steps.test2.outcome == 'failure' }}
+ run: sleep 60s
+ shell: bash
+
+ - name: Run tests(3)
+ id: test3
+ if: ${{ steps.test2.outcome == 'failure' }}
+ run: |
+ if [ "${{ env.test_suite }}" == "GoldenPath-Testing" ]; then
+ xvfb-run pytest -m goldenpath --html=report/report.html --self-contained-html
+ else
+ xvfb-run pytest --html=report/report.html --self-contained-html
+ fi
+ working-directory: tests/e2e-test
+
+ - name: Upload test report
+ id: upload_report
+ uses: actions/upload-artifact@v4
+ if: ${{ !cancelled() }}
+ with:
+ name: test-report
+ path: |
+ tests/e2e-test/report/*
+ tests/e2e-test/screenshots/*
+
+ - name: Generate E2E Test Summary
+ if: always()
+ run: |
+ # Determine test suite type for title
+ if [ "${{ env.test_suite }}" == "GoldenPath-Testing" ]; then
+ echo "## 🧪 E2E Test Job Summary : Golden Path Testing" >> $GITHUB_STEP_SUMMARY
+ else
+ echo "## 🧪 E2E Test Job Summary : Smoke Testing" >> $GITHUB_STEP_SUMMARY
+ fi
+ echo "" >> $GITHUB_STEP_SUMMARY
+ echo "| Field | Value |" >> $GITHUB_STEP_SUMMARY
+ echo "|-------|--------|" >> $GITHUB_STEP_SUMMARY
+
+ # Determine overall test result
+ OVERALL_SUCCESS="${{ steps.test1.outcome == 'success' || steps.test2.outcome == 'success' || steps.test3.outcome == 'success' }}"
+ if [[ "$OVERALL_SUCCESS" == "true" ]]; then
+ echo "| **Job Status** | ✅ Success |" >> $GITHUB_STEP_SUMMARY
+ else
+ echo "| **Job Status** | ❌ Failed |" >> $GITHUB_STEP_SUMMARY
+ fi
+
+ echo "| **Target URL** | [${{ env.url }}](${{ env.url }}) |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Test Suite** | \`${{ env.test_suite }}\` |" >> $GITHUB_STEP_SUMMARY
+ echo "| **Test Report** | [Download Artifact](${{ steps.upload_report.outputs.artifact-url }}) |" >> $GITHUB_STEP_SUMMARY
+ echo "" >> $GITHUB_STEP_SUMMARY
+
+ echo "### 📋 Test Execution Details" >> $GITHUB_STEP_SUMMARY
+ echo "| Attempt | Status | Notes |" >> $GITHUB_STEP_SUMMARY
+ echo "|---------|--------|-------|" >> $GITHUB_STEP_SUMMARY
+ echo "| **Test Run 1** | ${{ steps.test1.outcome == 'success' && '✅ Passed' || '❌ Failed' }} | Initial test execution |" >> $GITHUB_STEP_SUMMARY
+
+ if [[ "${{ steps.test1.outcome }}" == "failure" ]]; then
+ echo "| **Test Run 2** | ${{ steps.test2.outcome == 'success' && '✅ Passed' || steps.test2.outcome == 'failure' && '❌ Failed' || '⏸️ Skipped' }} | Retry after 30s delay |" >> $GITHUB_STEP_SUMMARY
+ fi
+
+ if [[ "${{ steps.test2.outcome }}" == "failure" ]]; then
+ echo "| **Test Run 3** | ${{ steps.test3.outcome == 'success' && '✅ Passed' || steps.test3.outcome == 'failure' && '❌ Failed' || '⏸️ Skipped' }} | Final retry after 60s delay |" >> $GITHUB_STEP_SUMMARY
+ fi
+
+ echo "" >> $GITHUB_STEP_SUMMARY
+
+ if [[ "$OVERALL_SUCCESS" == "true" ]]; then
+ echo "### ✅ Test Results" >> $GITHUB_STEP_SUMMARY
+ echo "- End-to-end tests completed successfully" >> $GITHUB_STEP_SUMMARY
+ echo "- Application is functioning as expected" >> $GITHUB_STEP_SUMMARY
+ else
+ echo "### ❌ Test Results" >> $GITHUB_STEP_SUMMARY
+ echo "- All test attempts failed" >> $GITHUB_STEP_SUMMARY
+ echo "- Check the e2e-test/test job for detailed error information" >> $GITHUB_STEP_SUMMARY
+ fi
\ No newline at end of file
diff --git a/.github/workflows/test-automation.yml b/archive-doc-gen/.github/workflows/test-automation.yml
similarity index 99%
rename from .github/workflows/test-automation.yml
rename to archive-doc-gen/.github/workflows/test-automation.yml
index 1be1ecb7b..f2b5049ea 100644
--- a/.github/workflows/test-automation.yml
+++ b/archive-doc-gen/.github/workflows/test-automation.yml
@@ -22,7 +22,10 @@ on:
env:
url: ${{ inputs.DOCGEN_URL }}
accelerator_name: "DocGen"
-
+permissions:
+ contents: read
+ actions: read
+
jobs:
test:
runs-on: ubuntu-latest
diff --git a/.github/workflows/tests.yml b/archive-doc-gen/.github/workflows/tests.yml
similarity index 100%
rename from .github/workflows/tests.yml
rename to archive-doc-gen/.github/workflows/tests.yml
diff --git a/archive-doc-gen/.gitignore b/archive-doc-gen/.gitignore
new file mode 100644
index 000000000..0abb7a034
--- /dev/null
+++ b/archive-doc-gen/.gitignore
@@ -0,0 +1,15 @@
+.venv
+
+.env
+.azure/
+__pycache__/
+.ipynb_checkpoints/
+
+
+venv
+myenv
+
+scriptsenv/
+
+scriptenv
+pdf
\ No newline at end of file
diff --git a/.vscode/launch.json b/archive-doc-gen/.vscode/launch.json
similarity index 100%
rename from .vscode/launch.json
rename to archive-doc-gen/.vscode/launch.json
diff --git a/.vscode/settings.json b/archive-doc-gen/.vscode/settings.json
similarity index 100%
rename from .vscode/settings.json
rename to archive-doc-gen/.vscode/settings.json
diff --git a/archive-doc-gen/CODE_OF_CONDUCT.md b/archive-doc-gen/CODE_OF_CONDUCT.md
new file mode 100644
index 000000000..f9ba8cf65
--- /dev/null
+++ b/archive-doc-gen/CODE_OF_CONDUCT.md
@@ -0,0 +1,9 @@
+# Microsoft Open Source Code of Conduct
+
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
+
+Resources:
+
+- [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/)
+- [Microsoft Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
+- Contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with questions or concerns
diff --git a/archive-doc-gen/CONTRIBUTING.md b/archive-doc-gen/CONTRIBUTING.md
new file mode 100644
index 000000000..c282e9a1a
--- /dev/null
+++ b/archive-doc-gen/CONTRIBUTING.md
@@ -0,0 +1,14 @@
+# Contributing
+
+This project welcomes contributions and suggestions. Most contributions require you to
+agree to a Contributor License Agreement (CLA) declaring that you have the right to,
+and actually do, grant us the rights to use your contribution. For details, visit
+https://cla.microsoft.com.
+
+When you submit a pull request, a CLA-bot will automatically determine whether you need
+to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the
+instructions provided by the bot. You will only need to do this once across all repositories using our CLA.
+
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
+For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
+or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
\ No newline at end of file
diff --git a/archive-doc-gen/LICENSE b/archive-doc-gen/LICENSE
new file mode 100644
index 000000000..9e841e7a2
--- /dev/null
+++ b/archive-doc-gen/LICENSE
@@ -0,0 +1,21 @@
+ MIT License
+
+ Copyright (c) Microsoft Corporation.
+
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+
+ The above copyright notice and this permission notice shall be included in all
+ copies or substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ SOFTWARE
diff --git a/archive-doc-gen/README.md b/archive-doc-gen/README.md
new file mode 100644
index 000000000..4db342838
--- /dev/null
+++ b/archive-doc-gen/README.md
@@ -0,0 +1,228 @@
+# Document generation solution accelerator
+
+This solution accelerator is a powerful tool that helps you create your own AI assistant for document generation. The accelerator can be used by any customer looking for reusable architecture and code snippets to build an AI assistant to generate a sample template and content grounded on their own enterprise data.
+
+This example focuses on a generic use case - chat with your own data, generate a document template using your own data, and exporting the document in a docx format.
+
+
+
+
+
+[**SOLUTION OVERVIEW**](#solution-overview) \| [**QUICK DEPLOY**](#quick-deploy) \| [**BUSINESS SCENARIO**](#business-scenario) \| [**SUPPORTING DOCUMENTATION**](#supporting-documentation)
+
+
+
+
+**Note:** With any AI solutions you create using these templates, you are responsible for assessing all associated risks and for complying with all applicable laws and safety standards. Learn more in the transparency documents for [Agent Service](https://learn.microsoft.com/en-us/azure/ai-foundry/responsible-ai/agents/transparency-note) and [Agent Framework](https://github.com/microsoft/agent-framework/blob/main/TRANSPARENCY_FAQ.md).
+
+
+
+Solution overview
+
+
+It leverages Azure OpenAI Service and Azure AI Search, to identify relevant documents, summarize unstructured information, and generate document templates.
+
+The sample data is sourced from generic AI-generated promissory notes. The documents are intended for use as sample data only.
+
+### Solution architecture
+||
+|---|
+
+
+
+
+### Additional resources
+
+[Azure OpenAI Service](https://learn.microsoft.com/en-us/azure/ai-services/openai/)
+
+[Azure AI Search](https://learn.microsoft.com/en-us/azure/search/)
+
+[Azure AI Foundry](https://learn.microsoft.com/en-us/azure/ai-studio/)
+
+
+
+
+### Key features
+
+ Click to learn more about the key features this solution enables
+
+ - **Semantic search**
+ Azure AI Search to enable RAG and grounding of the application on the processed dataset.
+
+ - **Summarization**
+ Azure OpenAI Service and GPT models to help summarize the search content and answer questions.
+
+ - **Content generation**
+ Azure OpenAI Service and GPT models to help generate relevant content with Prompt Flow.
+
+
+
+
+
+
+
+Quick deploy
+
+
+### How to install or deploy
+Follow the quick deploy steps on the deployment guide to deploy this solution to your own Azure subscription.
+
+> **Note:** This solution accelerator requires **Azure Developer CLI (azd) version 1.18.0 or higher**. Please ensure you have the latest version installed before proceeding with deployment. [Download azd here](https://learn.microsoft.com/en-us/azure/developer/azure-developer-cli/install-azd).
+
+[Click here to launch the deployment guide](./docs/DeploymentGuide.md)
+
+
+**For Local Development**
+- [Local Development Setup Guide](docs/LocalDevelopmentSetup.md) - Comprehensive setup instructions for Windows, Linux, and macOS
+
+| [](https://codespaces.new/microsoft/document-generation-solution-accelerator) | [](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/microsoft/document-generation-solution-accelerator) | [&message=Open&color=blue&logo=visualstudiocode&logoColor=white)](https://vscode.dev/azure/?vscode-azure-exp=foundry&agentPayload=eyJiYXNlVXJsIjogImh0dHBzOi8vcmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbS9taWNyb3NvZnQvZG9jdW1lbnQtZ2VuZXJhdGlvbi1zb2x1dGlvbi1hY2NlbGVyYXRvci9yZWZzL2hlYWRzL21haW4vaW5mcmEvdnNjb2RlX3dlYiIsICJpbmRleFVybCI6ICIvaW5kZXguanNvbiIsICJ2YXJpYWJsZXMiOiB7ImFnZW50SWQiOiAiIiwgImNvbm5lY3Rpb25TdHJpbmciOiAiIiwgInRocmVhZElkIjogIiIsICJ1c2VyTWVzc2FnZSI6ICIiLCAicGxheWdyb3VuZE5hbWUiOiAiIiwgImxvY2F0aW9uIjogIiIsICJzdWJzY3JpcHRpb25JZCI6ICIiLCAicmVzb3VyY2VJZCI6ICIiLCAicHJvamVjdFJlc291cmNlSWQiOiAiIiwgImVuZHBvaW50IjogIiJ9LCAiY29kZVJvdXRlIjogWyJhaS1wcm9qZWN0cy1zZGsiLCAicHl0aG9uIiwgImRlZmF1bHQtYXp1cmUtYXV0aCIsICJlbmRwb2ludCJdfQ==) |
+|---|---|---|
+
+
+
+> ⚠️ **Important: Check Azure OpenAI Quota Availability**
+
To ensure sufficient quota is available in your subscription, please follow [quota check instructions guide](./docs/QuotaCheck.md) before you deploy the solution.
+
+
+
+### Prerequisites and costs
+
+To deploy this solution accelerator, ensure you have access to an [Azure subscription](https://azure.microsoft.com/free/) with the necessary permissions to create **resource groups, resources, app registrations, and assign roles at the resource group level**. This should include Contributor role at the subscription level and Role Based Access Control role on the subscription and/or resource group level. Follow the steps in [Azure Account Set Up](./docs/AzureAccountSetUp.md).
+
+Check the [Azure Products by Region](https://azure.microsoft.com/en-us/explore/global-infrastructure/products-by-region/?products=all®ions=all) page and select a **region** where the following services are available.
+
+Pricing varies per region and usage, so it isn't possible to predict exact costs for your usage. The majority of the Azure resources used in this infrastructure are on usage-based pricing tiers. However, Azure Container Registry has a fixed cost per registry per day.
+
+Use the [Azure pricing calculator](https://azure.microsoft.com/en-us/pricing/calculator) to calculate the cost of this solution in your subscription.
+
+Review a [sample pricing sheet](https://azure.com/e/2402502429fc46429e395e0bb93d0711) in the event you want to customize and scale usage.
+
+_Note: This is not meant to outline all costs as selected SKUs, scaled use, customizations, and integrations into your own tenant can affect the total consumption of this sample solution. The sample pricing sheet is meant to give you a starting point to customize the estimate for your specific needs._
+
+
+
+| Product | Description | Cost |
+|---|---|---|
+| [Azure AI Foundry](https://learn.microsoft.com/en-us/azure/ai-foundry/) | Free tier. Build generative AI applications on an enterprise-grade platform. | [Pricing](https://azure.microsoft.com/pricing/details/ai-studio/) |
+| [Azure AI Search](https://learn.microsoft.com/en-us/azure/search/) | Standard tier, S1. Pricing is based on the number of documents and operations. Information retrieval at scale for vector and text content in traditional or generative search scenarios. | [Pricing](https://azure.microsoft.com/pricing/details/search/) |
+| [Azure Storage Account](https://learn.microsoft.com/en-us/azure/storage/blobs/) | Standard tier, LRS. Pricing is based on storage and operations. Blob storage in the clopud, optimized for storing massive amounts of unstructured data. | [Pricing](https://azure.microsoft.com/pricing/details/storage/blobs/) |
+| [Azure Key Vault](https://learn.microsoft.com/en-us/azure/key-vault/) | Standard tier. Pricing is based on the number of operations. Maintain keys that access and encrypt your cloud resources, apps, and solutions. | [Pricing](https://azure.microsoft.com/pricing/details/key-vault/) |
+| [Azure AI Services](https://learn.microsoft.com/en-us/azure/ai-services/) | S0 tier, defaults to gpt-4.1 and text-embedding-ada-002 models. Pricing is based on token count. | [Pricing](https://azure.microsoft.com/pricing/details/cognitive-services/) |
+| [Azure Container App](https://learn.microsoft.com/en-us/azure/container-apps/) | Consumption tier with 0.5 CPU, 1GiB memory/storage. Pricing is based on resource allocation, and each month allows for a certain amount of free usage. Allows you to run containerized applications without worrying about orchestration or infrastructure. | [Pricing](https://azure.microsoft.com/pricing/details/container-apps/) |
+| [Azure Container Registry](https://learn.microsoft.com/en-us/azure/container-registry/) | Basic tier. Build, store, and manage container images and artifacts in a private registry for all types of container deployments | [Pricing](https://azure.microsoft.com/pricing/details/container-registry/) |
+| [Log analytics](https://learn.microsoft.com/en-us/azure/azure-monitor/) | Pay-as-you-go tier. Costs based on data ingested. Collect and analyze on telemetry data generated by Azure. | [Pricing](https://azure.microsoft.com/pricing/details/monitor/) |
+| [Azure Cosmos DB](https://learn.microsoft.com/en-us/azure/cosmos-db/) | Fully managed, distributed NoSQL, relational, and vector database for modern app development. | [Pricing](https://azure.microsoft.com/en-us/pricing/details/cosmos-db/autoscale-provisioned/) |
+
+
+
+
+
+>⚠️ **Important:** To avoid unnecessary costs, remember to take down your app if it's no longer in use,
+either by deleting the resource group in the Portal or running `azd down`.
+
+
+
+Business Scenario
+
+
+
+||
+|---|
+
+
+
+Put your data to work by reducing blank page anxiety, speeding up document drafting, improving draft document quality, and reference information quickly - keeping experts in their expertise. Draft document templates for your organization including Invoices, End-user Contracts, Purchase Orders, Investment Proposals, and Grant Submissions.
+
+⚠️ The sample data used in this repository is synthetic and generated using Azure OpenAI Service. The data is intended for use as sample data only.
+
+
+### Business value
+
+ Click to learn more about what value this solution provides
+
+ - **Draft templates quickly**
+ Put your data to work to create any kind of document that is supported by a large data library.
+
+ - **Share**
+ Share with co-authors, contributors and approvers quickly.
+
+ - **Contextualize information**
+ Provide context using natural language. Primary and secondary queries allow for access to supplemental detail – reducing cognitive load, increasing efficiency, and enabling focus on higher value work.
+
+ - **Gain confidence in responses**
+ Trust responses to queries by customizing how data is referenced and returned to users, reducing the risk of hallucinated responses.
Access reference documents in the same chat window to get more detail and confirm accuracy.
+
+ - **Secure data and responsible AI for innovation**
+ Improve data security to minimize breaches, fostering a culture of responsible AI adoption, maximize innovation opportunities, and sustain competitive edge.
+
+
+
+
+
+
+
+Supporting documentation
+
+
+### Security guidelines
+
+This template uses Azure Key Vault to store all connections to communicate between resources.
+
+This template also uses [Managed Identity](https://learn.microsoft.com/entra/identity/managed-identities-azure-resources/overview) for local development and deployment.
+
+To ensure continued best practices in your own repository, we recommend that anyone creating solutions based on our templates ensure that the [Github secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning) setting is enabled.
+
+You may want to consider additional security measures, such as:
+
+* Enabling Microsoft Defender for Cloud to [secure your Azure resources](https://learn.microsoft.com/azure/defender-for-cloud).
+* Protecting the Azure Container Apps instance with a [firewall](https://learn.microsoft.com/azure/container-apps/waf-app-gateway) and/or [Virtual Network](https://learn.microsoft.com/azure/container-apps/networking?tabs=workload-profiles-env%2Cazure-cli).
+
+
+
+### Cross references
+Check out similar solution accelerators
+
+| Solution Accelerator | Description |
+|---|---|
+| [Chat with your data](https://github.com/Azure-Samples/chat-with-your-data-solution-accelerator) | Chat with their own data by combining Azure Cognitive Search and Large Language Models (LLMs) to create a conversational search experience. It enables increased user efficiency by minimizing endpoints required to access internal company knowledgebases. |
+| [Document knowledge mining](https://github.com/microsoft/Document-Knowledge-Mining-Solution-Accelerator) | Built on Azure OpenAI Service and Azure AI Document Intelligence to process and extract summaries, entities, and metadata from unstructured, multi-modal documents and enable searching and chatting over this data. |
+| [Build your own copilot](https://github.com/microsoft/Build-your-own-copilot-Solution-Accelerator) | Helps client advisors to save time and prepare relevant discussion topics for scheduled meetings with overviews, client profile views, and chatting with structured data. |
+
+
+
+
+
+## Provide feedback
+
+Have questions, find a bug, or want to request a feature? [Submit a new issue](https://github.com/microsoft/document-generation-solution-accelerator/issues) on this repo and we'll connect.
+
+
+
+## Responsible AI Transparency FAQ
+Please refer to [Transparency FAQ](./docs/TRANSPARENCY_FAQ.md) for responsible AI transparency details of this solution accelerator.
+
+
+
+## Disclaimers
+
+This release is an artificial intelligence (AI) system that generates text based on user input. The text generated by this system may include ungrounded content, meaning that it is not verified by any reliable source or based on any factual data. The data included in this release is synthetic, meaning that it is artificially created by the system and may contain factual errors or inconsistencies. Users of this release are responsible for determining the accuracy, validity, and suitability of any content generated by the system for their intended purposes. Users should not rely on the system output as a source of truth or as a substitute for human judgment or expertise.
+
+This release only supports English language input and output. Users should not attempt to use the system with any other language or format. The system output may not be compatible with any translation tools or services, and may lose its meaning or coherence if translated.
+
+This release does not reflect the opinions, views, or values of Microsoft Corporation or any of its affiliates, subsidiaries, or partners. The system output is solely based on the system's own logic and algorithms, and does not represent any endorsement, recommendation, or advice from Microsoft or any other entity. Microsoft disclaims any liability or responsibility for any damages, losses, or harms arising from the use of this release or its output by any user or third party.
+
+This release does not provide any financial advice, and is not designed to replace the role of qualified client advisors in appropriately advising clients. Users should not use the system output for any financial decisions or transactions, and should consult with a professional financial advisor before taking any action based on the system output. Microsoft is not a financial institution or a fiduciary, and does not offer any financial products or services through this release or its output.
+
+This release is intended as a proof of concept only, and is not a finished or polished product. It is not intended for commercial use or distribution, and is subject to change or discontinuation without notice. Any planned deployment of this release or its output should include comprehensive testing and evaluation to ensure it is fit for purpose and meets the user's requirements and expectations. Microsoft does not guarantee the quality, performance, reliability, or availability of this release or its output, and does not provide any warranty or support for it.
+
+This Software requires the use of third-party components which are governed by separate proprietary or open-source licenses as identified below, and you must comply with the terms of each applicable license in order to use the Software. You acknowledge and agree that this license does not grant you a license or other right to use any such third-party proprietary or open-source components.
+
+To the extent that the Software includes components or code used in or derived from Microsoft products or services, including without limitation Microsoft Azure Services (collectively, “Microsoft Products and Services”), you must also comply with the Product Terms applicable to such Microsoft Products and Services. You acknowledge and agree that the license governing the Software does not grant you a license or other right to use Microsoft Products and Services. Nothing in the license or this ReadMe file will serve to supersede, amend, terminate or modify any terms in the Product Terms for any Microsoft Products and Services.
+
+You must also comply with all domestic and international export laws and regulations that apply to the Software, which include restrictions on destinations, end users, and end use. For further information on export restrictions, visit https://aka.ms/exporting.
+
+You acknowledge that the Software and Microsoft Products and Services (1) are not designed, intended or made available as a medical device(s), and (2) are not designed or intended to be a substitute for professional medical advice, diagnosis, treatment, or judgment and should not be used to replace or as a substitute for professional medical advice, diagnosis, treatment, or judgment. Customer is solely responsible for displaying and/or obtaining appropriate consents, warnings, disclaimers, and acknowledgements to end users of Customer’s implementation of the Online Services.
+
+You acknowledge the Software is not subject to SOC 1 and SOC 2 compliance audits. No Microsoft technology, nor any of its component technologies, including the Software, is intended or made available as a substitute for the professional advice, opinion, or judgment of a certified financial services professional. Do not use the Software to replace, substitute, or provide professional financial advice or judgment.
+
+BY ACCESSING OR USING THE SOFTWARE, YOU ACKNOWLEDGE THAT THE SOFTWARE IS NOT DESIGNED OR INTENDED TO SUPPORT ANY USE IN WHICH A SERVICE INTERRUPTION, DEFECT, ERROR, OR OTHER FAILURE OF THE SOFTWARE COULD RESULT IN THE DEATH OR SERIOUS BODILY INJURY OF ANY PERSON OR IN PHYSICAL OR ENVIRONMENTAL DAMAGE (COLLECTIVELY, “HIGH-RISK USE”), AND THAT YOU WILL ENSURE THAT, IN THE EVENT OF ANY INTERRUPTION, DEFECT, ERROR, OR OTHER FAILURE OF THE SOFTWARE, THE SAFETY OF PEOPLE, PROPERTY, AND THE ENVIRONMENT ARE NOT REDUCED BELOW A LEVEL THAT IS REASONABLY, APPROPRIATE, AND LEGAL, WHETHER IN GENERAL OR IN A SPECIFIC INDUSTRY. BY ACCESSING THE SOFTWARE, YOU FURTHER ACKNOWLEDGE THAT YOUR HIGH-RISK USE OF THE SOFTWARE IS AT YOUR OWN RISK.
diff --git a/archive-doc-gen/SECURITY.md b/archive-doc-gen/SECURITY.md
new file mode 100644
index 000000000..96d73bc27
--- /dev/null
+++ b/archive-doc-gen/SECURITY.md
@@ -0,0 +1,41 @@
+
+
+## Security
+
+Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet) and [Xamarin](https://github.com/xamarin).
+
+If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://aka.ms/security.md/definition), please report it to us as described below.
+
+## Reporting Security Issues
+
+**Please do not report security vulnerabilities through public GitHub issues.**
+
+Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://aka.ms/security.md/msrc/create-report).
+
+If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com). If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://aka.ms/security.md/msrc/pgp).
+
+You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc).
+
+Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
+
+ * Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
+ * Full paths of source file(s) related to the manifestation of the issue
+ * The location of the affected source code (tag/branch/commit or direct URL)
+ * Any special configuration required to reproduce the issue
+ * Step-by-step instructions to reproduce the issue
+ * Proof-of-concept or exploit code (if possible)
+ * Impact of the issue, including how an attacker might exploit the issue
+
+This information will help us triage your report more quickly.
+
+If you are reporting for a bug bounty, more complete reports can contribute to a higher bounty award. Please visit our [Microsoft Bug Bounty Program](https://aka.ms/security.md/msrc/bounty) page for more details about our active programs.
+
+## Preferred Languages
+
+We prefer all communications to be in English.
+
+## Policy
+
+Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://aka.ms/security.md/cvd).
+
+
\ No newline at end of file
diff --git a/archive-doc-gen/SUPPORT.md b/archive-doc-gen/SUPPORT.md
new file mode 100644
index 000000000..2c42db0f8
--- /dev/null
+++ b/archive-doc-gen/SUPPORT.md
@@ -0,0 +1,13 @@
+# Support
+
+## How to file issues and get help
+
+This project uses GitHub Issues to track bugs and feature requests. Please search the existing
+issues before filing new issues to avoid duplicates. For new issues, file your bug or
+feature request as a new Issue.
+
+For help and questions about using this project, please submit an issue on this repository.
+
+## Microsoft Support Policy
+
+Support for this repository is limited to the resources listed above.
\ No newline at end of file
diff --git a/app-azure.yaml b/archive-doc-gen/app-azure.yaml
similarity index 100%
rename from app-azure.yaml
rename to archive-doc-gen/app-azure.yaml
diff --git a/azure.yaml b/archive-doc-gen/azure.yaml
similarity index 100%
rename from azure.yaml
rename to archive-doc-gen/azure.yaml
diff --git a/archive-doc-gen/azure_custom.yaml b/archive-doc-gen/azure_custom.yaml
new file mode 100644
index 000000000..af8bae654
--- /dev/null
+++ b/archive-doc-gen/azure_custom.yaml
@@ -0,0 +1,48 @@
+environment:
+ name: document-generation
+ location: eastus
+
+name: document-generation
+metadata:
+ template: document-generation@1.0
+
+requiredVersions:
+ azd: '>= 1.18.0'
+
+parameters:
+ solutionPrefix:
+ type: string
+ default: bs-azdtest
+ otherLocation:
+ type: string
+ default: eastus2
+ baseUrl:
+ type: string
+ default: 'https://github.com/microsoft/document-generation-solution-accelerator'
+
+services:
+ webapp:
+ project: ./src
+ language: py
+ host: appservice
+ dist: ./dist
+ hooks:
+ prepackage:
+ windows:
+ shell: pwsh
+ run: ../infra/scripts/package_webapp.ps1
+ interactive: true
+ continueOnError: false
+ posix:
+ shell: sh
+ run: bash ../infra/scripts/package_webapp.sh
+ interactive: true
+ continueOnError: false
+
+deployment:
+ mode: Incremental
+ template: ./infra/main.bicep # Path to the main.bicep file inside the 'deployment' folder
+ parameters:
+ solutionPrefix: ${parameters.solutionPrefix}
+ otherLocation: ${parameters.otherLocation}
+ baseUrl: ${parameters.baseUrl}
diff --git a/docs/ACRBuildAndPushGuide.md b/archive-doc-gen/docs/ACRBuildAndPushGuide.md
similarity index 100%
rename from docs/ACRBuildAndPushGuide.md
rename to archive-doc-gen/docs/ACRBuildAndPushGuide.md
diff --git a/docs/AppAuthentication.md b/archive-doc-gen/docs/AppAuthentication.md
similarity index 100%
rename from docs/AppAuthentication.md
rename to archive-doc-gen/docs/AppAuthentication.md
diff --git a/docs/AzureAccountSetUp.md b/archive-doc-gen/docs/AzureAccountSetUp.md
similarity index 100%
rename from docs/AzureAccountSetUp.md
rename to archive-doc-gen/docs/AzureAccountSetUp.md
diff --git a/docs/AzureGPTQuotaSettings.md b/archive-doc-gen/docs/AzureGPTQuotaSettings.md
similarity index 100%
rename from docs/AzureGPTQuotaSettings.md
rename to archive-doc-gen/docs/AzureGPTQuotaSettings.md
diff --git a/docs/AzureSemanticSearchRegion.md b/archive-doc-gen/docs/AzureSemanticSearchRegion.md
similarity index 100%
rename from docs/AzureSemanticSearchRegion.md
rename to archive-doc-gen/docs/AzureSemanticSearchRegion.md
diff --git a/docs/CustomizingAzdParameters.md b/archive-doc-gen/docs/CustomizingAzdParameters.md
similarity index 100%
rename from docs/CustomizingAzdParameters.md
rename to archive-doc-gen/docs/CustomizingAzdParameters.md
diff --git a/docs/DeleteResourceGroup.md b/archive-doc-gen/docs/DeleteResourceGroup.md
similarity index 100%
rename from docs/DeleteResourceGroup.md
rename to archive-doc-gen/docs/DeleteResourceGroup.md
diff --git a/docs/DeploymentGuide.md b/archive-doc-gen/docs/DeploymentGuide.md
similarity index 96%
rename from docs/DeploymentGuide.md
rename to archive-doc-gen/docs/DeploymentGuide.md
index e04307df4..a6b4c2789 100644
--- a/docs/DeploymentGuide.md
+++ b/archive-doc-gen/docs/DeploymentGuide.md
@@ -117,7 +117,7 @@ Select one of the following options to deploy the Document Generation Solution A
Option C: Visual Studio Code Web
- [&message=Open&color=blue&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/azure/?vscode-azure-exp=foundry&agentPayload=eyJiYXNlVXJsIjogImh0dHBzOi8vcmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbS9taWNyb3NvZnQvZG9jdW1lbnQtZ2VuZXJhdGlvbi1zb2x1dGlvbi1hY2NlbGVyYXRvci9tYWluL2luZnJhL3ZzY29kZV93ZWIiLCAiaW5kZXhVcmwiOiAiL2luZGV4Lmpzb24iLCAidmFyaWFibGVzIjogeyJhZ2VudElkIjogIiIsICJjb25uZWN0aW9uU3RyaW5nIjogIiIsICJ0aHJlYWRJZCI6ICIiLCAidXNlck1lc3NhZ2UiOiAiIiwgInBsYXlncm91bmROYW1lIjogIiIsICJsb2NhdGlvbiI6ICIiLCAic3Vic2NyaXB0aW9uSWQiOiAiIiwgInJlc291cmNlSWQiOiAiIiwgInByb2plY3RSZXNvdXJjZUlkIjogIiIsICJlbmRwb2ludCI6ICIifSwgImNvZGVSb3V0ZSI6IFsiYWktcHJvamVjdHMtc2RrIiwgInB5dGhvbiIsICJkZWZhdWx0LWF6dXJlLWF1dGgiLCAiZW5kcG9pbnQiXX0=)
+ [&message=Open&color=blue&logo=visualstudiocode&logoColor=white)](https://vscode.dev/azure/?vscode-azure-exp=foundry&agentPayload=eyJiYXNlVXJsIjogImh0dHBzOi8vcmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbS9taWNyb3NvZnQvZG9jdW1lbnQtZ2VuZXJhdGlvbi1zb2x1dGlvbi1hY2NlbGVyYXRvci9yZWZzL2hlYWRzL21haW4vaW5mcmEvdnNjb2RlX3dlYiIsICJpbmRleFVybCI6ICIvaW5kZXguanNvbiIsICJ2YXJpYWJsZXMiOiB7ImFnZW50SWQiOiAiIiwgImNvbm5lY3Rpb25TdHJpbmciOiAiIiwgInRocmVhZElkIjogIiIsICJ1c2VyTWVzc2FnZSI6ICIiLCAicGxheWdyb3VuZE5hbWUiOiAiIiwgImxvY2F0aW9uIjogIiIsICJzdWJzY3JpcHRpb25JZCI6ICIiLCAicmVzb3VyY2VJZCI6ICIiLCAicHJvamVjdFJlc291cmNlSWQiOiAiIiwgImVuZHBvaW50IjogIiJ9LCAiY29kZVJvdXRlIjogWyJhaS1wcm9qZWN0cy1zZGsiLCAicHl0aG9uIiwgImRlZmF1bHQtYXp1cmUtYXV0aCIsICJlbmRwb2ludCJdfQ==)
1. Click the badge above (may take a few minutes to load)
2. Sign in with your Azure account when prompted
diff --git a/archive-doc-gen/docs/LocalDevelopmentSetup.md b/archive-doc-gen/docs/LocalDevelopmentSetup.md
new file mode 100644
index 000000000..4635b89e8
--- /dev/null
+++ b/archive-doc-gen/docs/LocalDevelopmentSetup.md
@@ -0,0 +1,506 @@
+# Local Development Setup Guide
+
+This guide provides comprehensive instructions for setting up the Document Generation Solution Accelerator for local development across Windows and Linux platforms.
+
+## Important Setup Notes
+
+### Multi-Service Architecture
+
+This application consists of **two separate services** that run independently:
+
+1. **Backend API** - REST API server for the frontend
+2. **Frontend** - React-based user interface
+
+> **⚠️ Critical: Each service must run in its own terminal/console window**
+>
+> - **Do NOT close terminals** while services are running
+> - Open **2 separate terminal windows** for local development
+> - Each service will occupy its terminal and show live logs
+
+
+### Path Conventions
+
+**All paths in this guide are relative to the repository root directory:**
+
+```bash
+document-generation-solution-accelerator/ ← Repository root (start here)
+├── src/
+│ ├── backend/
+│ │ ├── api/ ← API endpoints and routes
+│ │ ├── auth/ ← Authentication modules
+│ │ ├── helpers/ ← Utility and helper functions
+│ │ ├── history/ ← Chat/session history management
+│ │ ├── security/ ← Security-related modules
+│ │ └── settings.py ← Backend configuration
+│ ├── frontend/
+│ │ ├── src/ ← React/TypeScript source
+│ │ └── package.json ← Frontend dependencies
+│ ├── static/ ← Static web assets
+│ ├── tests/ ← Unit and integration tests
+│ ├── app.py ← Main Flask application entry point
+│ ├── .env ← Main application config file
+│ └── requirements.txt ← Python dependencies
+├── scripts/
+│ ├── prepdocs.py ← Document processing script
+│ ├── auth_init.py ← Authentication setup
+│ ├── data_preparation.py ← Data pipeline scripts
+│ └── config.json ← Scripts configuration
+├── infra/
+│ ├── main.bicep ← Main infrastructure template
+│ ├── scripts/ ← Infrastructure scripts
+│ └── main.parameters.json ← Deployment parameters
+├── docs/ ← Documentation (you are here)
+└── tests/ ← End-to-end tests
+ └── e2e-test/
+```
+
+**Before starting any step, ensure you are in the repository root directory:**
+
+```bash
+# Verify you're in the correct location
+pwd # Linux/macOS - should show: .../document-generation-solution-accelerator
+Get-Location # Windows PowerShell - should show: ...\document-generation-solution-accelerator
+
+# If not, navigate to repository root
+cd path/to/document-generation-solution-accelerator
+```
+
+## Step 1: Prerequisites - Install Required Tools
+
+Install these tools before you start:
+- [Visual Studio Code](https://code.visualstudio.com/) with the following extensions:
+ - [Azure Tools](https://marketplace.visualstudio.com/items?itemName=ms-vscode.vscode-node-azure-pack)
+ - [Bicep](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-bicep)
+ - [Python](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
+- [Python 3.11](https://www.python.org/downloads/). **Important:** Check "Add Python to PATH" during installation.
+- [PowerShell 7.0+](https://github.com/PowerShell/PowerShell#get-powershell).
+- [Node.js (LTS)](https://nodejs.org/en).
+- [Git](https://git-scm.com/downloads).
+- [Azure Developer CLI (azd) v1.18.0+](https://learn.microsoft.com/en-us/azure/developer/azure-developer-cli/install-azd).
+- [Microsoft ODBC Driver 17](https://learn.microsoft.com/en-us/sql/connect/odbc/download-odbc-driver-for-sql-server?view=sql-server-ver16) for SQL Server.
+
+
+### Windows Development
+
+#### Option 1: Native Windows (PowerShell)
+
+```powershell
+# Install Python 3.11+ and Git
+winget install Python.Python.3.11
+winget install Git.Git
+
+# Install Node.js for frontend
+winget install OpenJS.NodeJS.LTS
+
+# Install uv package manager
+py -3.11 -m pip install uv
+```
+
+**Note**: On Windows, use `py -3.11 -m uv` instead of `uv` for all commands to ensure you're using Python 3.11.
+
+#### Option 2: Windows with WSL2 (Recommended)
+
+```bash
+# Install WSL2 first (run in PowerShell as Administrator):
+# wsl --install -d Ubuntu
+
+# Then in WSL2 Ubuntu terminal:
+sudo apt update && sudo apt install python3.11 python3.11-venv git curl nodejs npm -y
+
+# Install uv
+curl -LsSf https://astral.sh/uv/install.sh | sh
+source ~/.bashrc
+```
+
+### Linux Development
+
+#### Ubuntu/Debian
+
+```bash
+# Install prerequisites
+sudo apt update && sudo apt install python3.11 python3.11-venv git curl nodejs npm -y
+
+# Install uv package manager
+curl -LsSf https://astral.sh/uv/install.sh | sh
+source ~/.bashrc
+```
+
+#### RHEL/CentOS/Fedora
+
+```bash
+# Install prerequisites
+sudo dnf install python3.11 python3.11-devel git curl gcc nodejs npm -y
+
+# Install uv
+curl -LsSf https://astral.sh/uv/install.sh | sh
+source ~/.bashrc
+```
+
+
+## Step 2: Clone the Repository
+
+Choose a location on your local machine where you want to store the project files. We recommend creating a dedicated folder for your development projects.
+
+#### Using Command Line/Terminal
+
+1. **Open your terminal or command prompt. Navigate to your desired directory and Clone the repository:**
+ ```bash
+ git clone https://github.com/microsoft/document-generation-solution-accelerator.git
+ ```
+
+2. **Navigate to the project directory:**
+ ```bash
+ cd document-generation-solution-accelerator
+ ```
+
+3. **Open the project in Visual Studio Code:**
+ ```bash
+ code .
+ ```
+
+
+## Step 3: Development Tools Setup
+
+### Visual Studio Code (Recommended)
+
+#### Required Extensions
+
+Create `.vscode/extensions.json` in the workspace root and copy the following JSON:
+
+```json
+{
+ "recommendations": [
+ "ms-python.python",
+ "ms-python.pylint",
+ "ms-python.black-formatter",
+ "ms-python.isort",
+ "ms-vscode-remote.remote-wsl",
+ "ms-vscode-remote.remote-containers",
+ "redhat.vscode-yaml",
+ "ms-vscode.azure-account",
+ "ms-python.mypy-type-checker"
+ ]
+}
+```
+
+VS Code will prompt you to install these recommended extensions when you open the workspace.
+
+#### Settings Configuration
+
+Create `.vscode/settings.json` and copy the following JSON:
+
+```json
+{
+ "python.defaultInterpreterPath": "./.venv/bin/python",
+ "python.terminal.activateEnvironment": true,
+ "python.formatting.provider": "black",
+ "python.linting.enabled": true,
+ "python.linting.pylintEnabled": true,
+ "python.testing.pytestEnabled": true,
+ "python.testing.unittestEnabled": false,
+ "files.associations": {
+ "*.yaml": "yaml",
+ "*.yml": "yaml"
+ }
+}
+```
+
+## Step 4: Azure Authentication Setup
+
+Before configuring services, authenticate with Azure:
+
+```bash
+# Login to Azure CLI
+az login
+
+# Set your subscription
+az account set --subscription "your-subscription-id"
+
+# Verify authentication
+az account show
+```
+
+## Step 5: Local Setup/Deployment
+
+Follow these steps to set up and run the application locally:
+
+## Local Deployment:
+
+You can refer the local deployment guide here: [Local Deployment Guide](https://github.com/microsoft/document-generation-solution-accelerator/blob/main/docs/DeploymentGuide.md)
+
+### 5.1. Open the App Folder
+Navigate to the `src` directory of the repository using Visual Studio Code.
+
+### 5.2. Configure Environment Variables
+- Copy the `.env.sample` file to a new file named `.env`.
+- Update the `.env` file with the required values from your Azure resource group in Azure Portal App Service environment variables.
+- You can get all env value in your deployed resource group under App Service:
+
+- Alternatively, if resources were
+provisioned using `azd provision` or `azd up`, a `.env` file is automatically generated in the `.azure//.env`
+file. To get your `` run `azd env list` to see which env is default.
+
+> **Note**: After adding all environment variables to the .env file, update the value of **'APP_ENV'** from:
+```
+APP_ENV="Prod"
+```
+**to:**
+```
+APP_ENV="Dev"
+```
+
+This change is required for running the application in local development mode.
+
+
+### 5.3. Required Azure RBAC Permissions
+
+To run the application locally, your Azure account needs the following role assignments on the deployed resources:
+
+#### 5.3.1. App Configuration Access
+```bash
+# Get your principal ID
+PRINCIPAL_ID=$(az ad signed-in-user show --query id -o tsv)
+
+# Assign App Configuration Data Reader role
+az role assignment create \
+ --assignee $PRINCIPAL_ID \
+ --role "App Configuration Data Reader" \
+ --scope "/subscriptions//resourceGroups//providers/Microsoft.AppConfiguration/configurationStores/"
+```
+
+#### 5.3.2. Cosmos DB Access
+```bash
+# Assign Cosmos DB Built-in Data Contributor role
+az cosmosdb sql role assignment create \
+ --account-name \
+ --resource-group \
+ --role-definition-name "Cosmos DB Built-in Data Contributor" \
+ --principal-id $PRINCIPAL_ID \
+ --scope "/"
+```
+> **Note**: After local deployment is complete, you need to execute the post-deployment script so that all the required roles will be assigned automatically.
+
+### 5.4. Running with Automated Script
+
+For convenience, you can use the provided startup scripts that handle environment setup and start both services:
+
+**Windows:**
+```cmd
+cd src
+.\start.cmd
+```
+
+**macOS/Linux:**
+```bash
+cd src
+chmod +x start.sh
+./start.sh
+```
+### 5.5. Start the Application
+- Run `start.cmd` (Windows) or `start.sh` (Linux/Mac) to:
+ - Install backend dependencies.
+ - Install frontend dependencies.
+ - Build the frontend.
+ - Start the backend server.
+- Alternatively, you can run the backend in debug mode using the VS Code debug configuration defined in `.vscode/launch.json`.
+
+
+## Step 6: Running Backend and Frontend Separately
+
+> **📋 Terminal Reminder**: This section requires **two separate terminal windows** - one for the Backend API and one for the Frontend. Keep both terminals open while running. All commands assume you start from the **repository root directory**.
+
+### 6.1. Create Virtual Environment (Recommended)
+
+Open your terminal and navigate to the root folder of the project, then create the virtual environment:
+
+```bash
+# Navigate to the project root folder
+cd document-generation-solution-accelerator
+
+# Create virtual environment in the root folder
+python -m venv .venv
+
+# Activate virtual environment (Windows)
+.venv/Scripts/activate
+
+# Activate virtual environment (macOS/Linux)
+source .venv/bin/activate
+```
+
+> **Note**: After activation, you should see `(.venv)` in your terminal prompt indicating the virtual environment is active.
+
+### 6.2. Install Dependencies and Run
+
+To develop and run the backend API locally:
+
+```bash
+# Navigate to the API folder (while virtual environment is activated)
+cd src/
+
+# Upgrade pip
+python -m pip install --upgrade pip
+
+# Install Python dependencies
+pip install -r requirements.txt
+
+# Install Frontend Packages
+cd frontend
+
+npm install
+npm run build
+
+# Run the backend API (Windows)
+cd ..
+
+start http://127.0.0.1:50505
+call python -m uvicorn app:app --port 50505 --reload
+
+# Run the backend API (MacOs)
+cd ..
+
+open http://127.0.0.1:50505
+python -m uvicorn app:app --port 50505 --reload
+
+# Run the backend API (Linux)
+cd ..
+
+xdg-open http://127.0.0.1:50505
+python -m uvicorn app:app --port 50505 --reload
+
+```
+
+> **Note**: Make sure your virtual environment is activated before running these commands. You should see `(.venv)` in your terminal prompt when the virtual environment is active.
+
+The App will run on `http://127.0.0.1:50505/#/` by default.
+
+## Step 7: Verify All Services Are Running
+
+Before using the application, confirm all services are running correctly:
+
+### 7.1. Terminal Status Checklist
+
+| Terminal | Service | Command | Expected Output | URL |
+|----------|---------|---------|-----------------|-----|
+| **Terminal 1** | Backend API | `python -m uvicorn app:app --port 50505 --reload` | `INFO: Application startup complete` | http://127.0.0.1:50505 |
+| **Terminal 2** | Frontend (Dev) | `npm run dev` | `Local: http://localhost:5173/` | http://localhost:5173 |
+
+### 7.2. Quick Verification
+
+**1. Check Backend API:**
+```bash
+# In a new terminal
+curl http://127.0.0.1:50505/health
+# Expected: {"status":"healthy"} or similar JSON response
+```
+
+**2. Check Frontend:**
+- Open browser to http://127.0.0.1:50505 (production build) or http://localhost:5173 (dev server)
+- Should see the Document Generation UI
+- If authentication is configured, you'll be redirected to Azure AD login
+
+### 7.3. Common Issues
+
+**Service not starting?**
+- Ensure you're in the correct directory (`src/` for backend)
+- Verify virtual environment is activated (you should see `(.venv)` in prompt)
+- Check that port is not already in use (50505 for API, 5173 for frontend dev)
+- Review error messages in the terminal
+
+**Can't access services?**
+- Verify firewall isn't blocking ports 50505 or 5173
+- Try `http://localhost:port` instead of `http://127.0.0.1:port`
+- Ensure services show "startup complete" messages
+
+## Step 8: Next Steps
+
+Once all services are running (as confirmed in Step 7), you can:
+
+1. **Access the Application**: Open `http://127.0.0.1:50505` in your browser to explore the Document Generation UI
+2. **Explore Sample Questions**: Follow [SampleQuestions.md](SampleQuestions.md) for example prompts and use cases
+3. **Understand the Architecture**: Review the codebase starting with `src/backend/` directory
+
+## Troubleshooting
+
+### Common Issues
+
+#### Python Version Issues
+
+```bash
+# Check available Python versions
+python3 --version
+python3.11 --version
+
+# If python3.11 not found, install it:
+# Ubuntu: sudo apt install python3.11
+# macOS: brew install python@3.11
+# Windows: winget install Python.Python.3.11
+```
+
+#### Virtual Environment Issues
+
+```bash
+# Recreate virtual environment
+rm -rf .venv # Linux/macOS
+# or Remove-Item -Recurse .venv # Windows PowerShell
+
+uv venv .venv
+# Activate and reinstall
+source .venv/bin/activate # Linux/macOS
+# or .\.venv\Scripts\Activate.ps1 # Windows
+uv sync --python 3.11
+```
+
+#### Permission Issues (Linux/macOS)
+
+```bash
+# Fix ownership of files
+sudo chown -R $USER:$USER .
+
+# Fix uv permissions
+chmod +x ~/.local/bin/uv
+```
+
+#### Windows-Specific Issues
+
+```powershell
+# PowerShell execution policy
+Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
+
+# Long path support (Windows 10 1607+, run as Administrator)
+New-ItemProperty -Path "HKLM:\SYSTEM\CurrentControlSet\Control\FileSystem" -Name "LongPathsEnabled" -Value 1 -PropertyType DWORD -Force
+
+# SSL certificate issues
+python -m pip install uv
+```
+
+### Azure Authentication Issues
+
+```bash
+# Login to Azure CLI
+az login
+
+# Set subscription
+az account set --subscription "your-subscription-id"
+
+# Test authentication
+az account show
+```
+
+### Environment Variable Issues
+
+```bash
+# Check environment variables are loaded
+env | grep AZURE # Linux/macOS
+Get-ChildItem Env:AZURE* # Windows PowerShell
+
+# Validate .env file format
+cat .env | grep -v '^#' | grep '=' # Should show key=value pairs
+```
+
+## Related Documentation
+
+- [Deployment Guide](DeploymentGuide.md) - Instructions for production deployment.
+- [Delete Resource Group](DeleteResourceGroup.md) - Steps to safely delete the Azure resource group created for the solution.
+- [App Authentication Setup](AppAuthentication.md) - Guide to configure application authentication and add support for additional platforms.
+- [Powershell Setup](PowershellSetup.md) - Instructions for setting up PowerShell and required scripts.
+- [Quota Check](QuotaCheck.md) - Steps to verify Azure quotas and ensure required limits before deployment.
diff --git a/archive-doc-gen/docs/LogAnalyticsReplicationDisable.md b/archive-doc-gen/docs/LogAnalyticsReplicationDisable.md
new file mode 100644
index 000000000..f4379a84a
--- /dev/null
+++ b/archive-doc-gen/docs/LogAnalyticsReplicationDisable.md
@@ -0,0 +1,28 @@
+# 🛠 Handling Log Analytics Workspace Deletion with Replication Enabled
+
+If redundancy (replication) is enabled for your Log Analytics workspace, you must disable it before deleting the workspace or resource group. Otherwise, deletion will fail.
+
+## ✅ Steps to Disable Replication Before Deletion
+Run the following Azure CLI command. Note: This operation may take about 5 minutes to complete.
+
+```bash
+az resource update --ids "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{logAnalyticsName}" --set properties.replication.enabled=false
+```
+
+Replace:
+- `{subscriptionId}` → Your Azure subscription ID
+- `{resourceGroupName}` → The name of your resource group
+- `{logAnalyticsName}` → The name of your Log Analytics workspace
+
+Optional: Verify replication disabled (should output `false`):
+```bash
+az resource show --ids "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{logAnalyticsName}" --query properties.replication.enabled -o tsv
+```
+
+## ✅ After Disabling Replication
+You can safely delete:
+- The Log Analytics workspace (manual)
+- The resource group (manual), or
+- All provisioned resources via `azd down`
+
+Return to: [Deployment Guide](./DeploymentGuide.md)
diff --git a/docs/PowershellSetup.md b/archive-doc-gen/docs/PowershellSetup.md
similarity index 100%
rename from docs/PowershellSetup.md
rename to archive-doc-gen/docs/PowershellSetup.md
diff --git a/docs/QuotaCheck.md b/archive-doc-gen/docs/QuotaCheck.md
similarity index 100%
rename from docs/QuotaCheck.md
rename to archive-doc-gen/docs/QuotaCheck.md
diff --git a/docs/README_LOCAL.md b/archive-doc-gen/docs/README_LOCAL.md
similarity index 100%
rename from docs/README_LOCAL.md
rename to archive-doc-gen/docs/README_LOCAL.md
diff --git a/docs/SampleQuestions.md b/archive-doc-gen/docs/SampleQuestions.md
similarity index 100%
rename from docs/SampleQuestions.md
rename to archive-doc-gen/docs/SampleQuestions.md
diff --git a/docs/TRANSPARENCY_FAQ.md b/archive-doc-gen/docs/TRANSPARENCY_FAQ.md
similarity index 100%
rename from docs/TRANSPARENCY_FAQ.md
rename to archive-doc-gen/docs/TRANSPARENCY_FAQ.md
diff --git a/docs/TroubleShootingSteps.md b/archive-doc-gen/docs/TroubleShootingSteps.md
similarity index 100%
rename from docs/TroubleShootingSteps.md
rename to archive-doc-gen/docs/TroubleShootingSteps.md
diff --git a/docs/container_registry_migration.md b/archive-doc-gen/docs/container_registry_migration.md
similarity index 100%
rename from docs/container_registry_migration.md
rename to archive-doc-gen/docs/container_registry_migration.md
diff --git a/docs/create_new_app_registration.md b/archive-doc-gen/docs/create_new_app_registration.md
similarity index 100%
rename from docs/create_new_app_registration.md
rename to archive-doc-gen/docs/create_new_app_registration.md
diff --git a/docs/images/AddDetails.png b/archive-doc-gen/docs/images/AddDetails.png
similarity index 100%
rename from docs/images/AddDetails.png
rename to archive-doc-gen/docs/images/AddDetails.png
diff --git a/docs/images/AddPlatform.png b/archive-doc-gen/docs/images/AddPlatform.png
similarity index 100%
rename from docs/images/AddPlatform.png
rename to archive-doc-gen/docs/images/AddPlatform.png
diff --git a/docs/images/AddRedirectURL.png b/archive-doc-gen/docs/images/AddRedirectURL.png
similarity index 100%
rename from docs/images/AddRedirectURL.png
rename to archive-doc-gen/docs/images/AddRedirectURL.png
diff --git a/docs/images/AppAuthIdentityProvider.png b/archive-doc-gen/docs/images/AppAuthIdentityProvider.png
similarity index 100%
rename from docs/images/AppAuthIdentityProvider.png
rename to archive-doc-gen/docs/images/AppAuthIdentityProvider.png
diff --git a/docs/images/AppAuthIdentityProviderAdd.png b/archive-doc-gen/docs/images/AppAuthIdentityProviderAdd.png
similarity index 100%
rename from docs/images/AppAuthIdentityProviderAdd.png
rename to archive-doc-gen/docs/images/AppAuthIdentityProviderAdd.png
diff --git a/docs/images/AppAuthIdentityProviderAdded.png b/archive-doc-gen/docs/images/AppAuthIdentityProviderAdded.png
similarity index 100%
rename from docs/images/AppAuthIdentityProviderAdded.png
rename to archive-doc-gen/docs/images/AppAuthIdentityProviderAdded.png
diff --git a/docs/images/AppAuthentication.png b/archive-doc-gen/docs/images/AppAuthentication.png
similarity index 100%
rename from docs/images/AppAuthentication.png
rename to archive-doc-gen/docs/images/AppAuthentication.png
diff --git a/docs/images/AppAuthenticationIdentity.png b/archive-doc-gen/docs/images/AppAuthenticationIdentity.png
similarity index 100%
rename from docs/images/AppAuthenticationIdentity.png
rename to archive-doc-gen/docs/images/AppAuthenticationIdentity.png
diff --git a/docs/images/AppServiceContainer.png b/archive-doc-gen/docs/images/AppServiceContainer.png
similarity index 100%
rename from docs/images/AppServiceContainer.png
rename to archive-doc-gen/docs/images/AppServiceContainer.png
diff --git a/docs/images/Appregistrations.png b/archive-doc-gen/docs/images/Appregistrations.png
similarity index 100%
rename from docs/images/Appregistrations.png
rename to archive-doc-gen/docs/images/Appregistrations.png
diff --git a/docs/images/Archimage.png b/archive-doc-gen/docs/images/Archimage.png
similarity index 100%
rename from docs/images/Archimage.png
rename to archive-doc-gen/docs/images/Archimage.png
diff --git a/docs/images/AzureHomePage.png b/archive-doc-gen/docs/images/AzureHomePage.png
similarity index 100%
rename from docs/images/AzureHomePage.png
rename to archive-doc-gen/docs/images/AzureHomePage.png
diff --git a/docs/images/ContainerApp.png b/archive-doc-gen/docs/images/ContainerApp.png
similarity index 100%
rename from docs/images/ContainerApp.png
rename to archive-doc-gen/docs/images/ContainerApp.png
diff --git a/docs/images/DeleteRG.png b/archive-doc-gen/docs/images/DeleteRG.png
similarity index 100%
rename from docs/images/DeleteRG.png
rename to archive-doc-gen/docs/images/DeleteRG.png
diff --git a/docs/images/DocGen_Azure_AI_Foundry_Architecture.png b/archive-doc-gen/docs/images/DocGen_Azure_AI_Foundry_Architecture.png
similarity index 100%
rename from docs/images/DocGen_Azure_AI_Foundry_Architecture.png
rename to archive-doc-gen/docs/images/DocGen_Azure_AI_Foundry_Architecture.png
diff --git a/archive-doc-gen/docs/images/Enviorment_variables.png b/archive-doc-gen/docs/images/Enviorment_variables.png
new file mode 100644
index 000000000..f5539fb1d
Binary files /dev/null and b/archive-doc-gen/docs/images/Enviorment_variables.png differ
diff --git a/docs/images/GenerateDraft.png b/archive-doc-gen/docs/images/GenerateDraft.png
similarity index 100%
rename from docs/images/GenerateDraft.png
rename to archive-doc-gen/docs/images/GenerateDraft.png
diff --git a/docs/images/MicrosoftEntraID.png b/archive-doc-gen/docs/images/MicrosoftEntraID.png
similarity index 100%
rename from docs/images/MicrosoftEntraID.png
rename to archive-doc-gen/docs/images/MicrosoftEntraID.png
diff --git a/docs/images/NewRegistration.png b/archive-doc-gen/docs/images/NewRegistration.png
similarity index 100%
rename from docs/images/NewRegistration.png
rename to archive-doc-gen/docs/images/NewRegistration.png
diff --git a/docs/images/Web.png b/archive-doc-gen/docs/images/Web.png
similarity index 100%
rename from docs/images/Web.png
rename to archive-doc-gen/docs/images/Web.png
diff --git a/docs/images/WebAppURL.png b/archive-doc-gen/docs/images/WebAppURL.png
similarity index 100%
rename from docs/images/WebAppURL.png
rename to archive-doc-gen/docs/images/WebAppURL.png
diff --git a/docs/images/architecture.png b/archive-doc-gen/docs/images/architecture.png
similarity index 100%
rename from docs/images/architecture.png
rename to archive-doc-gen/docs/images/architecture.png
diff --git a/docs/images/customerTruth.png b/archive-doc-gen/docs/images/customerTruth.png
similarity index 100%
rename from docs/images/customerTruth.png
rename to archive-doc-gen/docs/images/customerTruth.png
diff --git a/docs/images/deleteservices.png b/archive-doc-gen/docs/images/deleteservices.png
similarity index 100%
rename from docs/images/deleteservices.png
rename to archive-doc-gen/docs/images/deleteservices.png
diff --git a/docs/images/deployment_center.png b/archive-doc-gen/docs/images/deployment_center.png
similarity index 100%
rename from docs/images/deployment_center.png
rename to archive-doc-gen/docs/images/deployment_center.png
diff --git a/docs/images/git_bash.png b/archive-doc-gen/docs/images/git_bash.png
similarity index 100%
rename from docs/images/git_bash.png
rename to archive-doc-gen/docs/images/git_bash.png
diff --git a/docs/images/keyfeatures.png b/archive-doc-gen/docs/images/keyfeatures.png
similarity index 100%
rename from docs/images/keyfeatures.png
rename to archive-doc-gen/docs/images/keyfeatures.png
diff --git a/docs/images/landing_page.png b/archive-doc-gen/docs/images/landing_page.png
similarity index 100%
rename from docs/images/landing_page.png
rename to archive-doc-gen/docs/images/landing_page.png
diff --git a/docs/images/logAnalytics.png b/archive-doc-gen/docs/images/logAnalytics.png
similarity index 100%
rename from docs/images/logAnalytics.png
rename to archive-doc-gen/docs/images/logAnalytics.png
diff --git a/docs/images/logAnalyticsJson.png b/archive-doc-gen/docs/images/logAnalyticsJson.png
similarity index 100%
rename from docs/images/logAnalyticsJson.png
rename to archive-doc-gen/docs/images/logAnalyticsJson.png
diff --git a/docs/images/logAnalyticsList.png b/archive-doc-gen/docs/images/logAnalyticsList.png
similarity index 100%
rename from docs/images/logAnalyticsList.png
rename to archive-doc-gen/docs/images/logAnalyticsList.png
diff --git a/docs/images/oneClickDeploy.png b/archive-doc-gen/docs/images/oneClickDeploy.png
similarity index 100%
rename from docs/images/oneClickDeploy.png
rename to archive-doc-gen/docs/images/oneClickDeploy.png
diff --git a/docs/images/quota-check-output.png b/archive-doc-gen/docs/images/quota-check-output.png
similarity index 100%
rename from docs/images/quota-check-output.png
rename to archive-doc-gen/docs/images/quota-check-output.png
diff --git a/docs/images/re_use_foundry_project/azure_ai_foundry_list.png b/archive-doc-gen/docs/images/re_use_foundry_project/azure_ai_foundry_list.png
similarity index 100%
rename from docs/images/re_use_foundry_project/azure_ai_foundry_list.png
rename to archive-doc-gen/docs/images/re_use_foundry_project/azure_ai_foundry_list.png
diff --git a/docs/images/re_use_foundry_project/navigate_to_projects.png b/archive-doc-gen/docs/images/re_use_foundry_project/navigate_to_projects.png
similarity index 100%
rename from docs/images/re_use_foundry_project/navigate_to_projects.png
rename to archive-doc-gen/docs/images/re_use_foundry_project/navigate_to_projects.png
diff --git a/docs/images/re_use_foundry_project/project_resource_id.png b/archive-doc-gen/docs/images/re_use_foundry_project/project_resource_id.png
similarity index 100%
rename from docs/images/re_use_foundry_project/project_resource_id.png
rename to archive-doc-gen/docs/images/re_use_foundry_project/project_resource_id.png
diff --git a/docs/images/re_use_log/logAnalytics.png b/archive-doc-gen/docs/images/re_use_log/logAnalytics.png
similarity index 100%
rename from docs/images/re_use_log/logAnalytics.png
rename to archive-doc-gen/docs/images/re_use_log/logAnalytics.png
diff --git a/docs/images/re_use_log/logAnalyticsJson.png b/archive-doc-gen/docs/images/re_use_log/logAnalyticsJson.png
similarity index 100%
rename from docs/images/re_use_log/logAnalyticsJson.png
rename to archive-doc-gen/docs/images/re_use_log/logAnalyticsJson.png
diff --git a/docs/images/re_use_log/logAnalyticsList.png b/archive-doc-gen/docs/images/re_use_log/logAnalyticsList.png
similarity index 100%
rename from docs/images/re_use_log/logAnalyticsList.png
rename to archive-doc-gen/docs/images/re_use_log/logAnalyticsList.png
diff --git a/docs/images/readme/business-scenario.png b/archive-doc-gen/docs/images/readme/business-scenario.png
similarity index 100%
rename from docs/images/readme/business-scenario.png
rename to archive-doc-gen/docs/images/readme/business-scenario.png
diff --git a/docs/images/readme/quick-deploy.png b/archive-doc-gen/docs/images/readme/quick-deploy.png
similarity index 100%
rename from docs/images/readme/quick-deploy.png
rename to archive-doc-gen/docs/images/readme/quick-deploy.png
diff --git a/docs/images/readme/solution-overview.png b/archive-doc-gen/docs/images/readme/solution-overview.png
similarity index 100%
rename from docs/images/readme/solution-overview.png
rename to archive-doc-gen/docs/images/readme/solution-overview.png
diff --git a/docs/images/readme/supporting-documentation.png b/archive-doc-gen/docs/images/readme/supporting-documentation.png
similarity index 100%
rename from docs/images/readme/supporting-documentation.png
rename to archive-doc-gen/docs/images/readme/supporting-documentation.png
diff --git a/docs/images/resource-groups.png b/archive-doc-gen/docs/images/resource-groups.png
similarity index 100%
rename from docs/images/resource-groups.png
rename to archive-doc-gen/docs/images/resource-groups.png
diff --git a/docs/images/resource_menu.png b/archive-doc-gen/docs/images/resource_menu.png
similarity index 100%
rename from docs/images/resource_menu.png
rename to archive-doc-gen/docs/images/resource_menu.png
diff --git a/docs/images/resourcegroup.png b/archive-doc-gen/docs/images/resourcegroup.png
similarity index 100%
rename from docs/images/resourcegroup.png
rename to archive-doc-gen/docs/images/resourcegroup.png
diff --git a/docs/images/resourcegroup1.png b/archive-doc-gen/docs/images/resourcegroup1.png
similarity index 100%
rename from docs/images/resourcegroup1.png
rename to archive-doc-gen/docs/images/resourcegroup1.png
diff --git a/docs/images/supportingDocuments.png b/archive-doc-gen/docs/images/supportingDocuments.png
similarity index 100%
rename from docs/images/supportingDocuments.png
rename to archive-doc-gen/docs/images/supportingDocuments.png
diff --git a/docs/images/userStory.png b/archive-doc-gen/docs/images/userStory.png
similarity index 100%
rename from docs/images/userStory.png
rename to archive-doc-gen/docs/images/userStory.png
diff --git a/docs/re-use-foundry-project.md b/archive-doc-gen/docs/re-use-foundry-project.md
similarity index 100%
rename from docs/re-use-foundry-project.md
rename to archive-doc-gen/docs/re-use-foundry-project.md
diff --git a/docs/re-use-log-analytics.md b/archive-doc-gen/docs/re-use-log-analytics.md
similarity index 100%
rename from docs/re-use-log-analytics.md
rename to archive-doc-gen/docs/re-use-log-analytics.md
diff --git a/infra/data/pdfdata.zip b/archive-doc-gen/infra/data/pdfdata.zip
similarity index 100%
rename from infra/data/pdfdata.zip
rename to archive-doc-gen/infra/data/pdfdata.zip
diff --git a/infra/main.bicep b/archive-doc-gen/infra/main.bicep
similarity index 100%
rename from infra/main.bicep
rename to archive-doc-gen/infra/main.bicep
diff --git a/infra/main.json b/archive-doc-gen/infra/main.json
similarity index 100%
rename from infra/main.json
rename to archive-doc-gen/infra/main.json
diff --git a/infra/main.parameters.json b/archive-doc-gen/infra/main.parameters.json
similarity index 100%
rename from infra/main.parameters.json
rename to archive-doc-gen/infra/main.parameters.json
diff --git a/infra/main.waf.parameters.json b/archive-doc-gen/infra/main.waf.parameters.json
similarity index 100%
rename from infra/main.waf.parameters.json
rename to archive-doc-gen/infra/main.waf.parameters.json
diff --git a/infra/main_custom.bicep b/archive-doc-gen/infra/main_custom.bicep
similarity index 100%
rename from infra/main_custom.bicep
rename to archive-doc-gen/infra/main_custom.bicep
diff --git a/infra/modules/ai-project.bicep b/archive-doc-gen/infra/modules/ai-project.bicep
similarity index 100%
rename from infra/modules/ai-project.bicep
rename to archive-doc-gen/infra/modules/ai-project.bicep
diff --git a/infra/modules/ai-services-deployments.bicep b/archive-doc-gen/infra/modules/ai-services-deployments.bicep
similarity index 100%
rename from infra/modules/ai-services-deployments.bicep
rename to archive-doc-gen/infra/modules/ai-services-deployments.bicep
diff --git a/infra/modules/deploy_aifp_aisearch_connection.bicep b/archive-doc-gen/infra/modules/deploy_aifp_aisearch_connection.bicep
similarity index 100%
rename from infra/modules/deploy_aifp_aisearch_connection.bicep
rename to archive-doc-gen/infra/modules/deploy_aifp_aisearch_connection.bicep
diff --git a/infra/modules/role-assignment.bicep b/archive-doc-gen/infra/modules/role-assignment.bicep
similarity index 100%
rename from infra/modules/role-assignment.bicep
rename to archive-doc-gen/infra/modules/role-assignment.bicep
diff --git a/infra/modules/virtualNetwork.bicep b/archive-doc-gen/infra/modules/virtualNetwork.bicep
similarity index 100%
rename from infra/modules/virtualNetwork.bicep
rename to archive-doc-gen/infra/modules/virtualNetwork.bicep
diff --git a/infra/modules/web-sites.bicep b/archive-doc-gen/infra/modules/web-sites.bicep
similarity index 100%
rename from infra/modules/web-sites.bicep
rename to archive-doc-gen/infra/modules/web-sites.bicep
diff --git a/infra/modules/web-sites.config.bicep b/archive-doc-gen/infra/modules/web-sites.config.bicep
similarity index 100%
rename from infra/modules/web-sites.config.bicep
rename to archive-doc-gen/infra/modules/web-sites.config.bicep
diff --git a/infra/scripts/add_cosmosdb_access.sh b/archive-doc-gen/infra/scripts/add_cosmosdb_access.sh
similarity index 100%
rename from infra/scripts/add_cosmosdb_access.sh
rename to archive-doc-gen/infra/scripts/add_cosmosdb_access.sh
diff --git a/infra/scripts/copy_kb_files.sh b/archive-doc-gen/infra/scripts/copy_kb_files.sh
similarity index 100%
rename from infra/scripts/copy_kb_files.sh
rename to archive-doc-gen/infra/scripts/copy_kb_files.sh
diff --git a/infra/scripts/index_scripts/01_create_search_index.py b/archive-doc-gen/infra/scripts/index_scripts/01_create_search_index.py
similarity index 100%
rename from infra/scripts/index_scripts/01_create_search_index.py
rename to archive-doc-gen/infra/scripts/index_scripts/01_create_search_index.py
diff --git a/infra/scripts/index_scripts/02_process_data.py b/archive-doc-gen/infra/scripts/index_scripts/02_process_data.py
similarity index 100%
rename from infra/scripts/index_scripts/02_process_data.py
rename to archive-doc-gen/infra/scripts/index_scripts/02_process_data.py
diff --git a/infra/scripts/index_scripts/requirements.txt b/archive-doc-gen/infra/scripts/index_scripts/requirements.txt
similarity index 100%
rename from infra/scripts/index_scripts/requirements.txt
rename to archive-doc-gen/infra/scripts/index_scripts/requirements.txt
diff --git a/infra/scripts/package_webapp.ps1 b/archive-doc-gen/infra/scripts/package_webapp.ps1
similarity index 100%
rename from infra/scripts/package_webapp.ps1
rename to archive-doc-gen/infra/scripts/package_webapp.ps1
diff --git a/infra/scripts/package_webapp.sh b/archive-doc-gen/infra/scripts/package_webapp.sh
similarity index 100%
rename from infra/scripts/package_webapp.sh
rename to archive-doc-gen/infra/scripts/package_webapp.sh
diff --git a/infra/scripts/process_sample_data.sh b/archive-doc-gen/infra/scripts/process_sample_data.sh
similarity index 100%
rename from infra/scripts/process_sample_data.sh
rename to archive-doc-gen/infra/scripts/process_sample_data.sh
diff --git a/infra/scripts/run_create_index_scripts.sh b/archive-doc-gen/infra/scripts/run_create_index_scripts.sh
similarity index 100%
rename from infra/scripts/run_create_index_scripts.sh
rename to archive-doc-gen/infra/scripts/run_create_index_scripts.sh
diff --git a/infra/vscode_web/.gitignore b/archive-doc-gen/infra/vscode_web/.gitignore
similarity index 100%
rename from infra/vscode_web/.gitignore
rename to archive-doc-gen/infra/vscode_web/.gitignore
diff --git a/infra/vscode_web/LICENSE b/archive-doc-gen/infra/vscode_web/LICENSE
similarity index 100%
rename from infra/vscode_web/LICENSE
rename to archive-doc-gen/infra/vscode_web/LICENSE
diff --git a/infra/vscode_web/README-noazd.md b/archive-doc-gen/infra/vscode_web/README-noazd.md
similarity index 100%
rename from infra/vscode_web/README-noazd.md
rename to archive-doc-gen/infra/vscode_web/README-noazd.md
diff --git a/infra/vscode_web/README.md b/archive-doc-gen/infra/vscode_web/README.md
similarity index 100%
rename from infra/vscode_web/README.md
rename to archive-doc-gen/infra/vscode_web/README.md
diff --git a/infra/vscode_web/codeSample.py b/archive-doc-gen/infra/vscode_web/codeSample.py
similarity index 100%
rename from infra/vscode_web/codeSample.py
rename to archive-doc-gen/infra/vscode_web/codeSample.py
diff --git a/infra/vscode_web/endpoint-requirements.txt b/archive-doc-gen/infra/vscode_web/endpoint-requirements.txt
similarity index 100%
rename from infra/vscode_web/endpoint-requirements.txt
rename to archive-doc-gen/infra/vscode_web/endpoint-requirements.txt
diff --git a/infra/vscode_web/endpointCodeSample.py b/archive-doc-gen/infra/vscode_web/endpointCodeSample.py
similarity index 100%
rename from infra/vscode_web/endpointCodeSample.py
rename to archive-doc-gen/infra/vscode_web/endpointCodeSample.py
diff --git a/infra/vscode_web/index.json b/archive-doc-gen/infra/vscode_web/index.json
similarity index 100%
rename from infra/vscode_web/index.json
rename to archive-doc-gen/infra/vscode_web/index.json
diff --git a/infra/vscode_web/install.sh b/archive-doc-gen/infra/vscode_web/install.sh
similarity index 100%
rename from infra/vscode_web/install.sh
rename to archive-doc-gen/infra/vscode_web/install.sh
diff --git a/infra/vscode_web/requirements.txt b/archive-doc-gen/infra/vscode_web/requirements.txt
similarity index 100%
rename from infra/vscode_web/requirements.txt
rename to archive-doc-gen/infra/vscode_web/requirements.txt
diff --git a/package-lock.json b/archive-doc-gen/package-lock.json
similarity index 100%
rename from package-lock.json
rename to archive-doc-gen/package-lock.json
diff --git a/scripts/SAMPLE_DATA.md b/archive-doc-gen/scripts/SAMPLE_DATA.md
similarity index 100%
rename from scripts/SAMPLE_DATA.md
rename to archive-doc-gen/scripts/SAMPLE_DATA.md
diff --git a/scripts/auth_init.ps1 b/archive-doc-gen/scripts/auth_init.ps1
similarity index 100%
rename from scripts/auth_init.ps1
rename to archive-doc-gen/scripts/auth_init.ps1
diff --git a/scripts/auth_init.py b/archive-doc-gen/scripts/auth_init.py
similarity index 100%
rename from scripts/auth_init.py
rename to archive-doc-gen/scripts/auth_init.py
diff --git a/scripts/auth_init.sh b/archive-doc-gen/scripts/auth_init.sh
similarity index 100%
rename from scripts/auth_init.sh
rename to archive-doc-gen/scripts/auth_init.sh
diff --git a/scripts/auth_update.ps1 b/archive-doc-gen/scripts/auth_update.ps1
similarity index 100%
rename from scripts/auth_update.ps1
rename to archive-doc-gen/scripts/auth_update.ps1
diff --git a/scripts/auth_update.py b/archive-doc-gen/scripts/auth_update.py
similarity index 100%
rename from scripts/auth_update.py
rename to archive-doc-gen/scripts/auth_update.py
diff --git a/scripts/auth_update.sh b/archive-doc-gen/scripts/auth_update.sh
similarity index 100%
rename from scripts/auth_update.sh
rename to archive-doc-gen/scripts/auth_update.sh
diff --git a/scripts/checkquota.sh b/archive-doc-gen/scripts/checkquota.sh
similarity index 100%
rename from scripts/checkquota.sh
rename to archive-doc-gen/scripts/checkquota.sh
diff --git a/scripts/chunk_documents.py b/archive-doc-gen/scripts/chunk_documents.py
similarity index 100%
rename from scripts/chunk_documents.py
rename to archive-doc-gen/scripts/chunk_documents.py
diff --git a/scripts/config.json b/archive-doc-gen/scripts/config.json
similarity index 100%
rename from scripts/config.json
rename to archive-doc-gen/scripts/config.json
diff --git a/scripts/data_preparation.py b/archive-doc-gen/scripts/data_preparation.py
similarity index 100%
rename from scripts/data_preparation.py
rename to archive-doc-gen/scripts/data_preparation.py
diff --git a/scripts/data_utils.py b/archive-doc-gen/scripts/data_utils.py
similarity index 100%
rename from scripts/data_utils.py
rename to archive-doc-gen/scripts/data_utils.py
diff --git a/scripts/embed_documents.py b/archive-doc-gen/scripts/embed_documents.py
similarity index 100%
rename from scripts/embed_documents.py
rename to archive-doc-gen/scripts/embed_documents.py
diff --git a/scripts/loadenv.ps1 b/archive-doc-gen/scripts/loadenv.ps1
similarity index 100%
rename from scripts/loadenv.ps1
rename to archive-doc-gen/scripts/loadenv.ps1
diff --git a/scripts/loadenv.sh b/archive-doc-gen/scripts/loadenv.sh
similarity index 100%
rename from scripts/loadenv.sh
rename to archive-doc-gen/scripts/loadenv.sh
diff --git a/scripts/prepdocs.ps1 b/archive-doc-gen/scripts/prepdocs.ps1
similarity index 100%
rename from scripts/prepdocs.ps1
rename to archive-doc-gen/scripts/prepdocs.ps1
diff --git a/scripts/prepdocs.py b/archive-doc-gen/scripts/prepdocs.py
similarity index 100%
rename from scripts/prepdocs.py
rename to archive-doc-gen/scripts/prepdocs.py
diff --git a/scripts/prepdocs.sh b/archive-doc-gen/scripts/prepdocs.sh
similarity index 100%
rename from scripts/prepdocs.sh
rename to archive-doc-gen/scripts/prepdocs.sh
diff --git a/scripts/quota_check_params.sh b/archive-doc-gen/scripts/quota_check_params.sh
similarity index 100%
rename from scripts/quota_check_params.sh
rename to archive-doc-gen/scripts/quota_check_params.sh
diff --git a/scripts/readme.md b/archive-doc-gen/scripts/readme.md
similarity index 100%
rename from scripts/readme.md
rename to archive-doc-gen/scripts/readme.md
diff --git a/scripts/role_assignment.sh b/archive-doc-gen/scripts/role_assignment.sh
similarity index 100%
rename from scripts/role_assignment.sh
rename to archive-doc-gen/scripts/role_assignment.sh
diff --git a/src/.dockerignore b/archive-doc-gen/src/.dockerignore
similarity index 100%
rename from src/.dockerignore
rename to archive-doc-gen/src/.dockerignore
diff --git a/src/.env.sample b/archive-doc-gen/src/.env.sample
similarity index 100%
rename from src/.env.sample
rename to archive-doc-gen/src/.env.sample
diff --git a/src/.gitignore b/archive-doc-gen/src/.gitignore
similarity index 100%
rename from src/.gitignore
rename to archive-doc-gen/src/.gitignore
diff --git a/src/SUPPORT.md b/archive-doc-gen/src/SUPPORT.md
similarity index 100%
rename from src/SUPPORT.md
rename to archive-doc-gen/src/SUPPORT.md
diff --git a/src/TEST_CASE_FLOWS.md b/archive-doc-gen/src/TEST_CASE_FLOWS.md
similarity index 100%
rename from src/TEST_CASE_FLOWS.md
rename to archive-doc-gen/src/TEST_CASE_FLOWS.md
diff --git a/src/WebApp.Dockerfile b/archive-doc-gen/src/WebApp.Dockerfile
similarity index 100%
rename from src/WebApp.Dockerfile
rename to archive-doc-gen/src/WebApp.Dockerfile
diff --git a/src/app.py b/archive-doc-gen/src/app.py
similarity index 100%
rename from src/app.py
rename to archive-doc-gen/src/app.py
diff --git a/src/backend/__init__.py b/archive-doc-gen/src/backend/__init__.py
similarity index 100%
rename from src/backend/__init__.py
rename to archive-doc-gen/src/backend/__init__.py
diff --git a/src/backend/api/agent/agent_factory_base.py b/archive-doc-gen/src/backend/api/agent/agent_factory_base.py
similarity index 100%
rename from src/backend/api/agent/agent_factory_base.py
rename to archive-doc-gen/src/backend/api/agent/agent_factory_base.py
diff --git a/src/backend/api/agent/browse_agent_factory.py b/archive-doc-gen/src/backend/api/agent/browse_agent_factory.py
similarity index 100%
rename from src/backend/api/agent/browse_agent_factory.py
rename to archive-doc-gen/src/backend/api/agent/browse_agent_factory.py
diff --git a/src/backend/api/agent/section_agent_factory.py b/archive-doc-gen/src/backend/api/agent/section_agent_factory.py
similarity index 100%
rename from src/backend/api/agent/section_agent_factory.py
rename to archive-doc-gen/src/backend/api/agent/section_agent_factory.py
diff --git a/src/backend/api/agent/template_agent_factory.py b/archive-doc-gen/src/backend/api/agent/template_agent_factory.py
similarity index 100%
rename from src/backend/api/agent/template_agent_factory.py
rename to archive-doc-gen/src/backend/api/agent/template_agent_factory.py
diff --git a/src/backend/auth/__init__.py b/archive-doc-gen/src/backend/auth/__init__.py
similarity index 100%
rename from src/backend/auth/__init__.py
rename to archive-doc-gen/src/backend/auth/__init__.py
diff --git a/src/backend/auth/auth_utils.py b/archive-doc-gen/src/backend/auth/auth_utils.py
similarity index 100%
rename from src/backend/auth/auth_utils.py
rename to archive-doc-gen/src/backend/auth/auth_utils.py
diff --git a/src/backend/auth/sample_user.py b/archive-doc-gen/src/backend/auth/sample_user.py
similarity index 100%
rename from src/backend/auth/sample_user.py
rename to archive-doc-gen/src/backend/auth/sample_user.py
diff --git a/src/backend/helpers/azure_credential_utils.py b/archive-doc-gen/src/backend/helpers/azure_credential_utils.py
similarity index 100%
rename from src/backend/helpers/azure_credential_utils.py
rename to archive-doc-gen/src/backend/helpers/azure_credential_utils.py
diff --git a/src/backend/history/cosmosdbservice.py b/archive-doc-gen/src/backend/history/cosmosdbservice.py
similarity index 100%
rename from src/backend/history/cosmosdbservice.py
rename to archive-doc-gen/src/backend/history/cosmosdbservice.py
diff --git a/src/backend/security/__init__.py b/archive-doc-gen/src/backend/security/__init__.py
similarity index 100%
rename from src/backend/security/__init__.py
rename to archive-doc-gen/src/backend/security/__init__.py
diff --git a/src/backend/security/ms_defender_utils.py b/archive-doc-gen/src/backend/security/ms_defender_utils.py
similarity index 100%
rename from src/backend/security/ms_defender_utils.py
rename to archive-doc-gen/src/backend/security/ms_defender_utils.py
diff --git a/src/backend/settings.py b/archive-doc-gen/src/backend/settings.py
similarity index 100%
rename from src/backend/settings.py
rename to archive-doc-gen/src/backend/settings.py
diff --git a/src/backend/utils.py b/archive-doc-gen/src/backend/utils.py
similarity index 100%
rename from src/backend/utils.py
rename to archive-doc-gen/src/backend/utils.py
diff --git a/src/event_utils.py b/archive-doc-gen/src/event_utils.py
similarity index 100%
rename from src/event_utils.py
rename to archive-doc-gen/src/event_utils.py
diff --git a/src/frontend/.eslintignore b/archive-doc-gen/src/frontend/.eslintignore
similarity index 100%
rename from src/frontend/.eslintignore
rename to archive-doc-gen/src/frontend/.eslintignore
diff --git a/src/frontend/.eslintrc.json b/archive-doc-gen/src/frontend/.eslintrc.json
similarity index 100%
rename from src/frontend/.eslintrc.json
rename to archive-doc-gen/src/frontend/.eslintrc.json
diff --git a/src/frontend/.prettierignore b/archive-doc-gen/src/frontend/.prettierignore
similarity index 100%
rename from src/frontend/.prettierignore
rename to archive-doc-gen/src/frontend/.prettierignore
diff --git a/src/frontend/.prettierrc.json b/archive-doc-gen/src/frontend/.prettierrc.json
similarity index 100%
rename from src/frontend/.prettierrc.json
rename to archive-doc-gen/src/frontend/.prettierrc.json
diff --git a/src/frontend/__mocks__/dompurify.ts b/archive-doc-gen/src/frontend/__mocks__/dompurify.ts
similarity index 100%
rename from src/frontend/__mocks__/dompurify.ts
rename to archive-doc-gen/src/frontend/__mocks__/dompurify.ts
diff --git a/src/frontend/__mocks__/fileMock.ts b/archive-doc-gen/src/frontend/__mocks__/fileMock.ts
similarity index 100%
rename from src/frontend/__mocks__/fileMock.ts
rename to archive-doc-gen/src/frontend/__mocks__/fileMock.ts
diff --git a/src/frontend/__mocks__/mockAPIData.ts b/archive-doc-gen/src/frontend/__mocks__/mockAPIData.ts
similarity index 100%
rename from src/frontend/__mocks__/mockAPIData.ts
rename to archive-doc-gen/src/frontend/__mocks__/mockAPIData.ts
diff --git a/src/frontend/__mocks__/react-markdown.tsx b/archive-doc-gen/src/frontend/__mocks__/react-markdown.tsx
similarity index 100%
rename from src/frontend/__mocks__/react-markdown.tsx
rename to archive-doc-gen/src/frontend/__mocks__/react-markdown.tsx
diff --git a/src/frontend/eslint.config.ts b/archive-doc-gen/src/frontend/eslint.config.ts
similarity index 100%
rename from src/frontend/eslint.config.ts
rename to archive-doc-gen/src/frontend/eslint.config.ts
diff --git a/src/frontend/index.html b/archive-doc-gen/src/frontend/index.html
similarity index 100%
rename from src/frontend/index.html
rename to archive-doc-gen/src/frontend/index.html
diff --git a/src/frontend/jest.config.ts b/archive-doc-gen/src/frontend/jest.config.ts
similarity index 100%
rename from src/frontend/jest.config.ts
rename to archive-doc-gen/src/frontend/jest.config.ts
diff --git a/src/frontend/jest.polyfills.js b/archive-doc-gen/src/frontend/jest.polyfills.js
similarity index 100%
rename from src/frontend/jest.polyfills.js
rename to archive-doc-gen/src/frontend/jest.polyfills.js
diff --git a/src/frontend/package-lock.json b/archive-doc-gen/src/frontend/package-lock.json
similarity index 100%
rename from src/frontend/package-lock.json
rename to archive-doc-gen/src/frontend/package-lock.json
diff --git a/src/frontend/package.json b/archive-doc-gen/src/frontend/package.json
similarity index 100%
rename from src/frontend/package.json
rename to archive-doc-gen/src/frontend/package.json
diff --git a/src/frontend/polyfills.js b/archive-doc-gen/src/frontend/polyfills.js
similarity index 100%
rename from src/frontend/polyfills.js
rename to archive-doc-gen/src/frontend/polyfills.js
diff --git a/src/frontend/public/favicon.ico b/archive-doc-gen/src/frontend/public/favicon.ico
similarity index 100%
rename from src/frontend/public/favicon.ico
rename to archive-doc-gen/src/frontend/public/favicon.ico
diff --git a/src/frontend/src/api/api.ts b/archive-doc-gen/src/frontend/src/api/api.ts
similarity index 100%
rename from src/frontend/src/api/api.ts
rename to archive-doc-gen/src/frontend/src/api/api.ts
diff --git a/src/frontend/src/api/index.ts b/archive-doc-gen/src/frontend/src/api/index.ts
similarity index 100%
rename from src/frontend/src/api/index.ts
rename to archive-doc-gen/src/frontend/src/api/index.ts
diff --git a/src/frontend/src/api/models.ts b/archive-doc-gen/src/frontend/src/api/models.ts
similarity index 100%
rename from src/frontend/src/api/models.ts
rename to archive-doc-gen/src/frontend/src/api/models.ts
diff --git a/src/frontend/src/assets/Azure.svg b/archive-doc-gen/src/frontend/src/assets/Azure.svg
similarity index 100%
rename from src/frontend/src/assets/Azure.svg
rename to archive-doc-gen/src/frontend/src/assets/Azure.svg
diff --git a/src/frontend/src/assets/ClearChat.svg b/archive-doc-gen/src/frontend/src/assets/ClearChat.svg
similarity index 100%
rename from src/frontend/src/assets/ClearChat.svg
rename to archive-doc-gen/src/frontend/src/assets/ClearChat.svg
diff --git a/src/frontend/src/assets/Contoso.svg b/archive-doc-gen/src/frontend/src/assets/Contoso.svg
similarity index 100%
rename from src/frontend/src/assets/Contoso.svg
rename to archive-doc-gen/src/frontend/src/assets/Contoso.svg
diff --git a/src/frontend/src/assets/Generate.svg b/archive-doc-gen/src/frontend/src/assets/Generate.svg
similarity index 100%
rename from src/frontend/src/assets/Generate.svg
rename to archive-doc-gen/src/frontend/src/assets/Generate.svg
diff --git a/src/frontend/src/assets/Send.svg b/archive-doc-gen/src/frontend/src/assets/Send.svg
similarity index 100%
rename from src/frontend/src/assets/Send.svg
rename to archive-doc-gen/src/frontend/src/assets/Send.svg
diff --git a/src/frontend/src/components/Answer/Answer.module.css b/archive-doc-gen/src/frontend/src/components/Answer/Answer.module.css
similarity index 100%
rename from src/frontend/src/components/Answer/Answer.module.css
rename to archive-doc-gen/src/frontend/src/components/Answer/Answer.module.css
diff --git a/src/frontend/src/components/Answer/Answer.test.tsx b/archive-doc-gen/src/frontend/src/components/Answer/Answer.test.tsx
similarity index 100%
rename from src/frontend/src/components/Answer/Answer.test.tsx
rename to archive-doc-gen/src/frontend/src/components/Answer/Answer.test.tsx
diff --git a/src/frontend/src/components/Answer/Answer.tsx b/archive-doc-gen/src/frontend/src/components/Answer/Answer.tsx
similarity index 100%
rename from src/frontend/src/components/Answer/Answer.tsx
rename to archive-doc-gen/src/frontend/src/components/Answer/Answer.tsx
diff --git a/src/frontend/src/components/Answer/AnswerParser.test.ts b/archive-doc-gen/src/frontend/src/components/Answer/AnswerParser.test.ts
similarity index 100%
rename from src/frontend/src/components/Answer/AnswerParser.test.ts
rename to archive-doc-gen/src/frontend/src/components/Answer/AnswerParser.test.ts
diff --git a/src/frontend/src/components/Answer/AnswerParser.tsx b/archive-doc-gen/src/frontend/src/components/Answer/AnswerParser.tsx
similarity index 100%
rename from src/frontend/src/components/Answer/AnswerParser.tsx
rename to archive-doc-gen/src/frontend/src/components/Answer/AnswerParser.tsx
diff --git a/src/frontend/src/components/Answer/index.ts b/archive-doc-gen/src/frontend/src/components/Answer/index.ts
similarity index 100%
rename from src/frontend/src/components/Answer/index.ts
rename to archive-doc-gen/src/frontend/src/components/Answer/index.ts
diff --git a/src/frontend/src/components/ChatHistory/ChatHistoryList.test.tsx b/archive-doc-gen/src/frontend/src/components/ChatHistory/ChatHistoryList.test.tsx
similarity index 100%
rename from src/frontend/src/components/ChatHistory/ChatHistoryList.test.tsx
rename to archive-doc-gen/src/frontend/src/components/ChatHistory/ChatHistoryList.test.tsx
diff --git a/src/frontend/src/components/ChatHistory/ChatHistoryList.tsx b/archive-doc-gen/src/frontend/src/components/ChatHistory/ChatHistoryList.tsx
similarity index 100%
rename from src/frontend/src/components/ChatHistory/ChatHistoryList.tsx
rename to archive-doc-gen/src/frontend/src/components/ChatHistory/ChatHistoryList.tsx
diff --git a/src/frontend/src/components/ChatHistory/ChatHistoryListItem.tsx b/archive-doc-gen/src/frontend/src/components/ChatHistory/ChatHistoryListItem.tsx
similarity index 100%
rename from src/frontend/src/components/ChatHistory/ChatHistoryListItem.tsx
rename to archive-doc-gen/src/frontend/src/components/ChatHistory/ChatHistoryListItem.tsx
diff --git a/src/frontend/src/components/ChatHistory/ChatHistoryPanel.module.css b/archive-doc-gen/src/frontend/src/components/ChatHistory/ChatHistoryPanel.module.css
similarity index 100%
rename from src/frontend/src/components/ChatHistory/ChatHistoryPanel.module.css
rename to archive-doc-gen/src/frontend/src/components/ChatHistory/ChatHistoryPanel.module.css
diff --git a/src/frontend/src/components/ChatHistory/ChatHistoryPanel.test.tsx b/archive-doc-gen/src/frontend/src/components/ChatHistory/ChatHistoryPanel.test.tsx
similarity index 100%
rename from src/frontend/src/components/ChatHistory/ChatHistoryPanel.test.tsx
rename to archive-doc-gen/src/frontend/src/components/ChatHistory/ChatHistoryPanel.test.tsx
diff --git a/src/frontend/src/components/ChatHistory/ChatHistoryPanel.tsx b/archive-doc-gen/src/frontend/src/components/ChatHistory/ChatHistoryPanel.tsx
similarity index 100%
rename from src/frontend/src/components/ChatHistory/ChatHistoryPanel.tsx
rename to archive-doc-gen/src/frontend/src/components/ChatHistory/ChatHistoryPanel.tsx
diff --git a/src/frontend/src/components/ChatHistory/chatHistoryListItem.test.tsx b/archive-doc-gen/src/frontend/src/components/ChatHistory/chatHistoryListItem.test.tsx
similarity index 100%
rename from src/frontend/src/components/ChatHistory/chatHistoryListItem.test.tsx
rename to archive-doc-gen/src/frontend/src/components/ChatHistory/chatHistoryListItem.test.tsx
diff --git a/src/frontend/src/components/DraftCards/SectionCard.test.tsx b/archive-doc-gen/src/frontend/src/components/DraftCards/SectionCard.test.tsx
similarity index 100%
rename from src/frontend/src/components/DraftCards/SectionCard.test.tsx
rename to archive-doc-gen/src/frontend/src/components/DraftCards/SectionCard.test.tsx
diff --git a/src/frontend/src/components/DraftCards/SectionCard.tsx b/archive-doc-gen/src/frontend/src/components/DraftCards/SectionCard.tsx
similarity index 100%
rename from src/frontend/src/components/DraftCards/SectionCard.tsx
rename to archive-doc-gen/src/frontend/src/components/DraftCards/SectionCard.tsx
diff --git a/src/frontend/src/components/DraftCards/TitleCard.test.tsx b/archive-doc-gen/src/frontend/src/components/DraftCards/TitleCard.test.tsx
similarity index 100%
rename from src/frontend/src/components/DraftCards/TitleCard.test.tsx
rename to archive-doc-gen/src/frontend/src/components/DraftCards/TitleCard.test.tsx
diff --git a/src/frontend/src/components/DraftCards/TitleCard.tsx b/archive-doc-gen/src/frontend/src/components/DraftCards/TitleCard.tsx
similarity index 100%
rename from src/frontend/src/components/DraftCards/TitleCard.tsx
rename to archive-doc-gen/src/frontend/src/components/DraftCards/TitleCard.tsx
diff --git a/src/frontend/src/components/FeatureCard/FeatureCard.test.tsx b/archive-doc-gen/src/frontend/src/components/FeatureCard/FeatureCard.test.tsx
similarity index 100%
rename from src/frontend/src/components/FeatureCard/FeatureCard.test.tsx
rename to archive-doc-gen/src/frontend/src/components/FeatureCard/FeatureCard.test.tsx
diff --git a/src/frontend/src/components/FeatureCard/FeatureCard.tsx b/archive-doc-gen/src/frontend/src/components/FeatureCard/FeatureCard.tsx
similarity index 100%
rename from src/frontend/src/components/FeatureCard/FeatureCard.tsx
rename to archive-doc-gen/src/frontend/src/components/FeatureCard/FeatureCard.tsx
diff --git a/src/frontend/src/components/QuestionInput/QuestionInput.module.css b/archive-doc-gen/src/frontend/src/components/QuestionInput/QuestionInput.module.css
similarity index 100%
rename from src/frontend/src/components/QuestionInput/QuestionInput.module.css
rename to archive-doc-gen/src/frontend/src/components/QuestionInput/QuestionInput.module.css
diff --git a/src/frontend/src/components/QuestionInput/QuestionInput.test.tsx b/archive-doc-gen/src/frontend/src/components/QuestionInput/QuestionInput.test.tsx
similarity index 100%
rename from src/frontend/src/components/QuestionInput/QuestionInput.test.tsx
rename to archive-doc-gen/src/frontend/src/components/QuestionInput/QuestionInput.test.tsx
diff --git a/src/frontend/src/components/QuestionInput/QuestionInput.tsx b/archive-doc-gen/src/frontend/src/components/QuestionInput/QuestionInput.tsx
similarity index 100%
rename from src/frontend/src/components/QuestionInput/QuestionInput.tsx
rename to archive-doc-gen/src/frontend/src/components/QuestionInput/QuestionInput.tsx
diff --git a/src/frontend/src/components/QuestionInput/index.ts b/archive-doc-gen/src/frontend/src/components/QuestionInput/index.ts
similarity index 100%
rename from src/frontend/src/components/QuestionInput/index.ts
rename to archive-doc-gen/src/frontend/src/components/QuestionInput/index.ts
diff --git a/src/frontend/src/components/Sidebar/Sidebar.module.css b/archive-doc-gen/src/frontend/src/components/Sidebar/Sidebar.module.css
similarity index 100%
rename from src/frontend/src/components/Sidebar/Sidebar.module.css
rename to archive-doc-gen/src/frontend/src/components/Sidebar/Sidebar.module.css
diff --git a/src/frontend/src/components/Sidebar/Sidebar.test.tsx b/archive-doc-gen/src/frontend/src/components/Sidebar/Sidebar.test.tsx
similarity index 100%
rename from src/frontend/src/components/Sidebar/Sidebar.test.tsx
rename to archive-doc-gen/src/frontend/src/components/Sidebar/Sidebar.test.tsx
diff --git a/src/frontend/src/components/Sidebar/Sidebar.tsx b/archive-doc-gen/src/frontend/src/components/Sidebar/Sidebar.tsx
similarity index 100%
rename from src/frontend/src/components/Sidebar/Sidebar.tsx
rename to archive-doc-gen/src/frontend/src/components/Sidebar/Sidebar.tsx
diff --git a/src/frontend/src/components/common/Button.module.css b/archive-doc-gen/src/frontend/src/components/common/Button.module.css
similarity index 100%
rename from src/frontend/src/components/common/Button.module.css
rename to archive-doc-gen/src/frontend/src/components/common/Button.module.css
diff --git a/src/frontend/src/components/common/Button.test.tsx b/archive-doc-gen/src/frontend/src/components/common/Button.test.tsx
similarity index 100%
rename from src/frontend/src/components/common/Button.test.tsx
rename to archive-doc-gen/src/frontend/src/components/common/Button.test.tsx
diff --git a/src/frontend/src/components/common/Button.tsx b/archive-doc-gen/src/frontend/src/components/common/Button.tsx
similarity index 100%
rename from src/frontend/src/components/common/Button.tsx
rename to archive-doc-gen/src/frontend/src/components/common/Button.tsx
diff --git a/src/frontend/src/constants/chatHistory.test.tsx b/archive-doc-gen/src/frontend/src/constants/chatHistory.test.tsx
similarity index 100%
rename from src/frontend/src/constants/chatHistory.test.tsx
rename to archive-doc-gen/src/frontend/src/constants/chatHistory.test.tsx
diff --git a/src/frontend/src/constants/chatHistory.tsx b/archive-doc-gen/src/frontend/src/constants/chatHistory.tsx
similarity index 100%
rename from src/frontend/src/constants/chatHistory.tsx
rename to archive-doc-gen/src/frontend/src/constants/chatHistory.tsx
diff --git a/src/frontend/src/constants/xssAllowTags.ts b/archive-doc-gen/src/frontend/src/constants/xssAllowTags.ts
similarity index 100%
rename from src/frontend/src/constants/xssAllowTags.ts
rename to archive-doc-gen/src/frontend/src/constants/xssAllowTags.ts
diff --git a/src/frontend/src/helpers/helpers.ts b/archive-doc-gen/src/frontend/src/helpers/helpers.ts
similarity index 100%
rename from src/frontend/src/helpers/helpers.ts
rename to archive-doc-gen/src/frontend/src/helpers/helpers.ts
diff --git a/src/frontend/src/index.css b/archive-doc-gen/src/frontend/src/index.css
similarity index 100%
rename from src/frontend/src/index.css
rename to archive-doc-gen/src/frontend/src/index.css
diff --git a/src/frontend/src/index.tsx b/archive-doc-gen/src/frontend/src/index.tsx
similarity index 100%
rename from src/frontend/src/index.tsx
rename to archive-doc-gen/src/frontend/src/index.tsx
diff --git a/src/frontend/src/pages/NoPage.tsx b/archive-doc-gen/src/frontend/src/pages/NoPage.tsx
similarity index 100%
rename from src/frontend/src/pages/NoPage.tsx
rename to archive-doc-gen/src/frontend/src/pages/NoPage.tsx
diff --git a/src/frontend/src/pages/chat/Chat.module.css b/archive-doc-gen/src/frontend/src/pages/chat/Chat.module.css
similarity index 100%
rename from src/frontend/src/pages/chat/Chat.module.css
rename to archive-doc-gen/src/frontend/src/pages/chat/Chat.module.css
diff --git a/src/frontend/src/pages/chat/Chat.test.tsx b/archive-doc-gen/src/frontend/src/pages/chat/Chat.test.tsx
similarity index 100%
rename from src/frontend/src/pages/chat/Chat.test.tsx
rename to archive-doc-gen/src/frontend/src/pages/chat/Chat.test.tsx
diff --git a/src/frontend/src/pages/chat/Chat.tsx b/archive-doc-gen/src/frontend/src/pages/chat/Chat.tsx
similarity index 100%
rename from src/frontend/src/pages/chat/Chat.tsx
rename to archive-doc-gen/src/frontend/src/pages/chat/Chat.tsx
diff --git a/src/frontend/src/pages/chat/Components/AuthNotConfigure.test.tsx b/archive-doc-gen/src/frontend/src/pages/chat/Components/AuthNotConfigure.test.tsx
similarity index 100%
rename from src/frontend/src/pages/chat/Components/AuthNotConfigure.test.tsx
rename to archive-doc-gen/src/frontend/src/pages/chat/Components/AuthNotConfigure.test.tsx
diff --git a/src/frontend/src/pages/chat/Components/AuthNotConfigure.tsx b/archive-doc-gen/src/frontend/src/pages/chat/Components/AuthNotConfigure.tsx
similarity index 100%
rename from src/frontend/src/pages/chat/Components/AuthNotConfigure.tsx
rename to archive-doc-gen/src/frontend/src/pages/chat/Components/AuthNotConfigure.tsx
diff --git a/src/frontend/src/pages/chat/Components/ChatMessageContainer.test.tsx b/archive-doc-gen/src/frontend/src/pages/chat/Components/ChatMessageContainer.test.tsx
similarity index 100%
rename from src/frontend/src/pages/chat/Components/ChatMessageContainer.test.tsx
rename to archive-doc-gen/src/frontend/src/pages/chat/Components/ChatMessageContainer.test.tsx
diff --git a/src/frontend/src/pages/chat/Components/ChatMessageContainer.tsx b/archive-doc-gen/src/frontend/src/pages/chat/Components/ChatMessageContainer.tsx
similarity index 100%
rename from src/frontend/src/pages/chat/Components/ChatMessageContainer.tsx
rename to archive-doc-gen/src/frontend/src/pages/chat/Components/ChatMessageContainer.tsx
diff --git a/src/frontend/src/pages/chat/Components/CitationPanel.test.tsx b/archive-doc-gen/src/frontend/src/pages/chat/Components/CitationPanel.test.tsx
similarity index 100%
rename from src/frontend/src/pages/chat/Components/CitationPanel.test.tsx
rename to archive-doc-gen/src/frontend/src/pages/chat/Components/CitationPanel.test.tsx
diff --git a/src/frontend/src/pages/chat/Components/CitationPanel.tsx b/archive-doc-gen/src/frontend/src/pages/chat/Components/CitationPanel.tsx
similarity index 100%
rename from src/frontend/src/pages/chat/Components/CitationPanel.tsx
rename to archive-doc-gen/src/frontend/src/pages/chat/Components/CitationPanel.tsx
diff --git a/src/frontend/src/pages/document/Document.module.css b/archive-doc-gen/src/frontend/src/pages/document/Document.module.css
similarity index 100%
rename from src/frontend/src/pages/document/Document.module.css
rename to archive-doc-gen/src/frontend/src/pages/document/Document.module.css
diff --git a/src/frontend/src/pages/document/Document.test.tsx b/archive-doc-gen/src/frontend/src/pages/document/Document.test.tsx
similarity index 100%
rename from src/frontend/src/pages/document/Document.test.tsx
rename to archive-doc-gen/src/frontend/src/pages/document/Document.test.tsx
diff --git a/src/frontend/src/pages/document/Document.tsx b/archive-doc-gen/src/frontend/src/pages/document/Document.tsx
similarity index 100%
rename from src/frontend/src/pages/document/Document.tsx
rename to archive-doc-gen/src/frontend/src/pages/document/Document.tsx
diff --git a/src/frontend/src/pages/draft/Draft.module.css b/archive-doc-gen/src/frontend/src/pages/draft/Draft.module.css
similarity index 100%
rename from src/frontend/src/pages/draft/Draft.module.css
rename to archive-doc-gen/src/frontend/src/pages/draft/Draft.module.css
diff --git a/src/frontend/src/pages/draft/Draft.test.tsx b/archive-doc-gen/src/frontend/src/pages/draft/Draft.test.tsx
similarity index 100%
rename from src/frontend/src/pages/draft/Draft.test.tsx
rename to archive-doc-gen/src/frontend/src/pages/draft/Draft.test.tsx
diff --git a/src/frontend/src/pages/draft/Draft.tsx b/archive-doc-gen/src/frontend/src/pages/draft/Draft.tsx
similarity index 100%
rename from src/frontend/src/pages/draft/Draft.tsx
rename to archive-doc-gen/src/frontend/src/pages/draft/Draft.tsx
diff --git a/src/frontend/src/pages/landing/Landing.module.css b/archive-doc-gen/src/frontend/src/pages/landing/Landing.module.css
similarity index 100%
rename from src/frontend/src/pages/landing/Landing.module.css
rename to archive-doc-gen/src/frontend/src/pages/landing/Landing.module.css
diff --git a/src/frontend/src/pages/landing/Landing.test.tsx b/archive-doc-gen/src/frontend/src/pages/landing/Landing.test.tsx
similarity index 100%
rename from src/frontend/src/pages/landing/Landing.test.tsx
rename to archive-doc-gen/src/frontend/src/pages/landing/Landing.test.tsx
diff --git a/src/frontend/src/pages/landing/Landing.tsx b/archive-doc-gen/src/frontend/src/pages/landing/Landing.tsx
similarity index 100%
rename from src/frontend/src/pages/landing/Landing.tsx
rename to archive-doc-gen/src/frontend/src/pages/landing/Landing.tsx
diff --git a/src/frontend/src/pages/layout/Layout.module.css b/archive-doc-gen/src/frontend/src/pages/layout/Layout.module.css
similarity index 100%
rename from src/frontend/src/pages/layout/Layout.module.css
rename to archive-doc-gen/src/frontend/src/pages/layout/Layout.module.css
diff --git a/src/frontend/src/pages/layout/Layout.test.tsx b/archive-doc-gen/src/frontend/src/pages/layout/Layout.test.tsx
similarity index 100%
rename from src/frontend/src/pages/layout/Layout.test.tsx
rename to archive-doc-gen/src/frontend/src/pages/layout/Layout.test.tsx
diff --git a/src/frontend/src/pages/layout/Layout.tsx b/archive-doc-gen/src/frontend/src/pages/layout/Layout.tsx
similarity index 100%
rename from src/frontend/src/pages/layout/Layout.tsx
rename to archive-doc-gen/src/frontend/src/pages/layout/Layout.tsx
diff --git a/src/frontend/src/state/AppProvider.tsx b/archive-doc-gen/src/frontend/src/state/AppProvider.tsx
similarity index 100%
rename from src/frontend/src/state/AppProvider.tsx
rename to archive-doc-gen/src/frontend/src/state/AppProvider.tsx
diff --git a/src/frontend/src/state/AppReducer.tsx b/archive-doc-gen/src/frontend/src/state/AppReducer.tsx
similarity index 100%
rename from src/frontend/src/state/AppReducer.tsx
rename to archive-doc-gen/src/frontend/src/state/AppReducer.tsx
diff --git a/src/frontend/src/test/setupTests.ts b/archive-doc-gen/src/frontend/src/test/setupTests.ts
similarity index 100%
rename from src/frontend/src/test/setupTests.ts
rename to archive-doc-gen/src/frontend/src/test/setupTests.ts
diff --git a/src/frontend/src/test/test.utils.tsx b/archive-doc-gen/src/frontend/src/test/test.utils.tsx
similarity index 100%
rename from src/frontend/src/test/test.utils.tsx
rename to archive-doc-gen/src/frontend/src/test/test.utils.tsx
diff --git a/src/frontend/src/vite-env.d.ts b/archive-doc-gen/src/frontend/src/vite-env.d.ts
similarity index 100%
rename from src/frontend/src/vite-env.d.ts
rename to archive-doc-gen/src/frontend/src/vite-env.d.ts
diff --git a/src/frontend/tsconfig.json b/archive-doc-gen/src/frontend/tsconfig.json
similarity index 100%
rename from src/frontend/tsconfig.json
rename to archive-doc-gen/src/frontend/tsconfig.json
diff --git a/src/frontend/tsconfig.node.json b/archive-doc-gen/src/frontend/tsconfig.node.json
similarity index 100%
rename from src/frontend/tsconfig.node.json
rename to archive-doc-gen/src/frontend/tsconfig.node.json
diff --git a/src/frontend/vite.config.ts b/archive-doc-gen/src/frontend/vite.config.ts
similarity index 100%
rename from src/frontend/vite.config.ts
rename to archive-doc-gen/src/frontend/vite.config.ts
diff --git a/src/gunicorn.conf.py b/archive-doc-gen/src/gunicorn.conf.py
similarity index 100%
rename from src/gunicorn.conf.py
rename to archive-doc-gen/src/gunicorn.conf.py
diff --git a/src/requirements-dev.txt b/archive-doc-gen/src/requirements-dev.txt
similarity index 100%
rename from src/requirements-dev.txt
rename to archive-doc-gen/src/requirements-dev.txt
diff --git a/src/requirements.txt b/archive-doc-gen/src/requirements.txt
similarity index 100%
rename from src/requirements.txt
rename to archive-doc-gen/src/requirements.txt
diff --git a/src/start.cmd b/archive-doc-gen/src/start.cmd
similarity index 100%
rename from src/start.cmd
rename to archive-doc-gen/src/start.cmd
diff --git a/src/start.sh b/archive-doc-gen/src/start.sh
similarity index 100%
rename from src/start.sh
rename to archive-doc-gen/src/start.sh
diff --git a/src/test.cmd b/archive-doc-gen/src/test.cmd
similarity index 100%
rename from src/test.cmd
rename to archive-doc-gen/src/test.cmd
diff --git a/src/tests/conftest.py b/archive-doc-gen/src/tests/conftest.py
similarity index 100%
rename from src/tests/conftest.py
rename to archive-doc-gen/src/tests/conftest.py
diff --git a/src/tests/integration_tests/conftest.py b/archive-doc-gen/src/tests/integration_tests/conftest.py
similarity index 100%
rename from src/tests/integration_tests/conftest.py
rename to archive-doc-gen/src/tests/integration_tests/conftest.py
diff --git a/src/tests/integration_tests/dotenv_templates/dotenv.jinja2 b/archive-doc-gen/src/tests/integration_tests/dotenv_templates/dotenv.jinja2
similarity index 100%
rename from src/tests/integration_tests/dotenv_templates/dotenv.jinja2
rename to archive-doc-gen/src/tests/integration_tests/dotenv_templates/dotenv.jinja2
diff --git a/src/tests/integration_tests/test_datasources.py b/archive-doc-gen/src/tests/integration_tests/test_datasources.py
similarity index 100%
rename from src/tests/integration_tests/test_datasources.py
rename to archive-doc-gen/src/tests/integration_tests/test_datasources.py
diff --git a/src/tests/integration_tests/test_startup_scripts.py b/archive-doc-gen/src/tests/integration_tests/test_startup_scripts.py
similarity index 100%
rename from src/tests/integration_tests/test_startup_scripts.py
rename to archive-doc-gen/src/tests/integration_tests/test_startup_scripts.py
diff --git a/src/tests/unit_tests/dotenv_data/dotenv_no_datasource_1 b/archive-doc-gen/src/tests/unit_tests/dotenv_data/dotenv_no_datasource_1
similarity index 100%
rename from src/tests/unit_tests/dotenv_data/dotenv_no_datasource_1
rename to archive-doc-gen/src/tests/unit_tests/dotenv_data/dotenv_no_datasource_1
diff --git a/src/tests/unit_tests/dotenv_data/dotenv_no_datasource_2 b/archive-doc-gen/src/tests/unit_tests/dotenv_data/dotenv_no_datasource_2
similarity index 100%
rename from src/tests/unit_tests/dotenv_data/dotenv_no_datasource_2
rename to archive-doc-gen/src/tests/unit_tests/dotenv_data/dotenv_no_datasource_2
diff --git a/src/tests/unit_tests/dotenv_data/dotenv_with_azure_search_success b/archive-doc-gen/src/tests/unit_tests/dotenv_data/dotenv_with_azure_search_success
similarity index 100%
rename from src/tests/unit_tests/dotenv_data/dotenv_with_azure_search_success
rename to archive-doc-gen/src/tests/unit_tests/dotenv_data/dotenv_with_azure_search_success
diff --git a/src/tests/unit_tests/dotenv_data/dotenv_with_elasticsearch_success b/archive-doc-gen/src/tests/unit_tests/dotenv_data/dotenv_with_elasticsearch_success
similarity index 100%
rename from src/tests/unit_tests/dotenv_data/dotenv_with_elasticsearch_success
rename to archive-doc-gen/src/tests/unit_tests/dotenv_data/dotenv_with_elasticsearch_success
diff --git a/src/tests/unit_tests/helpers/test_azure_credential_utils.py b/archive-doc-gen/src/tests/unit_tests/helpers/test_azure_credential_utils.py
similarity index 100%
rename from src/tests/unit_tests/helpers/test_azure_credential_utils.py
rename to archive-doc-gen/src/tests/unit_tests/helpers/test_azure_credential_utils.py
diff --git a/src/tests/unit_tests/test_settings.py b/archive-doc-gen/src/tests/unit_tests/test_settings.py
similarity index 100%
rename from src/tests/unit_tests/test_settings.py
rename to archive-doc-gen/src/tests/unit_tests/test_settings.py
diff --git a/src/tests/unit_tests/test_utils.py b/archive-doc-gen/src/tests/unit_tests/test_utils.py
similarity index 100%
rename from src/tests/unit_tests/test_utils.py
rename to archive-doc-gen/src/tests/unit_tests/test_utils.py
diff --git a/tests/e2e-test/.gitignore b/archive-doc-gen/tests/e2e-test/.gitignore
similarity index 100%
rename from tests/e2e-test/.gitignore
rename to archive-doc-gen/tests/e2e-test/.gitignore
diff --git a/tests/e2e-test/README.md b/archive-doc-gen/tests/e2e-test/README.md
similarity index 100%
rename from tests/e2e-test/README.md
rename to archive-doc-gen/tests/e2e-test/README.md
diff --git a/tests/e2e-test/base/__init__.py b/archive-doc-gen/tests/e2e-test/base/__init__.py
similarity index 100%
rename from tests/e2e-test/base/__init__.py
rename to archive-doc-gen/tests/e2e-test/base/__init__.py
diff --git a/tests/e2e-test/base/base.py b/archive-doc-gen/tests/e2e-test/base/base.py
similarity index 100%
rename from tests/e2e-test/base/base.py
rename to archive-doc-gen/tests/e2e-test/base/base.py
diff --git a/tests/e2e-test/config/constants.py b/archive-doc-gen/tests/e2e-test/config/constants.py
similarity index 51%
rename from tests/e2e-test/config/constants.py
rename to archive-doc-gen/tests/e2e-test/config/constants.py
index 9e7021a31..6dec2c9a5 100644
--- a/tests/e2e-test/config/constants.py
+++ b/archive-doc-gen/tests/e2e-test/config/constants.py
@@ -13,11 +13,25 @@
# browse input data
browse_question1 = "What are typical sections in a promissory note?"
browse_question2 = "List the details of two promissory notes governed by the laws of the state of California"
+browse_question3 = "List all documents and their value"
+browse_question4 = "list each promissory note, the borrower name, the lender name, the amount, and the interest rate in table format where the interest rate is not 5%"
+browse_question5 = "list each promissory note, the borrower name, the lender name, the amount, and the interest rate in tabular format where the interest rate is not 5%"
# Generate input data
generate_question1 = "Generate promissory note for Washington State"
add_section = "Add Payment acceleration clause after the payment terms sections"
+remove_section = "Remove Borrower Information Promissory note"
+
# Response Text Data
invalid_response = "I was unable to find content related to your query and could not generate a template. Please try again."
invalid_response1 = "An error occurred. Answers can't be saved at this time. If the problem persists, please contact the site administrator."
+
+
+# Construct the absolute path to the JSON file
+# Note: This section is commented out as prompts.json file doesn't exist
+# All required constants are defined above
+# json_file_path = os.path.join(repo_root, 'tests/e2e-test', 'testdata', 'prompts.json')
+# with open(json_file_path, 'r') as file:
+# data = json.load(file)
+# questions = data['questions']
diff --git a/tests/e2e-test/img.png b/archive-doc-gen/tests/e2e-test/img.png
similarity index 100%
rename from tests/e2e-test/img.png
rename to archive-doc-gen/tests/e2e-test/img.png
diff --git a/tests/e2e-test/img_1.png b/archive-doc-gen/tests/e2e-test/img_1.png
similarity index 100%
rename from tests/e2e-test/img_1.png
rename to archive-doc-gen/tests/e2e-test/img_1.png
diff --git a/tests/e2e-test/pages/__init__.py b/archive-doc-gen/tests/e2e-test/pages/__init__.py
similarity index 100%
rename from tests/e2e-test/pages/__init__.py
rename to archive-doc-gen/tests/e2e-test/pages/__init__.py
diff --git a/archive-doc-gen/tests/e2e-test/pages/browsePage.py b/archive-doc-gen/tests/e2e-test/pages/browsePage.py
new file mode 100644
index 000000000..bf65cbeb9
--- /dev/null
+++ b/archive-doc-gen/tests/e2e-test/pages/browsePage.py
@@ -0,0 +1,287 @@
+from base.base import BasePage
+from playwright.sync_api import expect
+import logging
+logger = logging.getLogger(__name__)
+
+
+class BrowsePage(BasePage):
+ TYPE_QUESTION = "//textarea[@placeholder='Type a new question...']"
+ SEND_BUTTON = "//div[@aria-label='Ask question button']"
+ GENERATE_BUTTON = "//div[contains(@class, 'ms-Stack')]//span[normalize-space()='Generate']"
+ DRAFT_TAB_BUTTON = "//span[normalize-space()='Draft']"
+ DRAFT_TAB_CONTAINER = "//div[contains(@class, '_navigationButtonDisabled')]"
+ RESPONSE_REFERENCE_EXPAND_ICON = "//span[@aria-label='Open references']"
+ REFERENCE_LINKS_IN_RESPONSE = "//span[@class='_citationContainer_1qm4u_72']"
+ REFERENCE_POPUP_PANEL = "//div[@role='dialog']"
+ REFERENCE_POPUP_CONTENT = "//div[@role='dialog']//div[contains(@class, 'fui-DialogSurface')]"
+ CLOSE_BUTTON = "//button[.='Close']"
+ CLEAR_CHAT_BROOM_BUTTON = "button[aria-label='clear chat button']"
+
+ def __init__(self, page):
+ super().__init__(page)
+
+ def validate_browse_page(self):
+ """Validate that Browse page chat conversation elements are visible"""
+ self.page.wait_for_timeout(3000)
+ expect(self.page.locator(self.TYPE_QUESTION)).to_be_visible()
+ expect(self.page.locator(self.SEND_BUTTON)).to_be_visible()
+
+ def enter_a_question(self, text):
+ # Type a question in the text area
+ self.page.locator(self.TYPE_QUESTION).fill(text)
+ self.page.wait_for_timeout(2000)
+
+ def click_send_button(self):
+ # Type a question in the text area
+ self.page.locator(self.SEND_BUTTON).click()
+ self.page.wait_for_timeout(10000)
+
+ def click_generate_button(self):
+ # Type a question in the text area
+ self.page.locator(self.GENERATE_BUTTON).click()
+ self.page.wait_for_timeout(5000)
+
+ def click_reference_link_in_response(self):
+ # Click on reference link response
+ BasePage.scroll_into_view(
+ self, self.page.locator(self.REFERENCE_LINKS_IN_RESPONSE)
+ )
+ self.page.wait_for_timeout(2000)
+ reference_links = self.page.locator(self.REFERENCE_LINKS_IN_RESPONSE)
+ reference_links.nth(reference_links.count() - 1).click()
+ # self.page.locator(self.REFERENCE_LINKS_IN_RESPONSE).click()
+ self.page.wait_for_load_state("networkidle")
+ self.page.wait_for_timeout(2000)
+
+ def click_expand_reference_in_response(self):
+ # Click on expand in response reference area
+ self.page.wait_for_timeout(5000)
+ expand_icon = self.page.locator(self.RESPONSE_REFERENCE_EXPAND_ICON)
+ expand_icon.nth(expand_icon.count() - 1).click()
+ self.page.wait_for_load_state("networkidle")
+ self.page.wait_for_timeout(2000)
+
+ def close_citation(self):
+ self.page.wait_for_timeout(3000)
+ self.page.locator(self.CLOSE_BUTTON).click()
+ self.page.wait_for_timeout(2000)
+
+ def click_draft_tab_button(self):
+ """Click on Draft tab button"""
+ self.page.wait_for_timeout(2000)
+ self.page.locator(self.DRAFT_TAB_BUTTON).click()
+ self.page.wait_for_timeout(3000)
+
+ def is_draft_tab_enabled(self):
+ """Check if Draft tab is enabled (clickable)"""
+ self.page.wait_for_timeout(2000)
+ draft_button = self.page.locator(self.DRAFT_TAB_BUTTON)
+
+ if draft_button.count() > 0:
+ # Check if the container has the disabled class
+ draft_container = self.page.locator(self.DRAFT_TAB_CONTAINER)
+ has_disabled_class = draft_container.count() > 0
+
+ # Check if cursor is not-allowed (disabled state)
+ cursor_style = draft_container.get_attribute("style") if has_disabled_class else ""
+ is_disabled = "cursor: not-allowed" in cursor_style or has_disabled_class
+
+ return not is_disabled
+ return False
+
+ def is_draft_tab_disabled(self):
+ """Check if Draft tab is disabled (not clickable)"""
+ self.page.wait_for_timeout(2000)
+ draft_button = self.page.locator(self.DRAFT_TAB_BUTTON)
+
+ if draft_button.count() > 0:
+ # Check if the container has the disabled class
+ draft_container = self.page.locator(self.DRAFT_TAB_CONTAINER)
+ has_disabled_class = draft_container.count() > 0
+
+ # Check if cursor is not-allowed (disabled state)
+ if has_disabled_class:
+ cursor_style = draft_container.get_attribute("style") or ""
+ is_disabled = "cursor: not-allowed" in cursor_style
+ return is_disabled
+ return False
+ return True # If not visible, consider it disabled
+
+ def click_broom_icon(self):
+ broom = self.page.locator(self.CLEAR_CHAT_BROOM_BUTTON)
+ assert broom.is_visible(), "Broom (clear chat) icon is not visible"
+ broom.click()
+ logger.info("Clicked broom icon to clear the chat")
+
+ def is_chat_cleared(self):
+ """
+ Verify that the chat has been cleared and a new session has started.
+ Checks if the chat area is empty (no previous messages visible).
+
+ :return: True if chat is cleared, False otherwise
+ """
+ self.page.wait_for_timeout(1000)
+
+ # Check if any response paragraphs exist (indicating old messages)
+ response_paragraphs = self.page.locator("//div[contains(@class, 'answerContainer')]//p")
+ has_old_messages = response_paragraphs.count() > 0
+
+ if has_old_messages:
+ logger.warning("Chat still contains old messages after clearing")
+ return False
+
+ # Verify the input field is visible and empty (ready for new input)
+ input_field = self.page.locator(self.TYPE_QUESTION)
+ if not input_field.is_visible():
+ logger.warning("Chat input field is not visible")
+ return False
+
+ # Check if input field is empty or has placeholder text
+ input_value = input_field.input_value()
+ if input_value.strip():
+ logger.warning("Chat input field still contains text: '%s'", input_value)
+ return False
+
+ logger.info("Chat cleared successfully - no old messages, input field is empty")
+ return True
+
+ def get_citation_count(self):
+ """
+ Get the number of citations/references in the last response.
+
+ Returns:
+ int: Number of citation links found
+ """
+ logger.info("🔹 Counting citations in response")
+
+ self.page.wait_for_timeout(2000)
+
+ # Get citation links in the last response
+ citation_links = self.page.locator(self.REFERENCE_LINKS_IN_RESPONSE)
+ count = citation_links.count()
+
+ logger.info(f"Found {count} citations in response")
+ return count
+
+ def get_citations_and_documents(self):
+ """
+ Get all citations and their corresponding document names from the last response.
+ Expands the references section and extracts document information.
+
+ Returns:
+ tuple: (citation_count, document_list)
+ """
+ logger.info("🔹 Extracting citations and documents from response")
+
+ self.page.wait_for_timeout(3000)
+
+ # Count citations first
+ citation_count = self.get_citation_count()
+
+ if citation_count == 0:
+ logger.warning("No citations found in response")
+ return 0, []
+
+ # Click to expand references
+ try:
+ expand_icon = self.page.locator(self.RESPONSE_REFERENCE_EXPAND_ICON)
+ if expand_icon.count() > 0:
+ expand_icon.nth(expand_icon.count() - 1).click()
+ logger.info("Expanded references section")
+ self.page.wait_for_timeout(2000)
+ else:
+ logger.warning("References expand icon not found")
+ return citation_count, []
+ except Exception as e:
+ logger.error(f"Failed to expand references: {e}")
+ return citation_count, []
+
+ # Extract document names from expanded references
+ documents = []
+
+ try:
+ # Look for reference items in the expanded section
+ # This selector may need adjustment based on actual DOM structure
+ reference_items = self.page.locator("//div[contains(@class, 'citationPanel')]//div[contains(@class, 'citationItem')]")
+
+ if reference_items.count() == 0:
+ # Try alternative selector
+ reference_items = self.page.locator("//div[@role='complementary']//div[contains(@class, 'citation')]")
+
+ ref_count = reference_items.count()
+ logger.info(f"Found {ref_count} reference items in expanded section")
+
+ for i in range(ref_count):
+ try:
+ ref_text = reference_items.nth(i).inner_text()
+ documents.append(ref_text.strip())
+ logger.info(f" Reference {i + 1}: {ref_text[:100]}...")
+ except Exception as e:
+ logger.warning(f"Could not extract reference {i + 1}: {e}")
+
+ except Exception as e:
+ logger.error(f"Failed to extract reference documents: {e}")
+
+ logger.info(f"✅ Extracted {len(documents)} document references")
+ return citation_count, documents
+
+ def verify_response_has_citations(self, min_citations=1):
+ """
+ Verify that the response has at least the minimum number of citations.
+
+ Args:
+ min_citations: Minimum expected number of citations (default: 1)
+
+ Returns:
+ bool: True if citation count >= min_citations
+ """
+ logger.info(f"🔹 Verifying response has at least {min_citations} citation(s)")
+
+ citation_count = self.get_citation_count()
+
+ if citation_count >= min_citations:
+ logger.info(f"✅ Response has {citation_count} citations (>= {min_citations})")
+ return True
+ else:
+ logger.error(f"❌ Response has only {citation_count} citations (expected >= {min_citations})")
+ return False
+
+ def verify_response_generated_with_citations(self, timeout=60000):
+ """
+ Verify that a response is generated with citations/references.
+
+ Args:
+ timeout: Maximum wait time in milliseconds
+
+ Returns:
+ tuple: (response_text, citation_count)
+ """
+ logger.info("🔹 Verifying response generated with citations")
+
+ # Wait for response container
+ self.page.wait_for_timeout(5000)
+
+ answer_container = self.page.locator("//div[contains(@class, 'answerContainer')]").last
+
+ try:
+ # Wait for answer to be visible
+ expect(answer_container).to_be_visible(timeout=timeout)
+
+ # Get response text
+ response_text = answer_container.inner_text()
+ logger.info(f"Response length: {len(response_text)} characters")
+
+ # Verify response is not empty
+ assert response_text.strip(), "Response text is empty"
+
+ # Count citations
+ citation_count = self.get_citation_count()
+ logger.info(f"Response has {citation_count} citations")
+
+ logger.info("✅ Response generated successfully with citations")
+ return response_text, citation_count
+
+ except Exception as e:
+ logger.error(f"❌ Failed to verify response with citations: {e}")
+ raise
+
diff --git a/archive-doc-gen/tests/e2e-test/pages/draftPage.py b/archive-doc-gen/tests/e2e-test/pages/draftPage.py
new file mode 100644
index 000000000..760a54e55
--- /dev/null
+++ b/archive-doc-gen/tests/e2e-test/pages/draftPage.py
@@ -0,0 +1,627 @@
+import time
+import os
+from base.base import BasePage
+from pytest_check import check
+from playwright.sync_api import expect
+import logging
+logger = logging.getLogger(__name__)
+
+
+class DraftPage(BasePage):
+ Draft_Sections = "//textarea"
+ Draft_headings = "//span[@class='fui-Text ___nl2uoq0 fk6fouc f4ybsrx f1i3iumi f16wzh4i fpgzoln f1w7gpdv f6juhto f1gl81tg f2jf649 fepr9ql febqm8h']"
+ invalid_response = "The requested information is not available in the retrieved data. Please try another query or topic."
+ invalid_response1 = "There was an issue fetching your data. Please try again."
+ SECTION_CONTAINER = "div[role='region']"
+ SECTION_GENERATE_BUTTON = "button.fui-Button:has-text('Generate')"
+
+ def __init__(self, page):
+ super().__init__(page)
+
+ def validate_draft_sections_loaded(self):
+ max_wait_time = 180 # seconds
+ poll_interval = 2
+
+ self.page.wait_for_timeout(25000)
+
+ # All draft section containers
+ section_blocks = self.page.locator("//div[@class='ms-Stack ___mit7380 f4zyqsv f6m9rw3 fwbpcpn folxr9a f1s274it css-103']")
+ total_sections = section_blocks.count()
+
+ logger.info(f"🔍 Total sections found: {total_sections}")
+
+ for index in range(total_sections):
+ section = section_blocks.nth(index)
+
+ try:
+ section.scroll_into_view_if_needed()
+ self.page.wait_for_timeout(500)
+
+ title_element = section.locator("//span[@class='fui-Text ___nl2uoq0 fk6fouc f4ybsrx f1i3iumi f16wzh4i fpgzoln f1w7gpdv f6juhto f1gl81tg f2jf649 fepr9ql febqm8h']")
+ title_text = title_element.inner_text(timeout=5000).strip()
+ except Exception as e:
+ logger.error(f"❌ Could not read title for section #{index + 1}: {e}")
+ continue
+
+ logger.info(f"➡️ Validating section [{index + 1}/{total_sections}]: '{title_text}'")
+
+ content_locator = section.locator("//textarea")
+ generate_btn = section.locator("//span[@class='fui-Button__icon rywnvv2 ___963sj20 f1nizpg2']")
+ spinner_locator = section.locator("//div[@id='section-card-spinner']")
+
+ content_loaded = False
+
+ # 🚨 If spinner is visible inside this section, click generate immediately
+ try:
+ if spinner_locator.is_visible(timeout=1000):
+ logger.warning(f"⏳ Spinner found in section '{title_text}'. Clicking Generate immediately.")
+ generate_btn.click()
+ self.page.wait_for_timeout(3000)
+ confirm_btn = self.page.locator("//button[@class='fui-Button r1alrhcs ___zqkcn80 fd1o0ie fjxutwb fwiml72 fj8njcf fzcpov4 f1d2rq10 f1mk8lai ff3glw6']")
+ if confirm_btn.is_visible(timeout=3000):
+ confirm_btn.click()
+ logger.info(f"🟢 Clicked Confirm button for section '{title_text}'")
+ else:
+ logger.warning(f"⚠️ Confirm button not visible for section '{title_text}'")
+ except Exception as e:
+ logger.error(f"❌ Error while clicking Confirm button for section '{title_text}': {e}")
+
+ # ⏳ Retry short wait (15s) for content to load
+ short_wait = 15
+ short_start = time.time()
+ while time.time() - short_start < short_wait:
+ try:
+ content = content_locator.text_content(timeout=2000).strip()
+ if content:
+ logger.info(f"✅ Section '{title_text}' loaded after Generate + Confirm.")
+ content_loaded = True
+ break
+ except Exception as e:
+ logger.info(f"⏳ Waiting for section '{title_text}' to load... {e}")
+ time.sleep(1)
+
+ if not content_loaded:
+ logger.error(f"❌ Section '{title_text}' still empty after Generate + Confirm wait ({short_wait}s). Skipping.")
+
+ # Step 1: Wait for content to load normally
+ start = time.time()
+ while time.time() - start < max_wait_time:
+ try:
+ content = content_locator.text_content(timeout=2000).strip()
+ if content:
+ logger.info(f"✅ Section '{title_text}' loaded successfully.")
+ content_loaded = True
+ break
+ except Exception as e:
+ logger.info(f"⏳ Waiting for section '{title_text}' to load... {e}")
+ time.sleep(poll_interval)
+
+ # Step 2: If still not loaded, click Generate and retry
+ if not content_loaded:
+ logger.warning(f"⚠️ Section '{title_text}' is empty. Attempting 'Generate'...")
+
+ try:
+ generate_btn.click()
+ logger.info(f"🔄 Clicked 'Generate' for section '{title_text}'")
+ except Exception as e:
+ logger.error(f"❌ Failed to click 'Generate' for section '{title_text}': {e}")
+ continue
+
+ # Retry wait
+ start = time.time()
+ while time.time() - start < max_wait_time:
+ try:
+ content = content_locator.text_content(timeout=2000).strip()
+ if content:
+ logger.info(f"✅ Section '{title_text}' loaded after clicking Generate.")
+ content_loaded = True
+ break
+ except Exception as e:
+ logger.info(f"⏳ Waiting for section '{title_text}' to load after Generate... {e}")
+ time.sleep(poll_interval)
+
+ if not content_loaded:
+ logger.error(f"❌ Section '{title_text}' still empty after retrying.")
+ # Note: Screenshots are only captured on test failures, not during normal page operations
+ continue
+
+ try:
+ content = content_locator.text_content(timeout=2000).strip()
+ with check:
+ if content == self.invalid_response or content == self.invalid_response1:
+ logger.warning(f"❌ Invalid response found in '{title_text}'. Retrying Generate + Confirm...")
+
+ try:
+ generate_btn.click()
+ self.page.wait_for_timeout(3000)
+
+ confirm_btn = self.page.locator("//button[@class='fui-Button r1alrhcs ___zqkcn80 fd1o0ie fjxutwb fwiml72 fj8njcf fzcpov4 f1d2rq10 f1mk8lai ff3glw6']")
+ if confirm_btn.is_visible(timeout=3000):
+ confirm_btn.click()
+ logger.info(f"🟢 Retried Confirm for section '{title_text}'")
+ else:
+ logger.warning(f"⚠️ Confirm button not visible during retry for '{title_text}'")
+ except Exception as e:
+ logger.error(f"❌ Retry Generate/Confirm failed: {e}")
+
+ retry_start = time.time()
+ while time.time() - retry_start < short_wait:
+ try:
+ content = content_locator.text_content(timeout=2000).strip()
+ if content and content not in [self.invalid_response, self.invalid_response1]:
+ logger.info(f"✅ Section '{title_text}' fixed after retry.")
+ break
+ except Exception as e:
+ logger.info(f"⏳ Retrying section '{title_text}'... {e}")
+ time.sleep(1)
+
+ with check:
+ assert content != self.invalid_response, f"❌ '{title_text}' still has invalid response after retry"
+ assert content != self.invalid_response1, f"❌ '{title_text}' still has invalid response after retry"
+
+ else:
+ logger.info(f"🎯 Section '{title_text}' has valid content.")
+ except Exception as e:
+ logger.error(f"❌ Could not validate content for '{title_text}': {e}")
+ logger.info(f"✔️ Completed section: '{title_text}'\n")
+
+ def verify_all_section_generate_buttons(self, expected_count=11):
+ """
+ Verifies that each Draft section contains a visible 'Generate' button.
+ Ensures no section is missing its Generate button.
+ """
+ buttons = self.page.locator('button:has-text("Generate")')
+ found_count = buttons.count()
+
+ # Logging (optional)
+ logger.info(f"Found {found_count} Generate buttons, expected {expected_count}")
+
+ # Assertion
+ expect(buttons).to_have_count(expected_count)
+
+ return found_count
+
+ def click_section_generate_button(self, section_index):
+ """
+ Click the Generate button for a specific section on the Draft page.
+ """
+
+ logger.info(f"🔹 Clicking Generate button for section {section_index + 1}")
+
+ # Corrected section locator (your old one was too rigid)
+ section_blocks = self.page.locator(
+ "//div[contains(@class,'ms-Stack') and contains(@class,'f1s274it')]"
+ )
+
+ section = section_blocks.nth(section_index)
+
+ # Get section title (your previous locator was global → replaced with relative)
+ try:
+ title_element = section.locator(".fui-Text").first
+ title = title_element.inner_text(timeout=3000).strip()
+ logger.info(f"Section title: '{title}'")
+ except Exception:
+ title = f"Section {section_index + 1}"
+ logger.warning(f"⚠️ Could not read section title, using default: {title}")
+
+ # Scroll into view before clicking
+ section.scroll_into_view_if_needed()
+ self.page.wait_for_timeout(300)
+
+ # Find Generate button inside section
+ generate_button = section.locator("button:has-text('Generate')").first
+ expect(generate_button).to_be_visible(timeout=5000)
+
+ generate_button.click()
+ logger.info(f"✅ Clicked Generate button for section: {title}")
+
+ return title
+
+ def verify_regenerate_popup_displayed(self):
+ """
+ Verify that the Regenerate popup is displayed with Generate button.
+ """
+ logger.info("🔹 Verifying Regenerate popup is displayed")
+
+ # Wait for the popup to appear
+ self.page.wait_for_timeout(1000)
+
+ # Correct locator for the Popover
+ popup = self.page.locator("div.fui-PopoverSurface").first
+
+ try:
+ expect(popup).to_be_visible(timeout=5000)
+ logger.info("✅ Regenerate popup is displayed")
+ except Exception as e:
+ logger.error(f"❌ Regenerate popup not found: {e}")
+ raise
+
+ # Locate the Generate button inside the popup
+ generate_button = popup.locator("button[data-testid='generate-btn-in-popover']")
+ expect(generate_button).to_be_visible(timeout=3000)
+ logger.info("✅ Generate button found in Regenerate popup")
+
+ return popup
+
+ def update_prompt_and_regenerate(self, additional_instruction):
+ """
+ Read the existing section-specific prompt from the popup, append additional instruction, and regenerate.
+
+ Args:
+ additional_instruction: Additional instruction to append to the existing prompt (e.g., "add max 150 words")
+ """
+ logger.info(f"🔹 Reading existing prompt from popup and appending: '{additional_instruction}'")
+
+ # Find the popup using the correct locator
+ popup = self.page.locator("div.fui-PopoverSurface").first
+
+ # Find the textarea in the popup
+ prompt_input = popup.locator("textarea").first
+
+ try:
+ # Read the existing section-specific prompt from the popup
+ existing_prompt = prompt_input.input_value(timeout=3000)
+ logger.info(f"📝 Existing prompt in popup: '{existing_prompt}'")
+
+ # Append the additional instruction to the existing prompt
+ updated_prompt = f"{existing_prompt} {additional_instruction}"
+
+ # Clear and enter the updated prompt
+ prompt_input.clear()
+ prompt_input.fill(updated_prompt)
+ logger.info(f"✅ Updated prompt: '{updated_prompt}'")
+ except Exception as e:
+ logger.error(f"❌ Failed to update prompt: {e}")
+ raise
+
+ # Click Generate button in popup using the correct data-testid
+ generate_button = popup.locator("button[data-testid='generate-btn-in-popover']")
+
+ try:
+ expect(generate_button).to_be_visible(timeout=3000)
+ generate_button.click()
+ logger.info("✅ Clicked Generate button in popup")
+ except Exception as e:
+ logger.error(f"❌ Failed to click Generate button: {e}")
+ raise
+
+ # Wait for popup to close and regeneration to start
+ self.page.wait_for_timeout(2000)
+
+ def verify_section_content_updated(self, section_index, original_content):
+ """
+ Verify that the section content has been updated after regeneration.
+
+ Args:
+ section_index: Index of the section (0-based)
+ original_content: Original content before regeneration
+
+ Returns:
+ new_content: The updated content
+ """
+ logger.info(f"🔹 Verifying section {section_index + 1} content is updated")
+
+ # Wait for regeneration to complete
+ max_wait = 60 # seconds
+ start_time = time.time()
+
+ # Use the same section locator as other methods for consistency
+ section_blocks = self.page.locator(
+ "//div[contains(@class,'ms-Stack') and contains(@class,'f1s274it')]"
+ )
+ section = section_blocks.nth(section_index)
+
+ # Wait for spinner to disappear if present
+ spinner_locator = section.locator("//div[@id='section-card-spinner']")
+ try:
+ if spinner_locator.is_visible(timeout=2000):
+ logger.info("⏳ Waiting for regeneration to complete...")
+ spinner_locator.wait_for(state="hidden", timeout=max_wait * 1000)
+ except Exception:
+ pass # Spinner might not appear for fast responses
+
+ # Get updated content
+ content_locator = section.locator("//textarea")
+
+ while time.time() - start_time < max_wait:
+ try:
+ new_content = content_locator.text_content(timeout=3000).strip()
+
+ if new_content and new_content != original_content:
+ logger.info(f"✅ Section content updated successfully")
+ logger.info(f"Original length: {len(original_content)} chars")
+ logger.info(f"New length: {len(new_content)} chars")
+ return new_content
+
+ except Exception as e:
+ logger.warning(f"⏳ Waiting for content update: {e}")
+
+ time.sleep(2)
+
+ # If we reach here, content didn't update
+ logger.warning("⚠️ Section content may not have updated within timeout")
+ new_content = content_locator.text_content(timeout=3000).strip()
+ return new_content
+
+ def regenerate_all_sections(self, additional_instruction="add max 150 words"):
+ """
+ Iterate through all sections, click Generate button, append instruction to existing popup prompt, and verify regeneration.
+
+ Args:
+ additional_instruction: Instruction to append to the existing section-specific prompt in the popup
+ """
+ logger.info("🔹 Starting regeneration of all sections")
+ logger.info(f"Additional instruction to append: '{additional_instruction}'")
+
+ # Get total section count
+ section_blocks = self.page.locator(
+ "//div[contains(@class,'ms-Stack') and contains(@class,'f1s274it')]"
+ )
+ total_sections = section_blocks.count()
+
+ logger.info(f"Total sections to regenerate: {total_sections}")
+
+ for i in range(total_sections):
+ logger.info(f"\n{'='*60}")
+ logger.info(f"Processing section {i + 1}/{total_sections}")
+ logger.info(f"{'='*60}")
+
+ # Get original content
+ section = section_blocks.nth(i)
+ content_locator = section.locator("//textarea")
+ original_content = content_locator.text_content(timeout=3000).strip()
+
+ # Step 1: Click Generate button for this section
+ self.click_section_generate_button(i)
+
+ # Step 2: Verify regenerate popup is displayed
+ self.verify_regenerate_popup_displayed()
+
+ # Step 3: Read existing prompt from popup and append additional instruction
+ self.update_prompt_and_regenerate(additional_instruction)
+
+ # Step 4: Verify content is updated
+ new_content = self.verify_section_content_updated(i, original_content)
+
+ with check:
+ assert new_content != original_content, f"Section {i + 1} content did not update"
+
+ logger.info(f"✅ Section {i + 1} regenerated successfully\n")
+
+ # Small delay between sections
+ self.page.wait_for_timeout(1000)
+
+ logger.info(f"\n{'='*60}")
+ logger.info("✅ All sections regenerated successfully")
+ logger.info(f"{'='*60}")
+
+ def verify_character_count_labels(self, max_chars=2000):
+ """
+ Verify that each section shows a character count label and count is less than max_chars.
+
+ Args:
+ max_chars: Maximum allowed characters (default: 2000)
+ """
+ logger.info("🔹 Verifying character count labels in all sections")
+
+ # Get all section containers
+ section_blocks = self.page.locator(
+ "//div[contains(@class,'ms-Stack') and contains(@class,'f1s274it')]"
+ )
+ total_sections = section_blocks.count()
+
+ logger.info(f"Total sections to verify: {total_sections}")
+
+ # Locator for character count label
+ char_count_locator = "span.fui-Text.___1v8ne64.fk6fouc.f1ugzwwg.f1i3iumi.figsok6.fpgzoln.f1w7gpdv.f6juhto.f1gl81tg.f2jf649.fq02s40.f4aeiui.f1locze1"
+
+ for i in range(total_sections):
+ section = section_blocks.nth(i)
+
+ # Get section title for logging
+ try:
+ title_element = section.locator(".fui-Text").first
+ title = title_element.inner_text(timeout=3000).strip()
+ except Exception:
+ title = f"Section {i + 1}"
+
+ logger.info(f"🔹 Verifying character count for: {title}")
+
+ # Scroll section into view
+ section.scroll_into_view_if_needed()
+ self.page.wait_for_timeout(300)
+
+ # Find character count label within this section
+ char_label = section.locator(char_count_locator).first
+
+ try:
+ expect(char_label).to_be_visible(timeout=5000)
+ label_text = char_label.inner_text(timeout=3000).strip()
+ logger.info(f"📊 Character count label: '{label_text}'")
+
+ # Extract the number from label text (e.g., "1551 characters remaining")
+ import re
+ match = re.search(r'(\d+)\s+characters remaining', label_text)
+
+ if match:
+ remaining_chars = int(match.group(1))
+ logger.info(f"📈 Characters remaining: {remaining_chars}")
+
+ # Verify remaining characters is less than or equal to max_chars
+ with check:
+ assert remaining_chars <= max_chars, f"{title}: Remaining chars {remaining_chars} should be <= {max_chars}"
+
+ # Calculate used characters
+ used_chars = max_chars - remaining_chars
+ logger.info(f"✅ {title}: Used {used_chars} chars, Remaining {remaining_chars} chars")
+ else:
+ logger.error(f"❌ Could not parse character count from label: '{label_text}'")
+
+ except Exception as e:
+ logger.error(f"❌ Character count label not found for {title}: {e}")
+ raise
+
+ logger.info("✅ All sections have valid character count labels")
+
+ def test_character_limit_restriction(self, section_index=0):
+ """
+ Test that a section restricts input to max 2000 characters.
+
+ Args:
+ section_index: Index of the section to test (default: 0 - first section)
+ """
+ logger.info(f"🔹 Testing character limit restriction for section {section_index + 1}")
+
+ # Get section
+ section_blocks = self.page.locator(
+ "//div[contains(@class,'ms-Stack') and contains(@class,'f1s274it')]"
+ )
+ section = section_blocks.nth(section_index)
+
+ # Get section title
+ try:
+ title_element = section.locator(".fui-Text").first
+ title = title_element.inner_text(timeout=3000).strip()
+ logger.info(f"Testing section: '{title}'")
+ except Exception:
+ logger.info(f"Testing section: 'Section {section_index + 1}'")
+
+ # Scroll section into view
+ section.scroll_into_view_if_needed()
+ self.page.wait_for_timeout(500)
+
+ # Find the textarea
+ textarea = section.locator("//textarea").first
+
+ # Create a string with more than 2000 characters (e.g., 2500 chars)
+ test_text = "A" * 2500
+ logger.info(f"Attempting to enter {len(test_text)} characters")
+
+ # Clear existing text
+ textarea.clear()
+
+ # Try to fill with 2500 characters
+ textarea.fill(test_text)
+ self.page.wait_for_timeout(1000)
+
+ # Get the actual text in textarea
+ actual_text = textarea.input_value()
+ actual_length = len(actual_text)
+
+ logger.info(f"📊 Actual characters entered: {actual_length}")
+
+ # Verify it's restricted to 2000 characters
+ with check:
+ assert actual_length == 2000, f"Text should be restricted to 2000 chars, but got {actual_length}"
+
+ logger.info(f"✅ Character limit enforced: Only 2000 characters allowed")
+
+ # Verify the character count label shows "0 characters remaining"
+ char_count_locator = "span.fui-Text.___1v8ne64.fk6fouc.f1ugzwwg.f1i3iumi.figsok6.fpgzoln.f1w7gpdv.f6juhto.f1gl81tg.f2jf649.fq02s40.f4aeiui.f1locze1"
+ char_label = section.locator(char_count_locator).first
+
+ try:
+ label_text = char_label.inner_text(timeout=3000).strip()
+ logger.info(f"📊 Character count label after max input: '{label_text}'")
+
+ with check:
+ assert "0 characters remaining" in label_text, f"Expected '0 characters remaining', got '{label_text}'"
+
+ logger.info("✅ Character count label correctly shows '0 characters remaining'")
+ except Exception as e:
+ logger.error(f"❌ Failed to verify character count label: {e}")
+ raise
+
+ return actual_length
+
+ def enter_document_title(self, title):
+ """
+ Enter a title in the document title text box on the Draft page
+
+ Args:
+ title: The title to enter in the document title field
+ """
+ try:
+ logger.info(f"🔹 Entering document title: '{title}'")
+
+ # Primary locator: by placeholder text
+ title_input = self.page.locator("input[placeholder='Enter title here']")
+
+ # Check if input field is visible
+ if not title_input.is_visible(timeout=5000):
+ # Try alternative locator: by class name
+ logger.warning("⚠️ Title input not found by placeholder, trying by class")
+ title_input = self.page.locator("input.ms-TextField-field")
+
+ # Wait for the input to be editable
+ title_input.wait_for(state="visible", timeout=5000)
+
+ # Scroll to the input field if needed
+ title_input.scroll_into_view_if_needed()
+ self.page.wait_for_timeout(500)
+
+ # Clear any existing title
+ title_input.clear()
+ self.page.wait_for_timeout(300)
+
+ # Enter new title
+ title_input.fill(title)
+ self.page.wait_for_timeout(500)
+
+ # Verify the title was entered correctly
+ entered_value = title_input.input_value()
+ if entered_value == title:
+ logger.info(f"✅ Successfully entered document title: '{title}'")
+ else:
+ logger.warning(f"⚠️ Title mismatch - Expected: '{title}', Got: '{entered_value}'")
+
+ except Exception as e:
+ logger.error(f"❌ Failed to enter document title: {e}")
+ # Note: Screenshots are only captured on test failures, not during normal page operations
+ raise
+
+ def click_export_document_button(self):
+ """
+ Click the 'Export Document' button at the bottom of the Draft page.
+ Waits for the button to be enabled before clicking to ensure document is ready.
+ """
+ try:
+ # First, ensure no section generation is in progress
+ # Check for any visible spinners indicating sections are still being generated
+ spinner_locator = self.page.locator("//div[@id='section-card-spinner']")
+ if spinner_locator.first.is_visible(timeout=2000):
+ logger.warning("⚠️ Sections still generating, waiting for completion...")
+ # Wait for all spinners to disappear (max 5 minutes for complex documents)
+ try:
+ spinner_locator.first.wait_for(state="hidden", timeout=300000)
+ logger.info("✅ All sections finished generating")
+ except Exception as e:
+ logger.warning(f"⚠️ Timeout waiting for spinners: {e}")
+
+ # Locate the Export Document button using the class and text
+ # Button structure:
Business Scenario
Click to learn more about what value this solution provides
- - **Draft templates quickly**- Put your data to work to create any kind of document that is supported by a large data library. + - **Interpret creative briefs**
+ Parse unstructured creative briefs into structured fields automatically, ensuring all campaign requirements are captured. - - **Share**
- Share with co-authors, contributors and approvers quickly. + - **Generate multimodal content**
+ Create marketing copy and images that align with your brand voice and product catalog using GPT and DALL-E 3. - - **Contextualize information**
- Provide context using natural language. Primary and secondary queries allow for access to supplemental detail – reducing cognitive load, increasing efficiency, and enabling focus on higher value work. + - **Ensure brand compliance**
+ Validate all generated content against brand guidelines with severity-categorized feedback before publication. - - **Gain confidence in responses**
- Trust responses to queries by customizing how data is referenced and returned to users, reducing the risk of hallucinated responses.
Access reference documents in the same chat window to get more detail and confirm accuracy. + - **Ground in enterprise data**
+ Leverage product information, images, and brand guidelines stored in Azure to ensure accurate, relevant content. - - **Secure data and responsible AI for innovation**
- Improve data security to minimize breaches, fostering a culture of responsible AI adoption, maximize innovation opportunities, and sustain competitive edge. + - **Secure data and responsible AI**
+ Maintain data security with managed identities and private networking while fostering responsible AI adoption.
+
Supporting documentation
### Security guidelines
-This template uses Azure Key Vault to store all connections to communicate between resources.
+This template uses [Managed Identity](https://learn.microsoft.com/entra/identity/managed-identities-azure-resources/overview) for authentication between Azure services.
-This template also uses [Managed Identity](https://learn.microsoft.com/entra/identity/managed-identities-azure-resources/overview) for local development and deployment.
+The backend runs in Azure Container Instance within a private VNet subnet, accessible only through the App Service frontend proxy. Private networking can be enabled via the `enablePrivateNetworking` parameter.
To ensure continued best practices in your own repository, we recommend that anyone creating solutions based on our templates ensure that the [Github secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning) setting is enabled.
You may want to consider additional security measures, such as:
* Enabling Microsoft Defender for Cloud to [secure your Azure resources](https://learn.microsoft.com/azure/defender-for-cloud).
-* Protecting the Azure Container Apps instance with a [firewall](https://learn.microsoft.com/azure/container-apps/waf-app-gateway) and/or [Virtual Network](https://learn.microsoft.com/azure/container-apps/networking?tabs=workload-profiles-env%2Cazure-cli).
+* Protecting the Azure App Service with [authentication](https://learn.microsoft.com/azure/app-service/overview-authentication-authorization) and/or [Virtual Network integration](https://learn.microsoft.com/azure/app-service/overview-vnet-integration).
@@ -199,7 +195,7 @@ Have questions, find a bug, or want to request a feature? [Submit a new issue](h
## Responsible AI Transparency FAQ -Please refer to [Transparency FAQ](./docs/TRANSPARENCY_FAQ.md) for responsible AI transparency details of this solution accelerator. +Please refer to [Transparency FAQ](./content-gen/docs/TRANSPARENCY_FAQ.md) for responsible AI transparency details of this solution accelerator.
diff --git a/TRANSITION_DOCUMENT.md b/TRANSITION_DOCUMENT.md new file mode 100644 index 000000000..2797fcbd6 --- /dev/null +++ b/TRANSITION_DOCUMENT.md @@ -0,0 +1,399 @@ +# Content Generation Solution Accelerator - Transition Document + +**Date:** January 16, 2026 +**Prepared for:** Incoming Engineer +**Repository:** https://github.com/hunterjam/content-generation-solution-accelerator +**Upstream:** https://github.com/microsoft/document-generation-solution-accelerator + +--- + +## 1. Project Overview + +This is a **multimodal content generation solution** for retail marketing campaigns. It uses Microsoft Agent Framework with HandoffBuilder orchestration to interpret creative briefs and generate compliant marketing content (text + images) grounded in enterprise product data and brand guidelines. + +### Key Capabilities +- Parse free-text creative briefs into structured fields +- Generate marketing copy using GPT models +- Generate marketing images using DALL-E 3 +- Validate content against brand guidelines with severity-categorized compliance checks +- Ground content in product catalog data from Cosmos DB + +--- + +## 2. System Architecture & How It Works + +### High-Level Flow + +``` +User → Frontend (React) → Backend API (Python/Quart) → Agent Orchestrator → Azure OpenAI + ↓ + Multi-Agent System + ↓ + ┌───────────────┼───────────────┐ + ↓ ↓ ↓ + TriageAgent → PlanningAgent → ResearchAgent + ↓ ↓ ↓ + TextContentAgent ImageContentAgent ComplianceAgent + ↓ ↓ ↓ + └───────────────┼───────────────┘ + ↓ + Generated Content + (Text + Image + Compliance) +``` + +### The Agent System + +The solution uses **Microsoft Agent Framework** with **HandoffBuilder orchestration**. This means agents can dynamically hand off control to each other based on context. Here's how each agent works: + +| Agent | Responsibility | Inputs | Outputs | +|-------|---------------|--------|---------| +| **TriageAgent** | Coordinator - routes requests to the right specialist | User message | Handoff decision | +| **PlanningAgent** | Parses creative briefs into structured fields, asks clarifying questions if info is missing | Free-text brief | Structured `CreativeBrief` JSON | +| **ResearchAgent** | Retrieves product data from Cosmos DB, fetches brand guidelines | Product queries | Product details, brand info | +| **TextContentAgent** | Generates marketing copy (headlines, body, CTAs, hashtags) | Brief + Products | Marketing copy JSON | +| **ImageContentAgent** | Creates DALL-E prompts and generates images | Brief + Products | Image URL + prompt | +| **ComplianceAgent** | Validates content against brand guidelines | Generated content | Violations list with severity | + +### Content Generation Workflow + +When a user submits a creative brief, this is what happens: + +1. **Brief Parsing** (PlanningAgent) + - User submits free-text brief like "Create a spring campaign for our new green paint colors" + - PlanningAgent extracts structured fields: objectives, target audience, key message, tone, deliverables + - If critical fields are missing, agent asks clarifying questions + - User confirms the parsed brief + +2. **Product Selection** (ResearchAgent) + - System queries Cosmos DB for matching products + - Products are presented to user for confirmation + - User can add/remove products from selection + +3. **Content Generation** (TextContentAgent + ImageContentAgent) + - **Text**: GPT generates headline, body copy, CTA, hashtags based on brief + products + - **Image**: DALL-E generates marketing image with product context + - If product has an image (`image_url`), it's overlaid on the generated background + +4. **Compliance Check** (ComplianceAgent) + - Validates content against brand guidelines + - Returns violations categorized by severity: + - **Error**: Must fix before use (blocks acceptance) + - **Warning**: Review recommended + - **Info**: Optional improvements + +5. **Response to User** + - Frontend displays generated content with compliance status + - User can regenerate, modify, or accept + +### Key Data Structures + +**CreativeBrief** (what the PlanningAgent extracts): +```typescript +{ + overview: string; // Campaign summary + objectives: string; // Goals and KPIs + target_audience: string; // Who it's for + key_message: string; // Core value proposition + tone_and_style: string; // Voice (professional, playful, etc.) + deliverable: string; // Output type (social post, email, etc.) + timelines: string; // Deadlines + visual_guidelines: string; // Image style requirements + cta: string; // Call to action +} +``` + +**Product** (from Cosmos DB): +```typescript +{ + product_name: string; + description: string; + tags: string; + price: number; + sku: string; + image_url?: string; // Product image for overlay + hex_value?: string; // Color hex code for paint products +} +``` + +**GeneratedContent** (what the system produces): +```typescript +{ + text_content: { + headline: string; + body: string; + cta_text: string; + tagline: string; + }; + image_content: { + image_url: string; // Generated or composite image + alt_text: string; + prompt_used: string; // The DALL-E prompt + }; + violations: ComplianceViolation[]; + requires_modification: boolean; // True if any "error" violations +} +``` + +### Image Generation Details + +The image generation has special logic for **product overlay**: + +1. If the product has an `image_url` (e.g., a paint can image): + - DALL-E generates a **background scene** (e.g., living room with the paint color) + - The product image is **composited** onto the background + - This ensures the actual product packaging appears in the marketing image + +2. If no product image: + - DALL-E generates a complete scene + - No overlay is applied + +3. **Text-free images**: The system instructs DALL-E to generate images without text overlays, as text rendering in AI images is often poor quality. + +### Frontend-Backend Communication + +The frontend uses **Server-Sent Events (SSE)** for streaming responses: + +1. Frontend calls `/api/generate/start` with brief + products +2. Backend returns a `task_id` immediately +3. Frontend polls `/api/generate/status/{task_id}` every second +4. Backend returns progress updates (heartbeats with stage info) +5. When complete, backend returns the full `GeneratedContent` + +This polling approach handles the 30-60 second generation time without timeouts. + +### Content Safety + +The system has multiple layers of content safety: + +1. **Input filtering** (`orchestrator.py`): Regex patterns block harmful requests before they reach agents +2. **Agent instructions**: Each agent has explicit refusal instructions for inappropriate content +3. **Azure OpenAI content filters**: Built-in filters on the AI models +4. **Compliance validation**: Final check against brand guidelines + +--- + +## 3. Repository Structure + +``` +content-generation-solution-accelerator/ +├── content-gen/ # Main application (THIS IS THE ACTIVE CODE) +│ ├── src/ +│ │ ├── app/ # Frontend application +│ │ │ ├── frontend/ # React + Vite + TypeScript + Fluent UI +│ │ │ │ └── src/ +│ │ │ │ ├── components/ # React components +│ │ │ │ ├── api/ # API client functions +│ │ │ │ └── types/ # TypeScript interfaces +│ │ │ └── WebApp.Dockerfile # Frontend container build +│ │ └── backend/ # Python backend +│ │ ├── agents/ # AI agent implementations +│ │ ├── api/ # API route handlers +│ │ ├── services/ # Business logic services +│ │ ├── orchestrator.py # Agent orchestration logic +│ │ ├── settings.py # Configuration/environment +│ │ └── ApiApp.Dockerfile # Backend container build +│ ├── scripts/ # Deployment and data scripts +│ │ └── post_deploy.py # Product data seeding +│ ├── infra/ # Bicep infrastructure as code +│ └── docs/ # Documentation +├── archive-doc-gen/ # Legacy document generation (separate app) +└── docs/ # Root-level documentation +``` + +--- + +## 4. Key Files Reference + +### Backend +| File | Purpose | +|------|---------| +| `src/backend/orchestrator.py` | Main agent orchestration, content generation workflow | +| `src/backend/agents/image_content_agent.py` | DALL-E image generation logic | +| `src/backend/settings.py` | All environment variables and configuration | +| `src/backend/api/` | REST API endpoints | +| `src/backend/services/` | Cosmos DB, storage, AI service integrations | + +### Frontend +| File | Purpose | +|------|---------| +| `src/app/frontend/src/App.tsx` | Main React application | +| `src/app/frontend/src/components/ChatPanel.tsx` | Main chat interface | +| `src/app/frontend/src/components/InlineContentPreview.tsx` | Content display with compliance status | +| `src/app/frontend/src/api/index.ts` | API client functions | +| `src/app/frontend/src/types/index.ts` | TypeScript type definitions | + +### Deployment +| File | Purpose | +|------|---------| +| `scripts/post_deploy.py` | Seeds sample product data to Cosmos DB | +| `infra/main.bicep` | Azure infrastructure definition | +| `azure.yaml` | Azure Developer CLI configuration | + +--- + +## 5. Recent Changes (Last Session) + +### Commits Merged to Main + +1. **Fix image generation overlay handling** - Improved how product images are overlaid on generated backgrounds +2. **Fix product/campaign logic** - Corrected color descriptions for paint products (Quiet Moss, Cloud Drift, Pine Shadow) +3. **Add multi-product handling instructions** - Enhanced orchestrator to handle campaigns with multiple products +4. **Add user guidance callouts** - Added clear "Action needed" / "Optional review" messages in UI for compliance status +5. **Remove unused components** - Cleaned up dead code: + - `ContentPreview.tsx` (replaced by `InlineContentPreview.tsx`) + - `TaskHeader.tsx` + - Unused API functions (`getProducts`, `uploadProductImage`, `getBrandGuidelines`, `getConversations`, `getConversation`) + - Unused types (`ComplianceSeverity`, `ContentResponse`) + +### Important Discovery +The frontend uses **`InlineContentPreview.tsx`** for displaying generated content, NOT `ContentPreview.tsx`. The latter was dead code and has been removed. + +--- + +## 6. Development Workflow + +### Local Development + +```bash +# Backend +cd content-gen/src/backend +pip install -r requirements.txt +python app.py + +# Frontend +cd content-gen/src/app/frontend +npm install +npm run dev +``` + +### Building & Deploying Containers + +```bash +# Build and push frontend (using ACR build) +az acr build --registry
We would like to inform you that the DocGen deployment has failed due to insufficient quota in the requested regions.
Issue Details:
• Quota check failed for GPT and Text Embedding models
• Required GPT Capacity: ${{ env.GPT_MIN_CAPACITY }}
• Required Text Embedding Capacity: ${{ env.TEXT_EMBEDDING_MIN_CAPACITY }}
• Checked Regions: ${{ vars.AZURE_REGIONS }}
Run URL: ${RUN_URL}
Please resolve the quota issue and retry the deployment.
Best regards,
Your Automation Team
We would like to inform you that the DocGen deployment process has encountered an issue and has failed to complete successfully.
Deployment Details:
• Resource Group: ${RESOURCE_GROUP}
• WAF Enabled: ${{ env.WAF_ENABLED }}
• EXP Enabled: ${{ env.EXP }}
Run URL: ${RUN_URL}
Please investigate the deployment failure at your earliest convenience.
Best regards,
Your Automation Team
We would like to inform you that the DocGen deployment has completed successfully.
Deployment Details:
• Resource Group: ${RESOURCE_GROUP}
• Web App URL: ${WEBAPP_URL}
• E2E Tests: Skipped (as configured)
Configuration:
• WAF Enabled: ${{ env.WAF_ENABLED }}
• EXP Enabled: ${{ env.EXP }}
Run URL: ${RUN_URL}
Best regards,
Your Automation Team
We would like to inform you that the DocGen deployment and testing process has completed successfully.
Deployment Details:
• Resource Group: ${RESOURCE_GROUP}
• Web App URL: ${WEBAPP_URL}
• E2E Tests: Passed
• Test Report: View Report
Configuration:
• WAF Enabled: ${{ env.WAF_ENABLED }}
• EXP Enabled: ${{ env.EXP }}
Run URL: ${RUN_URL}
Best regards,
Your Automation Team
We would like to inform you that test automation process has encountered issues and failed to complete successfully.
Deployment Details:
• Resource Group: ${RESOURCE_GROUP}
• Web App URL: ${WEBAPP_URL}
• Deployment Status: ✅ Success
• E2E Tests: ❌ Failed
Test Details:
• Test Report: View Report
Run URL: ${RUN_URL}
Please investigate the matter at your earliest convenience.
Best regards,
Your Automation Team
The DocGen pipeline executed against the existing WebApp URL and testing process has completed successfully.
Test Results:
• Status: ✅ Passed
${TEST_REPORT_URL:+• Test Report: View Report}
• Target URL: ${EXISTING_URL}
Deployment: Skipped
Run URL: ${RUN_URL}
Best regards,
Your Automation Team
The DocGen pipeline executed against the existing WebApp URL and the test automation has encountered issues and failed to complete successfully.
Failure Details:
• Target URL: ${EXISTING_URL}
${TEST_REPORT_URL:+• Test Report: View Report}
• Deployment: Skipped
Run URL: ${RUN_URL}
Best regards,
Your Automation Team
We would like to inform you that the ${{ env.accelerator_name }} deployment has failed due to insufficient quota in the requested regions.
Issue Details:
• Quota check failed for GPT model
• Required GPT Capacity: ${{ env.GPT_MIN_CAPACITY }}
• Checked Regions: ${{ vars.AZURE_REGIONS }}
Run URL: ${RUN_URL}
Please resolve the quota issue and retry the deployment.
Best regards,
Your Automation Team
We would like to inform you that the ${{ env.accelerator_name }} deployment process has encountered an issue and has failed to complete successfully.
Deployment Details:
• Resource Group: ${RESOURCE_GROUP}
• WAF Enabled: ${{ env.WAF_ENABLED }}
• EXP Enabled: ${{ env.EXP }}
Run URL: ${RUN_URL}
Please investigate the deployment failure at your earliest convenience.
Best regards,
Your Automation Team
We would like to inform you that the ${{ env.accelerator_name }} deployment has completed successfully.
Deployment Details:
• Resource Group: ${RESOURCE_GROUP}
• Web App URL: ${WEBAPP_URL}
• E2E Tests: Skipped (as configured)
Configuration:
• WAF Enabled: ${{ env.WAF_ENABLED }}
• EXP Enabled: ${{ env.EXP }}
Run URL: ${RUN_URL}
Best regards,
Your Automation Team
We would like to inform you that the ${{ env.accelerator_name }} deployment and testing process has completed successfully.
Deployment Details:
• Resource Group: ${RESOURCE_GROUP}
• Web App URL: ${WEBAPP_URL}
• E2E Tests: Passed ✅
• Test Suite: ${TEST_SUITE_NAME}
• Test Report: View Report
Configuration:
• WAF Enabled: ${{ env.WAF_ENABLED }}
• EXP Enabled: ${{ env.EXP }}
Run URL: ${RUN_URL}
Best regards,
Your Automation Team
We would like to inform you that ${{ env.accelerator_name }} accelerator test automation process has encountered issues and failed to complete successfully.
Deployment Details:
• Resource Group: ${RESOURCE_GROUP}
• Web App URL: ${WEBAPP_URL}
• Deployment Status: ✅ Success
• E2E Tests: ❌ Failed
• Test Suite: ${TEST_SUITE_NAME}
Test Details:
• Test Report: View Report
Run URL: ${RUN_URL}
Please investigate the matter at your earliest convenience.
Best regards,
Your Automation Team
The ${{ env.accelerator_name }} pipeline executed against the specified Target URL and testing process has completed successfully.
Test Results:
• Status: ✅ Passed
• Test Suite: ${TEST_SUITE_NAME}
${TEST_REPORT_URL:+• Test Report: View Report}
• Target URL: ${EXISTING_URL}
Deployment: Skipped
Run URL: ${RUN_URL}
Best regards,
Your Automation Team
The ${{ env.accelerator_name }} pipeline executed against the specified Target URL and the test automation has encountered issues and failed to complete successfully.
Failure Details:
• Target URL: ${EXISTING_URL}
${TEST_REPORT_URL:+• Test Report: View Report}
• Test Suite: ${TEST_SUITE_NAME}
• Deployment: Skipped
Run URL: ${RUN_URL}
Best regards,
Your Automation Team
+ +
+
+[**SOLUTION OVERVIEW**](#solution-overview) \| [**QUICK DEPLOY**](#quick-deploy) \| [**BUSINESS SCENARIO**](#business-scenario) \| [**SUPPORTING DOCUMENTATION**](#supporting-documentation)
+
+
++ +**Note:** With any AI solutions you create using these templates, you are responsible for assessing all associated risks and for complying with all applicable laws and safety standards. Learn more in the transparency documents for [Agent Service](https://learn.microsoft.com/en-us/azure/ai-foundry/responsible-ai/agents/transparency-note) and [Agent Framework](https://github.com/microsoft/agent-framework/blob/main/TRANSPARENCY_FAQ.md). +
+ +
+Solution overview
+
+
+It leverages Azure OpenAI Service and Azure AI Search, to identify relevant documents, summarize unstructured information, and generate document templates.
+
+The sample data is sourced from generic AI-generated promissory notes. The documents are intended for use as sample data only.
+
+### Solution architecture
+||
+|---|
+
+
++ +### Additional resources + +[Azure OpenAI Service](https://learn.microsoft.com/en-us/azure/ai-services/openai/) + +[Azure AI Search](https://learn.microsoft.com/en-us/azure/search/) + +[Azure AI Foundry](https://learn.microsoft.com/en-us/azure/ai-studio/) + + +
+ +### Key features +
+
+ Azure AI Search to enable RAG and grounding of the application on the processed dataset. + + - **Summarization**
+ Azure OpenAI Service and GPT models to help summarize the search content and answer questions. + + - **Content generation**
+ Azure OpenAI Service and GPT models to help generate relevant content with Prompt Flow. + +
+
+
+
+Click to learn more about the key features this solution enables
+ + - **Semantic search**+ Azure AI Search to enable RAG and grounding of the application on the processed dataset. + + - **Summarization**
+ Azure OpenAI Service and GPT models to help summarize the search content and answer questions. + + - **Content generation**
+ Azure OpenAI Service and GPT models to help generate relevant content with Prompt Flow. + +
+
+Quick deploy
+
+
+### How to install or deploy
+Follow the quick deploy steps on the deployment guide to deploy this solution to your own Azure subscription.
+
+> **Note:** This solution accelerator requires **Azure Developer CLI (azd) version 1.18.0 or higher**. Please ensure you have the latest version installed before proceeding with deployment. [Download azd here](https://learn.microsoft.com/en-us/azure/developer/azure-developer-cli/install-azd).
+
+[Click here to launch the deployment guide](./docs/DeploymentGuide.md)
++ +**For Local Development** +- [Local Development Setup Guide](docs/LocalDevelopmentSetup.md) - Comprehensive setup instructions for Windows, Linux, and macOS + +| [](https://codespaces.new/microsoft/document-generation-solution-accelerator) | [](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/microsoft/document-generation-solution-accelerator) | [&message=Open&color=blue&logo=visualstudiocode&logoColor=white)](https://vscode.dev/azure/?vscode-azure-exp=foundry&agentPayload=eyJiYXNlVXJsIjogImh0dHBzOi8vcmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbS9taWNyb3NvZnQvZG9jdW1lbnQtZ2VuZXJhdGlvbi1zb2x1dGlvbi1hY2NlbGVyYXRvci9yZWZzL2hlYWRzL21haW4vaW5mcmEvdnNjb2RlX3dlYiIsICJpbmRleFVybCI6ICIvaW5kZXguanNvbiIsICJ2YXJpYWJsZXMiOiB7ImFnZW50SWQiOiAiIiwgImNvbm5lY3Rpb25TdHJpbmciOiAiIiwgInRocmVhZElkIjogIiIsICJ1c2VyTWVzc2FnZSI6ICIiLCAicGxheWdyb3VuZE5hbWUiOiAiIiwgImxvY2F0aW9uIjogIiIsICJzdWJzY3JpcHRpb25JZCI6ICIiLCAicmVzb3VyY2VJZCI6ICIiLCAicHJvamVjdFJlc291cmNlSWQiOiAiIiwgImVuZHBvaW50IjogIiJ9LCAiY29kZVJvdXRlIjogWyJhaS1wcm9qZWN0cy1zZGsiLCAicHl0aG9uIiwgImRlZmF1bHQtYXp1cmUtYXV0aCIsICJlbmRwb2ludCJdfQ==) | +|---|---|---| + +
+ +> ⚠️ **Important: Check Azure OpenAI Quota Availability** +
To ensure sufficient quota is available in your subscription, please follow [quota check instructions guide](./docs/QuotaCheck.md) before you deploy the solution. + +
+ +### Prerequisites and costs + +To deploy this solution accelerator, ensure you have access to an [Azure subscription](https://azure.microsoft.com/free/) with the necessary permissions to create **resource groups, resources, app registrations, and assign roles at the resource group level**. This should include Contributor role at the subscription level and Role Based Access Control role on the subscription and/or resource group level. Follow the steps in [Azure Account Set Up](./docs/AzureAccountSetUp.md). + +Check the [Azure Products by Region](https://azure.microsoft.com/en-us/explore/global-infrastructure/products-by-region/?products=all®ions=all) page and select a **region** where the following services are available. + +Pricing varies per region and usage, so it isn't possible to predict exact costs for your usage. The majority of the Azure resources used in this infrastructure are on usage-based pricing tiers. However, Azure Container Registry has a fixed cost per registry per day. + +Use the [Azure pricing calculator](https://azure.microsoft.com/en-us/pricing/calculator) to calculate the cost of this solution in your subscription. + +Review a [sample pricing sheet](https://azure.com/e/2402502429fc46429e395e0bb93d0711) in the event you want to customize and scale usage. + +_Note: This is not meant to outline all costs as selected SKUs, scaled use, customizations, and integrations into your own tenant can affect the total consumption of this sample solution. The sample pricing sheet is meant to give you a starting point to customize the estimate for your specific needs._ + +
+ +| Product | Description | Cost | +|---|---|---| +| [Azure AI Foundry](https://learn.microsoft.com/en-us/azure/ai-foundry/) | Free tier. Build generative AI applications on an enterprise-grade platform. | [Pricing](https://azure.microsoft.com/pricing/details/ai-studio/) | +| [Azure AI Search](https://learn.microsoft.com/en-us/azure/search/) | Standard tier, S1. Pricing is based on the number of documents and operations. Information retrieval at scale for vector and text content in traditional or generative search scenarios. | [Pricing](https://azure.microsoft.com/pricing/details/search/) | +| [Azure Storage Account](https://learn.microsoft.com/en-us/azure/storage/blobs/) | Standard tier, LRS. Pricing is based on storage and operations. Blob storage in the clopud, optimized for storing massive amounts of unstructured data. | [Pricing](https://azure.microsoft.com/pricing/details/storage/blobs/) | +| [Azure Key Vault](https://learn.microsoft.com/en-us/azure/key-vault/) | Standard tier. Pricing is based on the number of operations. Maintain keys that access and encrypt your cloud resources, apps, and solutions. | [Pricing](https://azure.microsoft.com/pricing/details/key-vault/) | +| [Azure AI Services](https://learn.microsoft.com/en-us/azure/ai-services/) | S0 tier, defaults to gpt-4.1 and text-embedding-ada-002 models. Pricing is based on token count. | [Pricing](https://azure.microsoft.com/pricing/details/cognitive-services/) | +| [Azure Container App](https://learn.microsoft.com/en-us/azure/container-apps/) | Consumption tier with 0.5 CPU, 1GiB memory/storage. Pricing is based on resource allocation, and each month allows for a certain amount of free usage. Allows you to run containerized applications without worrying about orchestration or infrastructure. | [Pricing](https://azure.microsoft.com/pricing/details/container-apps/) | +| [Azure Container Registry](https://learn.microsoft.com/en-us/azure/container-registry/) | Basic tier. Build, store, and manage container images and artifacts in a private registry for all types of container deployments | [Pricing](https://azure.microsoft.com/pricing/details/container-registry/) | +| [Log analytics](https://learn.microsoft.com/en-us/azure/azure-monitor/) | Pay-as-you-go tier. Costs based on data ingested. Collect and analyze on telemetry data generated by Azure. | [Pricing](https://azure.microsoft.com/pricing/details/monitor/) | +| [Azure Cosmos DB](https://learn.microsoft.com/en-us/azure/cosmos-db/) | Fully managed, distributed NoSQL, relational, and vector database for modern app development. | [Pricing](https://azure.microsoft.com/en-us/pricing/details/cosmos-db/autoscale-provisioned/) | + + + +
+ +>⚠️ **Important:** To avoid unnecessary costs, remember to take down your app if it's no longer in use, +either by deleting the resource group in the Portal or running `azd down`. + +
+
+Business Scenario
+
+
+
+||
+|---|
+
++ +Put your data to work by reducing blank page anxiety, speeding up document drafting, improving draft document quality, and reference information quickly - keeping experts in their expertise. Draft document templates for your organization including Invoices, End-user Contracts, Purchase Orders, Investment Proposals, and Grant Submissions. + +⚠️ The sample data used in this repository is synthetic and generated using Azure OpenAI Service. The data is intended for use as sample data only. + + +### Business value +
+
+ Put your data to work to create any kind of document that is supported by a large data library. + + - **Share**
+ Share with co-authors, contributors and approvers quickly. + + - **Contextualize information**
+ Provide context using natural language. Primary and secondary queries allow for access to supplemental detail – reducing cognitive load, increasing efficiency, and enabling focus on higher value work. + + - **Gain confidence in responses**
+ Trust responses to queries by customizing how data is referenced and returned to users, reducing the risk of hallucinated responses.
Access reference documents in the same chat window to get more detail and confirm accuracy. + + - **Secure data and responsible AI for innovation**
+ Improve data security to minimize breaches, fostering a culture of responsible AI adoption, maximize innovation opportunities, and sustain competitive edge. + + +
+
+Click to learn more about what value this solution provides
+ + - **Draft templates quickly**+ Put your data to work to create any kind of document that is supported by a large data library. + + - **Share**
+ Share with co-authors, contributors and approvers quickly. + + - **Contextualize information**
+ Provide context using natural language. Primary and secondary queries allow for access to supplemental detail – reducing cognitive load, increasing efficiency, and enabling focus on higher value work. + + - **Gain confidence in responses**
+ Trust responses to queries by customizing how data is referenced and returned to users, reducing the risk of hallucinated responses.
Access reference documents in the same chat window to get more detail and confirm accuracy. + + - **Secure data and responsible AI for innovation**
+ Improve data security to minimize breaches, fostering a culture of responsible AI adoption, maximize innovation opportunities, and sustain competitive edge. + + +
+ +
+Supporting documentation
+
+
+### Security guidelines
+
+This template uses Azure Key Vault to store all connections to communicate between resources.
+
+This template also uses [Managed Identity](https://learn.microsoft.com/entra/identity/managed-identities-azure-resources/overview) for local development and deployment.
+
+To ensure continued best practices in your own repository, we recommend that anyone creating solutions based on our templates ensure that the [Github secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning) setting is enabled.
+
+You may want to consider additional security measures, such as:
+
+* Enabling Microsoft Defender for Cloud to [secure your Azure resources](https://learn.microsoft.com/azure/defender-for-cloud).
+* Protecting the Azure Container Apps instance with a [firewall](https://learn.microsoft.com/azure/container-apps/waf-app-gateway) and/or [Virtual Network](https://learn.microsoft.com/azure/container-apps/networking?tabs=workload-profiles-env%2Cazure-cli).
+
++ +### Cross references +Check out similar solution accelerators + +| Solution Accelerator | Description | +|---|---| +| [Chat with your data](https://github.com/Azure-Samples/chat-with-your-data-solution-accelerator) | Chat with their own data by combining Azure Cognitive Search and Large Language Models (LLMs) to create a conversational search experience. It enables increased user efficiency by minimizing endpoints required to access internal company knowledgebases. | +| [Document knowledge mining](https://github.com/microsoft/Document-Knowledge-Mining-Solution-Accelerator) | Built on Azure OpenAI Service and Azure AI Document Intelligence to process and extract summaries, entities, and metadata from unstructured, multi-modal documents and enable searching and chatting over this data. | +| [Build your own copilot](https://github.com/microsoft/Build-your-own-copilot-Solution-Accelerator) | Helps client advisors to save time and prepare relevant discussion topics for scheduled meetings with overviews, client profile views, and chatting with structured data. | + + +
+ + +## Provide feedback + +Have questions, find a bug, or want to request a feature? [Submit a new issue](https://github.com/microsoft/document-generation-solution-accelerator/issues) on this repo and we'll connect. + +
+ +## Responsible AI Transparency FAQ +Please refer to [Transparency FAQ](./docs/TRANSPARENCY_FAQ.md) for responsible AI transparency details of this solution accelerator. + +
+ +## Disclaimers + +This release is an artificial intelligence (AI) system that generates text based on user input. The text generated by this system may include ungrounded content, meaning that it is not verified by any reliable source or based on any factual data. The data included in this release is synthetic, meaning that it is artificially created by the system and may contain factual errors or inconsistencies. Users of this release are responsible for determining the accuracy, validity, and suitability of any content generated by the system for their intended purposes. Users should not rely on the system output as a source of truth or as a substitute for human judgment or expertise. + +This release only supports English language input and output. Users should not attempt to use the system with any other language or format. The system output may not be compatible with any translation tools or services, and may lose its meaning or coherence if translated. + +This release does not reflect the opinions, views, or values of Microsoft Corporation or any of its affiliates, subsidiaries, or partners. The system output is solely based on the system's own logic and algorithms, and does not represent any endorsement, recommendation, or advice from Microsoft or any other entity. Microsoft disclaims any liability or responsibility for any damages, losses, or harms arising from the use of this release or its output by any user or third party. + +This release does not provide any financial advice, and is not designed to replace the role of qualified client advisors in appropriately advising clients. Users should not use the system output for any financial decisions or transactions, and should consult with a professional financial advisor before taking any action based on the system output. Microsoft is not a financial institution or a fiduciary, and does not offer any financial products or services through this release or its output. + +This release is intended as a proof of concept only, and is not a finished or polished product. It is not intended for commercial use or distribution, and is subject to change or discontinuation without notice. Any planned deployment of this release or its output should include comprehensive testing and evaluation to ensure it is fit for purpose and meets the user's requirements and expectations. Microsoft does not guarantee the quality, performance, reliability, or availability of this release or its output, and does not provide any warranty or support for it. + +This Software requires the use of third-party components which are governed by separate proprietary or open-source licenses as identified below, and you must comply with the terms of each applicable license in order to use the Software. You acknowledge and agree that this license does not grant you a license or other right to use any such third-party proprietary or open-source components. + +To the extent that the Software includes components or code used in or derived from Microsoft products or services, including without limitation Microsoft Azure Services (collectively, “Microsoft Products and Services”), you must also comply with the Product Terms applicable to such Microsoft Products and Services. You acknowledge and agree that the license governing the Software does not grant you a license or other right to use Microsoft Products and Services. Nothing in the license or this ReadMe file will serve to supersede, amend, terminate or modify any terms in the Product Terms for any Microsoft Products and Services. + +You must also comply with all domestic and international export laws and regulations that apply to the Software, which include restrictions on destinations, end users, and end use. For further information on export restrictions, visit https://aka.ms/exporting. + +You acknowledge that the Software and Microsoft Products and Services (1) are not designed, intended or made available as a medical device(s), and (2) are not designed or intended to be a substitute for professional medical advice, diagnosis, treatment, or judgment and should not be used to replace or as a substitute for professional medical advice, diagnosis, treatment, or judgment. Customer is solely responsible for displaying and/or obtaining appropriate consents, warnings, disclaimers, and acknowledgements to end users of Customer’s implementation of the Online Services. + +You acknowledge the Software is not subject to SOC 1 and SOC 2 compliance audits. No Microsoft technology, nor any of its component technologies, including the Software, is intended or made available as a substitute for the professional advice, opinion, or judgment of a certified financial services professional. Do not use the Software to replace, substitute, or provide professional financial advice or judgment. + +BY ACCESSING OR USING THE SOFTWARE, YOU ACKNOWLEDGE THAT THE SOFTWARE IS NOT DESIGNED OR INTENDED TO SUPPORT ANY USE IN WHICH A SERVICE INTERRUPTION, DEFECT, ERROR, OR OTHER FAILURE OF THE SOFTWARE COULD RESULT IN THE DEATH OR SERIOUS BODILY INJURY OF ANY PERSON OR IN PHYSICAL OR ENVIRONMENTAL DAMAGE (COLLECTIVELY, “HIGH-RISK USE”), AND THAT YOU WILL ENSURE THAT, IN THE EVENT OF ANY INTERRUPTION, DEFECT, ERROR, OR OTHER FAILURE OF THE SOFTWARE, THE SAFETY OF PEOPLE, PROPERTY, AND THE ENVIRONMENT ARE NOT REDUCED BELOW A LEVEL THAT IS REASONABLY, APPROPRIATE, AND LEGAL, WHETHER IN GENERAL OR IN A SPECIFIC INDUSTRY. BY ACCESSING THE SOFTWARE, YOU FURTHER ACKNOWLEDGE THAT YOUR HIGH-RISK USE OF THE SOFTWARE IS AT YOUR OWN RISK. diff --git a/archive-doc-gen/SECURITY.md b/archive-doc-gen/SECURITY.md new file mode 100644 index 000000000..96d73bc27 --- /dev/null +++ b/archive-doc-gen/SECURITY.md @@ -0,0 +1,41 @@ + + +## Security + +Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet) and [Xamarin](https://github.com/xamarin). + +If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://aka.ms/security.md/definition), please report it to us as described below. + +## Reporting Security Issues + +**Please do not report security vulnerabilities through public GitHub issues.** + +Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://aka.ms/security.md/msrc/create-report). + +If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com). If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://aka.ms/security.md/msrc/pgp). + +You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc). + +Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue: + + * Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.) + * Full paths of source file(s) related to the manifestation of the issue + * The location of the affected source code (tag/branch/commit or direct URL) + * Any special configuration required to reproduce the issue + * Step-by-step instructions to reproduce the issue + * Proof-of-concept or exploit code (if possible) + * Impact of the issue, including how an attacker might exploit the issue + +This information will help us triage your report more quickly. + +If you are reporting for a bug bounty, more complete reports can contribute to a higher bounty award. Please visit our [Microsoft Bug Bounty Program](https://aka.ms/security.md/msrc/bounty) page for more details about our active programs. + +## Preferred Languages + +We prefer all communications to be in English. + +## Policy + +Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://aka.ms/security.md/cvd). + + \ No newline at end of file diff --git a/archive-doc-gen/SUPPORT.md b/archive-doc-gen/SUPPORT.md new file mode 100644 index 000000000..2c42db0f8 --- /dev/null +++ b/archive-doc-gen/SUPPORT.md @@ -0,0 +1,13 @@ +# Support + +## How to file issues and get help + +This project uses GitHub Issues to track bugs and feature requests. Please search the existing +issues before filing new issues to avoid duplicates. For new issues, file your bug or +feature request as a new Issue. + +For help and questions about using this project, please submit an issue on this repository. + +## Microsoft Support Policy + +Support for this repository is limited to the resources listed above. \ No newline at end of file diff --git a/app-azure.yaml b/archive-doc-gen/app-azure.yaml similarity index 100% rename from app-azure.yaml rename to archive-doc-gen/app-azure.yaml diff --git a/azure.yaml b/archive-doc-gen/azure.yaml similarity index 100% rename from azure.yaml rename to archive-doc-gen/azure.yaml diff --git a/archive-doc-gen/azure_custom.yaml b/archive-doc-gen/azure_custom.yaml new file mode 100644 index 000000000..af8bae654 --- /dev/null +++ b/archive-doc-gen/azure_custom.yaml @@ -0,0 +1,48 @@ +environment: + name: document-generation + location: eastus + +name: document-generation +metadata: + template: document-generation@1.0 + +requiredVersions: + azd: '>= 1.18.0' + +parameters: + solutionPrefix: + type: string + default: bs-azdtest + otherLocation: + type: string + default: eastus2 + baseUrl: + type: string + default: 'https://github.com/microsoft/document-generation-solution-accelerator' + +services: + webapp: + project: ./src + language: py + host: appservice + dist: ./dist + hooks: + prepackage: + windows: + shell: pwsh + run: ../infra/scripts/package_webapp.ps1 + interactive: true + continueOnError: false + posix: + shell: sh + run: bash ../infra/scripts/package_webapp.sh + interactive: true + continueOnError: false + +deployment: + mode: Incremental + template: ./infra/main.bicep # Path to the main.bicep file inside the 'deployment' folder + parameters: + solutionPrefix: ${parameters.solutionPrefix} + otherLocation: ${parameters.otherLocation} + baseUrl: ${parameters.baseUrl} diff --git a/docs/ACRBuildAndPushGuide.md b/archive-doc-gen/docs/ACRBuildAndPushGuide.md similarity index 100% rename from docs/ACRBuildAndPushGuide.md rename to archive-doc-gen/docs/ACRBuildAndPushGuide.md diff --git a/docs/AppAuthentication.md b/archive-doc-gen/docs/AppAuthentication.md similarity index 100% rename from docs/AppAuthentication.md rename to archive-doc-gen/docs/AppAuthentication.md diff --git a/docs/AzureAccountSetUp.md b/archive-doc-gen/docs/AzureAccountSetUp.md similarity index 100% rename from docs/AzureAccountSetUp.md rename to archive-doc-gen/docs/AzureAccountSetUp.md diff --git a/docs/AzureGPTQuotaSettings.md b/archive-doc-gen/docs/AzureGPTQuotaSettings.md similarity index 100% rename from docs/AzureGPTQuotaSettings.md rename to archive-doc-gen/docs/AzureGPTQuotaSettings.md diff --git a/docs/AzureSemanticSearchRegion.md b/archive-doc-gen/docs/AzureSemanticSearchRegion.md similarity index 100% rename from docs/AzureSemanticSearchRegion.md rename to archive-doc-gen/docs/AzureSemanticSearchRegion.md diff --git a/docs/CustomizingAzdParameters.md b/archive-doc-gen/docs/CustomizingAzdParameters.md similarity index 100% rename from docs/CustomizingAzdParameters.md rename to archive-doc-gen/docs/CustomizingAzdParameters.md diff --git a/docs/DeleteResourceGroup.md b/archive-doc-gen/docs/DeleteResourceGroup.md similarity index 100% rename from docs/DeleteResourceGroup.md rename to archive-doc-gen/docs/DeleteResourceGroup.md diff --git a/docs/DeploymentGuide.md b/archive-doc-gen/docs/DeploymentGuide.md similarity index 96% rename from docs/DeploymentGuide.md rename to archive-doc-gen/docs/DeploymentGuide.md index e04307df4..a6b4c2789 100644 --- a/docs/DeploymentGuide.md +++ b/archive-doc-gen/docs/DeploymentGuide.md @@ -117,7 +117,7 @@ Select one of the following options to deploy the Document Generation Solution A