Merge pull request #5382 from dfe-analytical-services/ees-5618

EES-5618 Cleanup public API infrastructure pipeline

infrastructure/templates/public-api/ci/azure-pipelines.yml

@@ -0,0 +1,84 @@
+trigger: none
+
+parameters:
+  - name: deployContainerApp
+    displayName: Can we deploy the Container App yet? This is dependent on the PostgreSQL Flexible Server being set up and having users manually added.
+    default: true
+  - name: updatePsqlFlexibleServer
+    displayName: Does the PostgreSQL Flexible Server require any updates? False by default to avoid unnecessarily lengthy deploys.
+    default: false
+  - name: forceDeployToEnvironment
+    displayName: Set to either dev or test to force a deploy to that environment from the chosen branch.
+    type: string
+    values:
+      - none
+      - dev
+      - test
+    default: 'none'
+
+resources:
+  pipelines:
+    - pipeline: MainBuild
+      source: Explore Education Statistics
+      trigger:
+        branches:
+          - dev
+          - test
+          - master
+
+variables:
+  - group: Public API Infrastructure - Common
+  - name: forceDeployToEnvironment
+    value: ${{parameters.forceDeployToEnvironment}}
+  - name: isDev
+    value: $[or(eq(variables['forceDeployToEnvironment'], 'dev'), eq(variables['Build.SourceBranch'], 'refs/heads/dev'))]
+  - name: isTest
+    value: $[or(eq(variables['forceDeployToEnvironment'], 'test'), eq(variables['Build.SourceBranch'], 'refs/heads/test'))]
+  - name: isMaster
+    value: $[eq(variables['Build.SourceBranch'], 'refs/heads/master')]
+  - name: vmImageName
+    value: ubuntu-latest
+  - name: deployContainerApp
+    value: ${{ parameters.deployContainerApp }}
+  - name: updatePsqlFlexibleServer
+    value: ${{ parameters.updatePsqlFlexibleServer }}
+
+pool:
+  vmImage: $(vmImageName)
+
+stages:
+  - template: stages/deploy.yml
+    parameters:
+      stageName: DeployDev
+      condition: eq(variables.isDev, true)
+      environment: Dev
+      serviceConnection: $(serviceConnectionDev)
+      bicepParamFile: dev
+
+  - template: stages/deploy.yml
+    parameters:
+      stageName: DeployTest
+      condition: eq(variables.isTest, true)
+      dependsOn: DeployDev
+      environment: Test
+      serviceConnection: $(serviceConnectionTest)
+      bicepParamFile: test
+
+#  - template: stages/deploy.yml
+#    parameters:
+#      stageName: DeployPreProd
+#      condition: eq(variables.isMaster, true)
+#      trigger: manual
+#      environment: Pre-Prod
+#      serviceConnection: $(serviceConnectionPreProd)
+#      bicepParamFile: preprod
+#
+#  - template: stages/deploy.yml
+#    parameters:
+#      stageName: DeployProd
+#      condition:  and(succeeded(), eq(variables.isMaster, true))
+#      trigger: manual
+#      dependsOn: DeployPreProd
+#      environment: Prod
+#      serviceConnection: $(serviceConnectionProd)
+#      bicepParamFile: prod

infrastructure/templates/public-api/ci/jobs/deploy-api-docs.yml

@@ -0,0 +1,54 @@
+parameters:
+  - name: serviceConnection
+    type: string
+  - name: environment
+    type: string
+  - name: dependsOn
+    type: object
+    default: []
+
+jobs:
+  - deployment: DeployPublicApiDocs
+    displayName: Deploy Public API docs
+    dependsOn: ${{ parameters.dependsOn }}
+    environment: ${{ parameters.environment }}
+    strategy:
+      runOnce:
+        deploy:
+          steps:
+            # Workaround for deprecation warning preventing deployment token for
+            # API docs from being fetched: https://github.com/Azure/azure-cli/issues/30048
+            - task: Bash@3
+              name: InstallAzureCLI
+              displayName: Install Azure CLI 2.64.0 as workaround
+              inputs:
+                targetType: inline
+                script: |
+                  set -e
+                  pip install --force-reinstall azure-cli==2.64.0
+
+            - task: AzureCLI@2
+              displayName: Get deployment token
+              inputs:
+                azureSubscription: ${{ parameters.serviceConnection }}
+                scriptType: bash
+                scriptLocation: inlineScript
+                inlineScript: |
+                  set -e
+                  deploymentToken=`az staticwebapp secrets list -n $(docsAppName) --query "properties.apiKey" -o tsv`
+                  echo "##vso[task.setvariable variable=docsDeploymentToken;]$deploymentToken"
+
+            - download: MainBuild
+              displayName: Download Public API docs artifact
+              artifact: public-api-docs
+
+            - task: AzureStaticWebApp@0
+              displayName: Deploy API docs
+              inputs:
+                app_location: /
+                output_location: '' # Leave this empty
+                skip_app_build: true
+                skip_api_build: true
+                azure_static_web_apps_api_token: $(docsDeploymentToken)
+                cwd: $(Pipeline.Workspace)/MainBuild/public-api-docs
+