Skip to content

Commit bed50b4

Browse files
committed
Update archive-doc-gen with latest code from document-generation-solution-accelerator
1 parent aafdc3f commit bed50b4

85 files changed

Lines changed: 14169 additions & 5356 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

archive-doc-gen/.github/CODEOWNERS

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@
22
# Each line is a file pattern followed by one or more owners.
33

44
# These owners will be the default owners for everything in the repo.
5-
* @toherman-msft @Avijit-Microsoft @Roopan-Microsoft @Prajwal-Microsoft @Vinay-Microsoft @malrose07 @aniaroramsft
5+
* @toherman-msft @Avijit-Microsoft @Roopan-Microsoft @Prajwal-Microsoft @Vinay-Microsoft @malrose07 @aniaroramsft @nchandhi @dgp10801
66

archive-doc-gen/.github/workflows/Scheduled-Dependabot-PRs-Auto-Merge.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ jobs:
3636
runs-on: ubuntu-latest
3737
steps:
3838
- name: Checkout repository
39-
uses: actions/checkout@v5
39+
uses: actions/checkout@v6
4040

4141
- name: Install GitHub CLI
4242
run: |

archive-doc-gen/.github/workflows/azure-dev.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@ jobs:
1515
steps:
1616
# Step 1: Checkout the code from your repository
1717
- name: Checkout code
18-
uses: actions/checkout@v5
18+
uses: actions/checkout@v6
1919

2020
# Step 2: Validate the Azure template using microsoft/template-validation-action
2121
- name: Validate Azure Template
22-
uses: microsoft/template-validation-action@v0.4.3
22+
uses: microsoft/template-validation-action@v0.4.4
2323
id: validation
2424
env:
2525
AZURE_CLIENT_ID: ${{ secrets.AZURE_CLIENT_ID }}

archive-doc-gen/.github/workflows/broken-links-checker.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,15 @@ jobs:
1616

1717
steps:
1818
- name: Checkout Repo
19-
uses: actions/checkout@v5
19+
uses: actions/checkout@v6
2020
with:
2121
fetch-depth: 0
2222

2323
# For PR : Get only changed markdown files
2424
- name: Get changed markdown files (PR only)
2525
id: changed-markdown-files
2626
if: github.event_name == 'pull_request'
27-
uses: tj-actions/changed-files@24d32ffd492484c1d75e0c0b894501ddb9d30d62 # v46
27+
uses: tj-actions/changed-files@e0021407031f5be11a464abee9a0776171c79891 # v46
2828
with:
2929
files: |
3030
**/*.md
@@ -34,7 +34,7 @@ jobs:
3434
- name: Check Broken Links in Changed Markdown Files
3535
id: lychee-check-pr
3636
if: github.event_name == 'pull_request' && steps.changed-markdown-files.outputs.any_changed == 'true'
37-
uses: lycheeverse/lychee-action@v2.6.1
37+
uses: lycheeverse/lychee-action@v2.7.0
3838
with:
3939
args: >
4040
--verbose --no-progress --exclude ^https?://
@@ -47,7 +47,7 @@ jobs:
4747
- name: Check Broken Links in All Markdown Files in Entire Repo (Manual Trigger)
4848
id: lychee-check-manual
4949
if: github.event_name == 'workflow_dispatch'
50-
uses: lycheeverse/lychee-action@v2.6.1
50+
uses: lycheeverse/lychee-action@v2.7.0
5151
with:
5252
args: >
5353
--verbose --no-progress --exclude ^https?://

archive-doc-gen/.github/workflows/create-release.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ jobs:
1414
runs-on: ubuntu-latest
1515
steps:
1616
- name: Checkout
17-
uses: actions/checkout@v5
17+
uses: actions/checkout@v6
1818
with:
1919
ref: ${{ github.event.workflow_run.head_sha }}
2020

Lines changed: 283 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,283 @@
1+
name: Deploy-Test-Cleanup (v2) Linux
2+
on:
3+
pull_request:
4+
branches:
5+
- main
6+
paths:
7+
- 'src/frontend/**'
8+
- 'src/**/*.py'
9+
- 'src/requirements*.txt'
10+
- 'src/WebApp.Dockerfile'
11+
- '!src/tests/**'
12+
- 'infra/**/*.bicep'
13+
- 'infra/**/*.json'
14+
- '*.yaml'
15+
- '.github/workflows/deploy-*.yml'
16+
workflow_run:
17+
workflows: ["Build Docker and Optional Push"]
18+
types:
19+
- completed
20+
branches:
21+
- main
22+
- dev
23+
- demo
24+
workflow_dispatch:
25+
inputs:
26+
azure_location:
27+
description: 'Azure Location For Deployment'
28+
required: false
29+
default: 'australiaeast'
30+
type: choice
31+
options:
32+
- 'australiaeast'
33+
- 'centralus'
34+
- 'eastasia'
35+
- 'eastus2'
36+
- 'japaneast'
37+
- 'northeurope'
38+
- 'southeastasia'
39+
- 'uksouth'
40+
resource_group_name:
41+
description: 'Resource Group Name (Optional)'
42+
required: false
43+
default: ''
44+
type: string
45+
46+
waf_enabled:
47+
description: 'Enable WAF'
48+
required: false
49+
default: false
50+
type: boolean
51+
EXP:
52+
description: 'Enable EXP'
53+
required: false
54+
default: false
55+
type: boolean
56+
build_docker_image:
57+
description: 'Build And Push Docker Image (Optional)'
58+
required: false
59+
default: false
60+
type: boolean
61+
62+
cleanup_resources:
63+
description: 'Cleanup Deployed Resources'
64+
required: false
65+
default: false
66+
type: boolean
67+
68+
run_e2e_tests:
69+
description: 'Run End-to-End Tests'
70+
required: false
71+
default: 'GoldenPath-Testing'
72+
type: choice
73+
options:
74+
- 'GoldenPath-Testing'
75+
- 'Smoke-Testing'
76+
- 'None'
77+
78+
AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID:
79+
description: 'Log Analytics Workspace ID (Optional)'
80+
required: false
81+
default: ''
82+
type: string
83+
AZURE_EXISTING_AI_PROJECT_RESOURCE_ID:
84+
description: 'AI Project Resource ID (Optional)'
85+
required: false
86+
default: ''
87+
type: string
88+
existing_webapp_url:
89+
description: 'Existing WebApp URL (Skips Deployment)'
90+
required: false
91+
default: ''
92+
type: string
93+
94+
schedule:
95+
- cron: '0 9,21 * * *' # Runs at 9:00 AM and 9:00 PM GMT
96+
permissions:
97+
contents: read
98+
actions: read
99+
jobs:
100+
validate-inputs:
101+
runs-on: ubuntu-latest
102+
outputs:
103+
validation_passed: ${{ steps.validate.outputs.passed }}
104+
azure_location: ${{ steps.validate.outputs.azure_location }}
105+
resource_group_name: ${{ steps.validate.outputs.resource_group_name }}
106+
waf_enabled: ${{ steps.validate.outputs.waf_enabled }}
107+
exp: ${{ steps.validate.outputs.exp }}
108+
build_docker_image: ${{ steps.validate.outputs.build_docker_image }}
109+
cleanup_resources: ${{ steps.validate.outputs.cleanup_resources }}
110+
run_e2e_tests: ${{ steps.validate.outputs.run_e2e_tests }}
111+
azure_env_log_analytics_workspace_id: ${{ steps.validate.outputs.azure_env_log_analytics_workspace_id }}
112+
azure_existing_ai_project_resource_id: ${{ steps.validate.outputs.azure_existing_ai_project_resource_id }}
113+
existing_webapp_url: ${{ steps.validate.outputs.existing_webapp_url }}
114+
steps:
115+
- name: Validate Workflow Input Parameters
116+
id: validate
117+
shell: bash
118+
env:
119+
INPUT_AZURE_LOCATION: ${{ github.event.inputs.azure_location }}
120+
INPUT_RESOURCE_GROUP_NAME: ${{ github.event.inputs.resource_group_name }}
121+
INPUT_WAF_ENABLED: ${{ github.event.inputs.waf_enabled }}
122+
INPUT_EXP: ${{ github.event.inputs.EXP }}
123+
INPUT_BUILD_DOCKER_IMAGE: ${{ github.event.inputs.build_docker_image }}
124+
INPUT_CLEANUP_RESOURCES: ${{ github.event.inputs.cleanup_resources }}
125+
INPUT_RUN_E2E_TESTS: ${{ github.event.inputs.run_e2e_tests }}
126+
INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID: ${{ github.event.inputs.AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID }}
127+
INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID: ${{ github.event.inputs.AZURE_EXISTING_AI_PROJECT_RESOURCE_ID }}
128+
INPUT_EXISTING_WEBAPP_URL: ${{ github.event.inputs.existing_webapp_url }}
129+
run: |
130+
echo "🔍 Validating workflow input parameters..."
131+
VALIDATION_FAILED=false
132+
133+
# Validate azure_location (Azure region format)
134+
LOCATION="${INPUT_AZURE_LOCATION:-australiaeast}"
135+
136+
if [[ ! "$LOCATION" =~ ^[a-z0-9]+$ ]]; then
137+
echo "❌ ERROR: azure_location '$LOCATION' is invalid. Must contain only lowercase letters and numbers"
138+
VALIDATION_FAILED=true
139+
else
140+
echo "✅ azure_location: '$LOCATION' is valid"
141+
fi
142+
143+
# Validate resource_group_name (Azure naming convention, optional)
144+
if [[ -n "$INPUT_RESOURCE_GROUP_NAME" ]]; then
145+
if [[ ! "$INPUT_RESOURCE_GROUP_NAME" =~ ^[a-zA-Z0-9._\(\)-]+$ ]] || [[ "$INPUT_RESOURCE_GROUP_NAME" =~ \.$ ]]; then
146+
echo "❌ ERROR: resource_group_name '$INPUT_RESOURCE_GROUP_NAME' is invalid. Must contain only alphanumerics, periods, underscores, hyphens, and parentheses. Cannot end with period."
147+
VALIDATION_FAILED=true
148+
elif [[ ${#INPUT_RESOURCE_GROUP_NAME} -gt 90 ]]; then
149+
echo "❌ ERROR: resource_group_name '$INPUT_RESOURCE_GROUP_NAME' exceeds 90 characters (length: ${#INPUT_RESOURCE_GROUP_NAME})"
150+
VALIDATION_FAILED=true
151+
else
152+
echo "✅ resource_group_name: '$INPUT_RESOURCE_GROUP_NAME' is valid"
153+
fi
154+
else
155+
echo "✅ resource_group_name: Not provided (will be auto-generated)"
156+
fi
157+
158+
# Validate waf_enabled (boolean)
159+
WAF_ENABLED="${INPUT_WAF_ENABLED:-false}"
160+
if [[ "$WAF_ENABLED" != "true" && "$WAF_ENABLED" != "false" ]]; then
161+
echo "❌ ERROR: waf_enabled must be 'true' or 'false', got: '$WAF_ENABLED'"
162+
VALIDATION_FAILED=true
163+
else
164+
echo "✅ waf_enabled: '$WAF_ENABLED' is valid"
165+
fi
166+
167+
# Validate EXP (boolean)
168+
EXP_ENABLED="${INPUT_EXP:-false}"
169+
if [[ "$EXP_ENABLED" != "true" && "$EXP_ENABLED" != "false" ]]; then
170+
echo "❌ ERROR: EXP must be 'true' or 'false', got: '$EXP_ENABLED'"
171+
VALIDATION_FAILED=true
172+
else
173+
echo "✅ EXP: '$EXP_ENABLED' is valid"
174+
fi
175+
176+
# Validate build_docker_image (boolean)
177+
BUILD_DOCKER="${INPUT_BUILD_DOCKER_IMAGE:-false}"
178+
if [[ "$BUILD_DOCKER" != "true" && "$BUILD_DOCKER" != "false" ]]; then
179+
echo "❌ ERROR: build_docker_image must be 'true' or 'false', got: '$BUILD_DOCKER'"
180+
VALIDATION_FAILED=true
181+
else
182+
echo "✅ build_docker_image: '$BUILD_DOCKER' is valid"
183+
fi
184+
185+
# Validate cleanup_resources (boolean)
186+
CLEANUP_RESOURCES="${INPUT_CLEANUP_RESOURCES:-false}"
187+
if [[ "$CLEANUP_RESOURCES" != "true" && "$CLEANUP_RESOURCES" != "false" ]]; then
188+
echo "❌ ERROR: cleanup_resources must be 'true' or 'false', got: '$CLEANUP_RESOURCES'"
189+
VALIDATION_FAILED=true
190+
else
191+
echo "✅ cleanup_resources: '$CLEANUP_RESOURCES' is valid"
192+
fi
193+
194+
# Validate run_e2e_tests (specific allowed values)
195+
TEST_OPTION="${INPUT_RUN_E2E_TESTS:-GoldenPath-Testing}"
196+
if [[ "$TEST_OPTION" != "GoldenPath-Testing" && "$TEST_OPTION" != "Smoke-Testing" && "$TEST_OPTION" != "None" ]]; then
197+
echo "❌ ERROR: run_e2e_tests must be one of: GoldenPath-Testing, Smoke-Testing, None, got: '$TEST_OPTION'"
198+
VALIDATION_FAILED=true
199+
else
200+
echo "✅ run_e2e_tests: '$TEST_OPTION' is valid"
201+
fi
202+
203+
# Validate AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID (optional, Azure Resource ID format)
204+
if [[ -n "$INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID" ]]; then
205+
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
206+
echo "❌ ERROR: AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID is invalid. Must be a valid Azure Resource ID format:"
207+
echo " /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}"
208+
echo " Got: '$INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID'"
209+
VALIDATION_FAILED=true
210+
else
211+
echo "✅ AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID: Valid Resource ID format"
212+
fi
213+
else
214+
echo "✅ AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID: Not provided (optional)"
215+
fi
216+
217+
# Validate AZURE_EXISTING_AI_PROJECT_RESOURCE_ID (optional, Azure Resource ID format)
218+
if [[ -n "$INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID" ]]; then
219+
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
220+
echo "❌ ERROR: AZURE_EXISTING_AI_PROJECT_RESOURCE_ID is invalid. Must be a valid Azure Resource ID format:"
221+
echo " /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}"
222+
echo " Got: '$INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID'"
223+
VALIDATION_FAILED=true
224+
else
225+
echo "✅ AZURE_EXISTING_AI_PROJECT_RESOURCE_ID: Valid Resource ID format"
226+
fi
227+
else
228+
echo "✅ AZURE_EXISTING_AI_PROJECT_RESOURCE_ID: Not provided (optional)"
229+
fi
230+
231+
# Validate existing_webapp_url (optional, must start with https)
232+
if [[ -n "$INPUT_EXISTING_WEBAPP_URL" ]]; then
233+
if [[ ! "$INPUT_EXISTING_WEBAPP_URL" =~ ^https:// ]]; then
234+
echo "❌ ERROR: existing_webapp_url must start with 'https://', got: '$INPUT_EXISTING_WEBAPP_URL'"
235+
VALIDATION_FAILED=true
236+
else
237+
echo "✅ existing_webapp_url: '$INPUT_EXISTING_WEBAPP_URL' is valid"
238+
fi
239+
else
240+
echo "✅ existing_webapp_url: Not provided (will perform deployment)"
241+
fi
242+
243+
# Fail workflow if any validation failed
244+
if [[ "$VALIDATION_FAILED" == "true" ]]; then
245+
echo ""
246+
echo "❌ Parameter validation failed. Please correct the errors above and try again."
247+
exit 1
248+
fi
249+
250+
echo ""
251+
echo "✅ All input parameters validated successfully!"
252+
253+
# Output validated values
254+
echo "passed=true" >> $GITHUB_OUTPUT
255+
echo "azure_location=$LOCATION" >> $GITHUB_OUTPUT
256+
echo "resource_group_name=$INPUT_RESOURCE_GROUP_NAME" >> $GITHUB_OUTPUT
257+
echo "waf_enabled=$WAF_ENABLED" >> $GITHUB_OUTPUT
258+
echo "exp=$EXP_ENABLED" >> $GITHUB_OUTPUT
259+
echo "build_docker_image=$BUILD_DOCKER" >> $GITHUB_OUTPUT
260+
echo "cleanup_resources=$CLEANUP_RESOURCES" >> $GITHUB_OUTPUT
261+
echo "run_e2e_tests=$TEST_OPTION" >> $GITHUB_OUTPUT
262+
echo "azure_env_log_analytics_workspace_id=$INPUT_AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID" >> $GITHUB_OUTPUT
263+
echo "azure_existing_ai_project_resource_id=$INPUT_AZURE_EXISTING_AI_PROJECT_RESOURCE_ID" >> $GITHUB_OUTPUT
264+
echo "existing_webapp_url=$INPUT_EXISTING_WEBAPP_URL" >> $GITHUB_OUTPUT
265+
266+
Run:
267+
needs: validate-inputs
268+
if: needs.validate-inputs.outputs.validation_passed == 'true'
269+
uses: ./.github/workflows/deploy-orchestrator.yml
270+
with:
271+
runner_os: ubuntu-latest
272+
azure_location: ${{ needs.validate-inputs.outputs.azure_location || 'australiaeast' }}
273+
resource_group_name: ${{ needs.validate-inputs.outputs.resource_group_name || '' }}
274+
waf_enabled: ${{ needs.validate-inputs.outputs.waf_enabled == 'true' }}
275+
EXP: ${{ needs.validate-inputs.outputs.exp == 'true' }}
276+
build_docker_image: ${{ needs.validate-inputs.outputs.build_docker_image == 'true' }}
277+
cleanup_resources: ${{ needs.validate-inputs.outputs.cleanup_resources == 'true' }}
278+
run_e2e_tests: ${{ needs.validate-inputs.outputs.run_e2e_tests || 'GoldenPath-Testing' }}
279+
AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID: ${{ needs.validate-inputs.outputs.azure_env_log_analytics_workspace_id || '' }}
280+
AZURE_EXISTING_AI_PROJECT_RESOURCE_ID: ${{ needs.validate-inputs.outputs.azure_existing_ai_project_resource_id || '' }}
281+
existing_webapp_url: ${{ needs.validate-inputs.outputs.existing_webapp_url || '' }}
282+
trigger_type: ${{ github.event_name }}
283+
secrets: inherit

0 commit comments

Comments
 (0)