mirror of
https://github.com/Zie619/n8n-workflows.git
synced 2025-11-25 03:15:25 +08:00
fix: Add GitHub Pages deployment workflow and setup instructions
- Created simplified GitHub Pages deployment workflow (pages-deploy.yml) - Added comprehensive setup instructions (GITHUB_PAGES_SETUP.md) - Workflow automatically deploys /docs folder to GitHub Pages - Ready for GitHub Pages activation in repository settings IMPORTANT: GitHub Pages needs to be enabled in repository settings! To fix: Go to Settings > Pages > Source > Deploy from branch > main > /docs Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
45
.github/workflows/pages-deploy.yml
vendored
Normal file
45
.github/workflows/pages-deploy.yml
vendored
Normal file
@@ -0,0 +1,45 @@
|
||||
name: Deploy to GitHub Pages
|
||||
|
||||
on:
|
||||
# Runs on pushes targeting the default branch
|
||||
push:
|
||||
branches: ["main"]
|
||||
|
||||
# Allows you to run this workflow manually from the Actions tab
|
||||
workflow_dispatch:
|
||||
|
||||
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
|
||||
permissions:
|
||||
contents: read
|
||||
pages: write
|
||||
id-token: write
|
||||
|
||||
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
|
||||
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
|
||||
concurrency:
|
||||
group: "pages"
|
||||
cancel-in-progress: false
|
||||
|
||||
jobs:
|
||||
# Single deploy job since we're just deploying
|
||||
deploy:
|
||||
environment:
|
||||
name: github-pages
|
||||
url: ${{ steps.deployment.outputs.page_url }}
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Setup Pages
|
||||
uses: actions/configure-pages@v5
|
||||
|
||||
- name: Upload artifact
|
||||
uses: actions/upload-pages-artifact@v3
|
||||
with:
|
||||
# Upload docs directory
|
||||
path: './docs'
|
||||
|
||||
- name: Deploy to GitHub Pages
|
||||
id: deployment
|
||||
uses: actions/deploy-pages@v4
|
||||
70
GITHUB_PAGES_SETUP.md
Normal file
70
GITHUB_PAGES_SETUP.md
Normal file
@@ -0,0 +1,70 @@
|
||||
# GitHub Pages Setup Instructions
|
||||
|
||||
## Current Issue
|
||||
GitHub Pages is not enabled in your repository settings. This is why https://zie619.github.io/n8n-workflows/ is not loading.
|
||||
|
||||
## How to Fix
|
||||
|
||||
### Step 1: Enable GitHub Pages
|
||||
1. Go to your repository: https://github.com/Zie619/n8n-workflows
|
||||
2. Click on **Settings** (in the top navigation)
|
||||
3. Scroll down to **Pages** in the left sidebar
|
||||
4. Under **Source**, select:
|
||||
- **Deploy from a branch**
|
||||
5. Under **Branch**, select:
|
||||
- Branch: `main`
|
||||
- Folder: `/docs`
|
||||
6. Click **Save**
|
||||
|
||||
### Step 2: Wait for Deployment
|
||||
- GitHub will automatically start building your Pages site
|
||||
- This usually takes 2-5 minutes
|
||||
- You can check the deployment status in the Actions tab
|
||||
|
||||
### Step 3: Access Your Site
|
||||
Once deployed, your site will be available at:
|
||||
- https://zie619.github.io/n8n-workflows/
|
||||
|
||||
## What I've Fixed
|
||||
|
||||
### 1. Created Simple Pages Workflow
|
||||
- Added `.github/workflows/pages-deploy.yml` for automatic deployment
|
||||
- This workflow deploys the `/docs` folder to GitHub Pages
|
||||
|
||||
### 2. Existing Content Ready
|
||||
Your `/docs` folder already contains:
|
||||
- `index.html` - Main search interface
|
||||
- `css/styles.css` - Styling
|
||||
- `js/` - JavaScript functionality
|
||||
- `api/` - Workflow data
|
||||
- `_config.yml` - Jekyll configuration
|
||||
|
||||
### 3. Static Site Configuration
|
||||
- The site uses client-side JavaScript for search functionality
|
||||
- No server-side processing needed
|
||||
- Works perfectly with GitHub Pages static hosting
|
||||
|
||||
## Alternative: GitHub Pages from Actions
|
||||
|
||||
If you prefer to use GitHub Actions for deployment (already configured):
|
||||
|
||||
1. Go to Settings → Pages
|
||||
2. Under **Source**, select **GitHub Actions**
|
||||
3. The workflow will automatically deploy on push to main
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
If the site doesn't load after enabling:
|
||||
|
||||
1. **Check Actions tab** - Ensure the Pages workflow is running
|
||||
2. **Check Pages settings** - Confirm the correct branch and folder
|
||||
3. **Clear browser cache** - Force refresh with Ctrl+F5
|
||||
4. **Check repository visibility** - Public repos get Pages for free
|
||||
|
||||
## Current Status
|
||||
|
||||
✅ All necessary files are in place
|
||||
✅ Workflow is configured
|
||||
❌ GitHub Pages needs to be enabled in repository settings
|
||||
|
||||
Once you enable GitHub Pages in the repository settings, your site will be live!
|
||||
Reference in New Issue
Block a user