diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml index 3cba0e5..dc0e364 100644 --- a/.github/workflows/pages.yml +++ b/.github/workflows/pages.yml @@ -28,7 +28,7 @@ jobs: - name: Checkout uses: actions/checkout@v4 - name: Setup Pages - uses: actions/configure-pages@v4 + uses: actions/configure-pages@v5 - name: Build with Jekyll uses: actions/jekyll-build-pages@v1 with: diff --git a/docs/github-pages.md b/docs/github-pages.md index e2309f8..b88adf3 100644 --- a/docs/github-pages.md +++ b/docs/github-pages.md @@ -2,6 +2,18 @@ This repository is configured to use [GitHub Pages](https://pages.github.com/) to host a simple, clean website for the project. +## Initial Setup + +Before the workflow can deploy your site, you must configure your repository to use GitHub Actions for GitHub Pages. This is a one-time setup step that connects your repository's Pages settings to the `pages.yml` workflow included in this template. + +1. **Navigate to Repository Settings:** Go to the main page of your repository and click on the **Settings** tab. +2. **Select Pages:** In the left-hand sidebar, click on **Pages**. +3. **Set the Deployment Source:** Under the "Build and deployment" section, you will see a **Source** option. Select **"GitHub Actions"** from the dropdown menu. + +After you select "GitHub Actions", the UI may present you with suggestions for common workflows (e.g., "GitHub Pages Jekyll", "Static HTML"). **You can ignore these suggestions.** This repository already contains a custom, pre-configured workflow (`.github/workflows/pages.yml`) that will be used automatically. + +> **Note:** If you do not perform this setup step, the `pages.yml` workflow will fail with a "Get Pages site failed" or "HttpError: Not Found" error. + ## How It Works The site is built and deployed by the `.github/workflows/pages.yml` workflow. Here's a summary of the process: