Communitygithub.com

tangshengming/個人ウェブサイト

既に生成された静的個人ウェブサイトをGitHub Pagesにデプロイします。ユーザーがウェブサイトのデプロイ、生成されたAstroサイトの公開、GitHub Pagesのセットアップ、GitHub Actionsデプロイワークフローの説明や更新、またはプッシュ後にデプロイされたサイトの動作確認を依頼した場合に使用します。

個人ウェブサイト とは?

このスキルは、Astroで構築された静的個人ウェブサイトをGitHub Pagesにデプロイするための包括的なガイドを提供します。主にClaude CodeなどのAIエージェント向けに設計されており、既存のウェブサイトのデプロイに特化しています。スキルは、GitHub Actionsを使用したデプロイモデルから、リポジトリのコミット手順、GitHub Pagesの設定、デプロイ後の検証までをカバーしています。ユーザーは、ターミナルコマンドやYAML設定を通じて、スムーズなデプロイフローを実現できます。このスキルは、ウェブサイトの再設計は行わず、デプロイプロセスにのみ焦点を当てています。これにより、開発者は手間をかけずにサイトを公開し、GitHub Pagesの機能を最大限に活用できます。

対応~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/tangshengming/personal_website/tree/HEAD/.codex/skills/deploy-website

お気に入りのAIに質問する

このエージェントスキルを事前に読み込んだ状態で新しいチャットを開きます。

ドキュメント

ウェブサイトのデプロイ

概要

このスキルは、既に生成されたウェブサイトを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.json
  • astro.config.mjs
  • .gitignore
  • .github/workflows/deploy.yml
  • src/
  • 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での手順をユーザーに案内します。

  1. GitHubでリポジトリを開きます。
  2. Settings に移動します。
  3. Pages に移動します。
  4. Build and deployment で、Source を GitHub Actions に設定します。
  5. GitHubに保存ボタンが表示されたら保存します。
  6. Actions タブに移動し、最新のデプロイ実行を開きます。
  7. ワークフローが成功するまで待ちます。
  8. 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がウェブサイトを正しく読み込む。

Individual skills in this repo

This repo contains 2 individual skills — each has its own dedicated page.

関連スキル