Deploying to Azure with Static Web Apps

Prerequisites

Before you get started, you need to have:

• An Azure account.
• A commercetools account and a Project.
• A customization configured in the Merchant Center:
  • For Custom Applications, see Managing Custom Applications.
  • For Custom Views, see Managing Custom Views.

Configuration

Adding the customization identifier and URL

Depending on the customization type, you'll need to specify either the Custom Application ID or the Custom View ID that was provided to you when you added the customization in the Merchant Center.

You'll also need to specify the production URL from your Azure project. You can keep the standard Azure Static Web Apps URL https://<project>.1.azurestaticapps.net or provide your custom domain.

For Custom Applications, make the following changes to the Custom Application config:

• Add the Custom Application ID to env.production.applicationId.
• Add the production URL from your Azure project to env.production.url.

{
  "env": {
    "production": {
      "applicationId": "ckvtahxl90097sys6har1e6n3",
      "url": "https://<project>.1.azurestaticapps.net"
    }
  }
}

For Custom Views, make the following changes to the Custom View config:

• Add the Custom View ID to env.production.customViewId.
• Add the production URL from your Azure project to env.production.url.

{
  "env": {
    "production": {
      "customViewId": "ckvtahxl90097sys6har1e6n3",
      "url": "https://<project>.1.azurestaticapps.net"
    }
  }
}

Using environment variables

To avoid hardcoding values (such as the customization identifier or the Project key), you can use variable placeholders in your Custom Application config or Custom View config.

Example of environment variables with Custom Applications:

{
  "env": {
    "production": {
      "applicationId": "${env:APPLICATION_ID}",
      "url": "https://<project>.1.azurestaticapps.net"
    }
  }
}

Example of environment variables with Custom Views:

const config = {
  env: {
    production: {
      customViewId: '${env:CUSTOM_VIEW_ID}',
      url: 'https://<project>.1.azurestaticapps.net',
    },
  },
  // ...
};

Connect Azure with GitHub Actions

The easiest way to deploy to Azure is to use Static Web Apps deployment service. This service enables first-class GitHub integration.

Follow the steps in the Azure Static Web App creator to create a new project and select GitHub as the deployment source.

Configuring build settings

In the Static Web App setup process you need to configure the following things:

• Select your organization, repository and branch.
• In the Build details section select Custom as the build preset.
• Provide the following build settings:
  • App location: /
  • Output location: public

- name: Build And Deploy
  uses: Azure/static-web-apps-deploy@v1
  with:
    action: 'upload'
    app_location: '/'
    api_location: ''
    output_location: 'public'
  env:
    APPLICATION_ID: ${{ secrets.APPLICATION_ID }}
    CLOUD_IDENTIFIER: gcp-eu

Configuring rewrite rules

A customization is a Single-Page Application that uses client-side routing. Therefore, we need to instruct Azure to rewrite all requests to serve the index.html. For this purpose, create staticwebapp.config.json file in the root directory of your project with the following content:

{
  "responseOverrides": {
    "404": {
      "rewrite": "/index.html",
      "statusCode": 200
    }
  }
}

Test your deployment

Install your customization in the Merchant Center to access it within your Projects:

• For Custom Applications, see Managing Custom Applications.
• For Custom Views, see Managing Custom Views.