ウェブサイトのデプロイ
概要
このスキルは、既に生成されたウェブサイトをGitHub Pagesにデプロイする手順を案内します。想定するプロジェクトは、GitHubリポジトリに格納されたAstro静的サイトであり、ソースファイルがコミットされ、デプロイはGitHub Actionsによって処理されます。
このスキルは、ウェブサイト自体が既に存在することを前提としています。ユーザーから依頼がない限り、ウェブサイトを再設計しないでください。
デプロイモデル
現在の個人ウェブサイトのワークフローには、次の設定を使用します。
- ソースコードをGitで追跡します。
node_modules/、dist/、.astro/、tmp/などの生成フォルダや依存関係フォルダは無視します。npm.cmd run buildでサイトをビルドします。- GitHub ActionsからGitHub Pagesにデプロイします。
- ローカル開発は
http://localhost:4321/で行います。 - GitHub Actionsビルド時のみ、プロジェクトPages URL(例:
https://USERNAME.github.io/REPOSITORY/)のためにAstroのbaseパスを使用します。
デプロイ前の確認
軽量なコマンドで準備状況を確認します。
git status
npm.cmd run build
以下のファイルまたは設定が存在することを確認します。
package.jsonastro.config.mjs.gitignore.github/workflows/deploy.ymlsrc/public/
このプロジェクトでは、astro.config.mjs はローカルビルドとGitHub Pagesビルドの両方をサポートする必要があります。例:
import { defineConfig } from "astro/config";
const isGithubPagesBuild = process.env.GITHUB_ACTIONS === "true";
export default defineConfig({
site: "https://USERNAME.github.io",
base: isGithubPagesBuild ? "/REPOSITORY" : "/",
});
ローカルの公開アセットや内部ページにリンクする際には、Astroのページ/レイアウトでURLヘルパーを使用します。
const base = import.meta.env.BASE_URL;
const url = (path: string) => {
const normalizedBase = base.endsWith("/") ? base : `${base}/`;
const normalizedPath = path.replace(/^\/+/g, "");
return `${normalizedBase}${normalizedPath}`;
};
GitHub Actions ワークフロー
次のようなPagesワークフローを使用します。
name: Deploy to GitHub Pages
on:
push:
branches: [main]
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: pages
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v7
- name: Build with Astro
uses: withastro/action@v6
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@v5
必要に応じて、アクションを簡単に説明します。
actions/checkout@v7: リポジトリをGitHub Actionsランナーにダウンロードします。withastro/action@v6: 依存関係をインストールし、Astroサイトをビルドし、Pagesアーティファクトを準備します。actions/deploy-pages@v5: ビルドされたアーティファクトをGitHub Pagesに公開します。
@vN のサフィックスは、アクションのメジャーバージョンを固定します。
リポジトリとコミット手順
ユーザーをガイドして、デプロイ準備が整ったソースの変更をコミットおよびプッシュします。
git status
git add .
git commit -m "Prepare website deployment"
git push origin main
Gitが改行に関する警告(LF will be replaced by CRLF など)を報告した場合は、これはWindowsの改行コード正規化に関する警告であり、通常はデプロイの妨げにならないことを説明します。
GitがユーザーIDが設定されていないと報告した場合は、コミット前にリポジトリまたはグローバルIDを設定します。プライバシーが重要な場合は、ユーザーのGitHub noreplyメールアドレスを使用します。
GitHub Pages の設定
GitHubでの手順をユーザーに案内します。
- GitHubでリポジトリを開きます。
Settingsに移動します。Pagesに移動します。Build and deploymentで、SourceをGitHub Actionsに設定します。- GitHubに保存ボタンが表示されたら保存します。
Actionsタブに移動し、最新のデプロイ実行を開きます。- ワークフローが成功するまで待ちます。
- GitHubが表示するPages URLを開きます。
プロジェクトサイトの場合、通常のURLは次のようになります。
https://USERNAME.github.io/REPOSITORY/
検証
デプロイ後、以下を確認します。
- ホームページが読み込まれる。
- ナビゲーションリンクが機能する。
- 画像が読み込まれる。
- CVのPDFなどのダウンロード可能なファイルが正しく開く。
- ブラウザのURLにプロジェクトPagesのリポジトリパスが含まれている。
- 生成されたHTMLに
/REPOSITORYprojects、/REPOSITORYprofile.jpg、/REPOSITORYfile.pdfのような壊れたパスが存在しない。
デプロイされたサイトが壊れているが、ローカルプレビューが機能する場合は、最初にベースパスの処理を確認します。
GitHub Actionsが失敗した場合は、失敗したステップを調査します。
- チェックアウトの失敗: リポジトリまたは権限の問題。
- インストール/ビルドの失敗: 依存関係、Astro、またはソースコードの問題。
- デプロイの失敗: GitHub Pagesのソース/権限/設定の問題。
完了条件
以下の条件が満たされた場合、デプロイタスクは完了と見なします。
- ローカルビルドが成功する。
- ソースの変更がコミットおよびプッシュされている。
- GitHub PagesのソースがGitHub Actionsに設定されている。
- Actionsのデプロイ実行が成功する。
- 公開されたPages URLがウェブサイトを正しく読み込む。