|
| 1 | +# GitHub Pages Deployment Setup |
| 2 | + |
| 3 | +This repository uses GitHub Actions to automatically build and deploy the Hugo site to GitHub Pages. |
| 4 | + |
| 5 | +## Setup Instructions |
| 6 | + |
| 7 | +To enable automatic deployment, you need to configure GitHub Pages in your repository settings: |
| 8 | + |
| 9 | +### 1. Enable GitHub Pages |
| 10 | + |
| 11 | +1. Go to your repository on GitHub: `https://github.com/aeshell/aeshell.github.com` |
| 12 | +2. Click on **Settings** (top menu) |
| 13 | +3. In the left sidebar, click on **Pages** (under "Code and automation") |
| 14 | +4. Under **Build and deployment**: |
| 15 | + - **Source**: Select "GitHub Actions" |
| 16 | + - This allows the workflow to deploy to GitHub Pages |
| 17 | + |
| 18 | +### 2. Trigger Deployment |
| 19 | + |
| 20 | +The workflow will automatically run when: |
| 21 | +- You push commits to the `main` or `web` branch |
| 22 | +- You manually trigger it from the Actions tab |
| 23 | + |
| 24 | +You can also manually trigger the workflow: |
| 25 | +1. Go to the **Actions** tab in your repository |
| 26 | +2. Click on "Deploy Hugo site to Pages" workflow |
| 27 | +3. Click **Run workflow** button |
| 28 | + |
| 29 | +### 3. View Your Site |
| 30 | + |
| 31 | +After the workflow completes successfully: |
| 32 | +- Your site will be available at: `https://aeshell.github.io/` (or your custom domain if configured) |
| 33 | +- You can find the URL in the workflow run under the "deploy" job |
| 34 | + |
| 35 | +## Workflow Details |
| 36 | + |
| 37 | +The workflow (`.github/workflows/hugo.yml`): |
| 38 | +- Uses Hugo v0.152.2 Extended |
| 39 | +- Installs Go 1.25 for Hugo modules |
| 40 | +- Builds the site with minification and garbage collection |
| 41 | +- Deploys to GitHub Pages using the official GitHub Actions |
| 42 | + |
| 43 | +## Custom Domain (Optional) |
| 44 | + |
| 45 | +If you want to use a custom domain: |
| 46 | +1. Add a `CNAME` file to the `static/` directory with your domain name |
| 47 | +2. Configure your DNS provider to point to GitHub Pages |
| 48 | +3. Enable HTTPS in repository settings > Pages |
| 49 | + |
| 50 | +## Troubleshooting |
| 51 | + |
| 52 | +If the deployment fails: |
| 53 | +1. Check the Actions tab for error logs |
| 54 | +2. Ensure GitHub Pages is enabled with "GitHub Actions" as the source |
| 55 | +3. Verify the repository has Pages deployment permissions enabled |
0 commit comments