Skip to content
layout

GitHub Action

GitHub Pages Blazor WASM

v2.0 Latest version

GitHub Pages Blazor WASM

layout

GitHub Pages Blazor WASM

Prepare Blazor WASM for GitHub Pages

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: GitHub Pages Blazor WASM

              
  uses: na1307/blazor-github-pages@v2.0
Learn more about this action in na1307/blazor-github-pages

Choose a version

GitHub Pages Blazor WASM

This action allows you to deploy your Blazor WASM app to GitHub Pages.

What this does

Restore, build, and publish the project, modify index.html to fit the repository, and create a .nojekyll file.

How to use

First, set Repository Settings - Pages - Source to GitHub Actions.

This action has four inputs and one output.

Inputs

project-path: Path of project (.csproj). Default is (repo name)/(repo name).csproj.

publish-path: Path to output in Publish step. It doesn't matter most of the time.

main-repo: Set to true only when running this action from the default GitHub Pages repository ({username}.github.io).

fix-404: Whether to apply repository-specific modifications to 404.html as well. This only takes effect when main-repo is false. Default is true.

Outputs

wwwroot-path: The resulting wwwroot path. It must be passed to path in the upload-pages-artifact step.

Example Workflow

name: Deploy

on:
  # Runs on pushes targeting the default branch
  push:
    branches: ["main"]

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
  group: "pages"
  cancel-in-progress: false

jobs:
  # Build job
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Setup .NET
        uses: actions/setup-dotnet@v4
        with:
          dotnet-version: 8.0.x
      - name: Prepare Blazor WASM for GitHub Pages
        uses: na1307/blazor-github-pages@v2
        id: prepare
        with:
          project-path: BluehillHomePage/BluehillHomePage.csproj
          main-repo: true
      - name: Setup Pages
        uses: actions/configure-pages@v5
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: ${{ steps.prepare.outputs.wwwroot-path }}

  # Deployment job
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    needs: build
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4