Skip to content
Dev0 Docs

Azure Static Web Apps

SWA CLI

Installing

Terminal window
npm install -g @azure/static-web-apps-cli

Installing the package will make the swa command available on your development machine. To validate your install, you can check the installed version with:

Terminal window
swa --version # Should print out the version number

Basic usage​

The best way to get started is to run the swa command alone and follow the interactive prompts.

Terminal window
swa

It will generate a configuration for you, then build your project and ask if you want to deploy it to Azure.

See swa for more details.

Changing node version

=this.source[1]

We must edit our project’s package.json to specify a node version. Add the following code into your package.json file.

"engines": {
    "node": ">=16.0.0"
}

Updating Ruby

To make the Azure SWA GHA run a newer version of [[Ruby]] declare it at the top of your Gemfile

source "https://rubygems.org"
ruby '>=3.0'

[[Github Actions]]

Publish the URL of a Preview site from a PR as a comment on that PR

By default the Azure SWA GHA lacks the permissions required to post comments on a PR, you need to add the permissions in the build_deploy job

jobs:
  build_and_deploy_job:
    if: github.event_name == 'push' || (github.event_name == 'pull_request' && github.event.action != 'closed')
    runs-on: ubuntu-latest
    name: Build and Deploy Job
    permissions:
      pull-requests: write

Workable baseline

# Created using example build configuration that runs on commit or PR and closes the PR if that was the trigger
# https://learn.microsoft.com/en-us/azure/static-web-apps/build-configuration?tabs=github-actions#build-configuration
name: Azure Static Web Apps CI/CD


permissions:
  contents: write
  pull-requests: write


on:
  push:
    branches:
      - main
  pull_request:
    types: [opened, synchronize, reopened, closed]
    branches:
      - main
  workflow_dispatch:


concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true


jobs:
  build_and_deploy_job:
    if: github.event_name == 'push' || (github.event_name == 'pull_request' && github.event.action != 'closed')
    runs-on: ubuntu-latest
    name: Build and Deploy Job
    steps:
      - uses: actions/checkout@v2
        with:
          submodules: true
      - name: Build And Deploy
        id: builddeploy
        uses: Azure/static-web-apps-deploy@v1
        with:
          azure_static_web_apps_api_token: ${{ secrets.AZURE_STATIC_WEB_APPS_API_TOKEN_YELLOW_DESERT_05082F70F }}
          repo_token: ${{ secrets.GITHUB_TOKEN }} # Used for Github integrations (i.e. PR comments)
          action: "upload"
          ###### Repository/Build Configurations ######
          app_location: "." # App source code path relative to repository root
          api_location: "" # Api source code path relative to repository root - optional
          output_location: "dist" # Built app content directory, relative to app_location - optional
          ###### End of Repository/Build Configurations ######


# This will run on a PR. If the site is built correctly it will merge the PR and close the staging site.
  merge_pr:
    needs: build_and_deploy_job
    if: github.event_name == 'pull_request'
    runs-on: ubuntu-latest
    steps:
      - name: Merge PR
        run: gh pr merge --auto --merge "$PR_URL"
        env:
          PR_URL: ${{github.event.pull_request.html_url}}
          GH_TOKEN: ${{secrets.GITHUB_TOKEN}}
      - name: Close Staging Site
        id: closestagingsite
        uses: Azure/static-web-apps-deploy@v1
        with:
          azure_static_web_apps_api_token: ${{ secrets.AZURE_STATIC_WEB_APPS_API_TOKEN_YELLOW_DESERT_05082F70F }}
          action: "close"


# This will run on a "close", not a merge. It will close the staging site.
  close_pr:
    if: github.event_name == 'pull_request' && github.event.action == 'closed'
    runs-on: ubuntu-latest
    name: Close Pull Request Job
    steps:
      - name: Close Staging Site
        id: closestagingsite
        uses: Azure/static-web-apps-deploy@v1
        with:
          azure_static_web_apps_api_token: ${{ secrets.AZURE_STATIC_WEB_APPS_API_TOKEN_YELLOW_DESERT_05082F70F }}
          action: "close"

Deployment token

To obtain your deployment token to make your own [[Azure Static Web Apps|SWA]] [[Github Actions|GHA]] open your SWA on the Azure portal page and find “Manage Deployment Token” on the main “Overview” page.

https://github.com/Azure/static-web-apps/issues/1489

SWA Deploy in CICD fails to complete

Deploying project to Azure Static Web Apps...
Could not find StaticSitesClient local binary
- Downloading https://swalocaldeployv2-bndtgugjgqc3dhdx.b01.azurefd.net/downloads/694f9b1be52be00b1b4cde5deb5bb4994154f9b6/linux/StaticSitesClient@694f9b1be52be00b1b4cde5deb5bb4994154f9b6
[swa] ✔ Downloading https://swalocaldeployv2-bndtgugjgqc3dhdx.b01.azurefd.net/downloads/694f9b1be52be00b1b4cde5deb5bb4994154f9b6/linux/StaticSitesClient@694f9b1be52be00b1b4cde5deb5bb4994154f9b6
- Preparing deployment. Please wait...

Seen above, there is no log after “Preparing”. Adding --verbose=silly till tell us it is downloading the StaticSitesClient to Deploying using /root/.swa/deploy/694f9b1be52be00b1b4cde5deb5bb4994154f9b6/StaticSitesClient@694f9b1be52be00b1b4cde5deb5bb4994154f9b6.

If we execute that we will see it has an error

[swa] ✔ Downloading https://swalocaldeployv2-bndtgugjgqc3dhdx.b01.azurefd.net/downloads/694f9b1be52be00b1b4cde5deb5bb4994154f9b6/linux/StaticSitesClient@694f9b1be52be00b1b4cde5deb5bb4994154f9b6
- Preparing deployment. Please wait...
Process terminated. Couldn't find a valid ICU package installed on the system. Please install libicu (or icu-libs) using your package manager and try again. Alternatively you can set the configuration flag System.Globalization.Invariant to true if you want to run with no globalization support. Please see https://aka.ms/dotnet-missing-libicu for more information.
   at System.Environment.FailFast(System.String)
   at System.Globalization.GlobalizationMode+Settings..cctor()
   at System.Globalization.CultureData.CreateCultureWithInvariantData()
   at System.Globalization.CultureData.get_Invariant()
   at System.Globalization.TextInfo..cctor()
   at System.String.ToLowerInvariant()
   at System.Text.EncodingHelper.GetEncodingFromCharset()
   at System.ConsolePal.GetConsoleEncoding()
   at System.Console.get_OutputEncoding()
   at System.Console.CreateOutputWriter(System.IO.Stream)
   at System.Console.<get_Out>g__EnsureInitialized|26_0()
   at System.Console.WriteLine(System.String)
   at StaticSitesClient.Program.Main(System.String[])
/var/run/act/workflow/4.sh: line 2:  4060 Aborted                 (core dumped) /root/.swa/deploy/694f9b1be52be00b1b4cde5deb5bb4994154f9b6/StaticSitesClient
⚙️ [runner]: exitcode '134': failure

We need to add the libicu package.

Sources:
  • https://azure.github.io/static-web-apps-cli/docs/use/install/
  • https://edi.wang/post/2022/1/27/how-to-specify-nodejs-version-when-building-azure-static-web-app