😊

FlutterのwebアプリをGitHub Pagesにデプロイする

2023/01/01に公開約1,600字

Flutter webアプリをGitHub Pagesにデプロイしてみました。

注意点

GitHub Pagesのルートはユーザー名.github.ioなので、ビルド時に--base-hrefオプションをつける必要があります。
baseを明示的に変更しなければ、リソースの読み込みでエラーになってしまい、真っ白なページが表示されます。

ソースコード

リポジトリ名を自分のリポジトリに置き換えてください。

gh-pages.yml
name: Deploy web app

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 one concurrent deployment
concurrency:
  group: "pages"
  cancel-in-progress: true

jobs:
  # Single deploy job since we're just deploying
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Setup Pages
        uses: actions/configure-pages@v2
      - name: Install Flutter
        uses: britannio/action-install-flutter@v1.1
      - name: Install Packages
        run: flutter pub get
      - name: Build web app
        run: flutter build web --base-href "/リポジトリ名/"
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v1
        with:
          path: './build/web'
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v1

追記:
リポジトリ名を自動取得するようにすれば、--base-hrefオプションを直書きしなくて済みそうです。
https://zenn.dev/snowcait/articles/757d0c6815227f

サンプル

試しにデプロイしてみました。
https://yunkai1841.github.io/flutter-test/#/
https://github.com/yunkai1841/flutter-test

Discussion

ログインするとコメントできます