AstroサイトをGitHub Pagesにデプロイする

GitHub Pagesを使って、GitHub.com上のリポジトリから直接Astroウェブサイトをホストすることができます。

デプロイ方法

GitHub Actionsを使うことで、AstroサイトをGitHub Pagesに自動的にビルドしてデプロイすることができます。これを行うには、ソースコードがGitHubでホストされている必要があります。

Astroは公式のwithastro/actionを保守しており、ほとんど設定することなくプロジェクトをデプロイすることができます。以下の手順に従って、AstroサイトをGitHubページにデプロイしてください。さらに詳しい情報が必要な場合は、パッケージのREADMEを参照してください。

astro.config.mjs に site と、必要に応じて base オプションを設定します。
astro.config.mjs
```
import { defineConfig } from 'astro/config'

export default defineConfig({
  site: 'https://astronaut.github.io',
  base: '/my-repo',
})
```
- site は https://<YOUR_USERNAME>.github.io または https://my-custom-domain.com である必要があります。
- base には、/my-repo のように、スラッシュで始まるリポジトリ名を指定します。これは、Astro があなたのウェブサイトのルートがデフォルトの / ではなく my-repo であることを理解するためです。
ノート
以下の場合は、baseパラメータを設定しないでください。
- ページがルートフォルダから配信されている場合。
- リポジトリがhttps://github.com/<USERNAME>/<USERNAME>.github.ioにある場合。
- カスタムドメインを使っている場合。
注意
もし base の値を設定しておらず、GitHub にデプロイするためだけにこの値を設定している場合は、内部ページのリンクに base を含めるように更新する必要があります。
<a href="/my-repo/about">About</a>

プロジェクトの .github/workflows/deploy.yml に新しいファイルを作成し、以下のYAMLを貼り付けます。

name: Deploy to GitHub Pages

on:
  # `main` ブランチにプッシュするたびにワークフローを実行します
  # 異なるブランチ名を使用する場合は、`main` をブランチ名に置き換えてください
  push:
    branches: [ main ]
  # このワークフローを GitHub の Actions タブから手動で実行できるようにします。
  workflow_dispatch:

# このジョブがリポジトリをクローンし、ページデプロイメントを作成することを許可します。
permissions:
  contents: read
  pages: write
  id-token: write

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout your repository using git
        uses: actions/checkout@v4
      - name: Install, build, and upload your site
        uses: withastro/action@v1
        # with:
          # path: . # リポジトリ内のAstroプロジェクトのルートロケーション。(オプション)
          # node-version: 18 # サイト構築に使用するNodeのバージョン。デフォルトは18です。（オプション）
          # package-manager: pnpm@latest # 依存関係のインストールとサイトのビルドに使用する Node パッケージマネージャ。ロックファイルに基づいて自動的に検出されます。(オプション)

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