Azure Static Web Apps from Azure DevOps Releases

Azure Static Web Apps is an awesome new option for deploying single page applications, however I had specific goals that the current documentation didn't quite address, so here is how I met them.

My Goals

1. Deploy to Azure Static Web Apps
2. Deploy the same code to different environments (i.e. Sandbox, Test, Production)
3. Automatically deploy to Sandbox (aka Test/Staging)
4. Require approval to deploy to Production

The Microsoft Documentation for publishing from Azure Static Web Apps builds and deploys in a single step via Pipelines, however that doesn't support multiple deployments from same artifacts or an approval step.

All of those goals are possible using Azure DevOps, however it took some additional steps to get them working together.

Prerequisites

1. A Single Page Application published as an Artifact built using Azure Pipelines
   • My artifact contains two builds of an Angular app, 'sandbox' and 'prod'
   • I happened to use an Angular app, but you can apply this to any single page application framework, such as React, Vue, Ember.js or Svelte.
2. The Deployment Token from an already-created Azure Static Web App
   • Create a Static Web App section

Configure Your Release

1. In your Azure DevOps project, go to Pipelines, then Releases
2. Create a new Release Pipeline (using the "+ New \/" button)
3. Select 'Empty job' as the Template
   • We will be creating ours from scratch
4. Name your first Stage
   1. The Name can be whatever you like. I used 'Production Deployment'
5. In the Artifacts, select the Artifact that you already built
   1. Select Build as Source type
   2. Select your Source - This is the Name of your Artifact from the Prerequisites.
   3. You can update the 'Source alias' to a simpler name if you prefer
      • This will be used in your pipeline later
   4. Click the "Add" button to save your Artifact
6. Now click the "View stage tasks" link ("1 job, 0 tasks") on your existing Stage
7. Click "Agent job" above the tasks to edit the default settings
   1. Change the Agent Specification to a recent Linux build, such as ubuntu-20.04
8. Next to "Agent Job", click the "+" button to add a new Task
   1. Find the "Deploy Azure Static Web App" task (from Microsoft Corporation) and click "Add"
      • At the time of this blog post, it is currently in PREVIEW and at version 0.* (preview)
   2. Fill in the following fields of the task:
      1. Display Name - Can be anything you want
      2. App Location - Set to path of your built app in the artifact
         • Use the form "<ArtifactName>/<BuildName>/", i.e. AngularBuildArtifact/prod/
      3. Output Location - Set to path of your built app in the artifact,
         • Use the form "<ArtifactName>/<BuildName>/", i.e. AngularBuildArtifact/prod/
      4. Skip App Build - Set to true/checked. (The app is already being built and stored as an Artifact)
      5. Azure Static Web Apps Api Token - Fill in with your Deployment Token variable: $(deployment_token)
         • Follow Steps 5-10 in the Create the Pipeline Tasks section to configure a secret variable for your Deployment Token
      6. Save your Release
         • You can find my YAML for this task at the end of this post

• Note: I didn't have an Azure Functions API or routes.json, so I have left the remaining fields blank. We are also skipping the app build, so we don't need to provide an App Build Command.

Congratulations! You can now run the Release to deploy to Azure Static Web Apps.

Bonus Content - Adding Approval to the Stage

1. On the Pipelines tab, click the Pre-deployment Conditions button (at the left of the Stage button)
2. Enable Pre-Deployment Approvals
3. Fill in Approvers from your organization
4. Feel free to set the rest of the settings as necessary for your situation.

YAML for the Static Web App Task

variables:
  deployment_token: '<YourDeploymentToken>'

steps:
- task: AzureStaticWebApp@0
  displayName: 'Static Web App - Production Deployment'
  inputs:
    app_location: AngularBuildArtifact/prod/
    output_location: AngularBuildArtifact/prod/
    skip_app_build: true
    azure_static_web_apps_api_token: '$(deployment_token)'