Add workflow to deploy website

Author: nielstron

.github/workflows/deploy-pages.yml

@@ -0,0 +1,59 @@
+name: Generate and Deploy GitHub Pages
+
+on:
+  push:
+    branches: [ "master" ]
+  # Allow manual triggering
+  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:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.12'
+          
+      - name: Generate index.html
+        run: |
+          cd docs
+          python generate_index.py
+          rm README.md
+          
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+        
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          # Upload docs directory
+          path: './docs'
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

docs/README.md

@@ -1,19 +1,43 @@
-## Running
+# SWT-Bench Documentation Site
 
-To generate the website, run the following command.
-```bash
-python3 generate_index.py
-``` 
+This directory contains the source files for the SWT-Bench leaderboard website that is automatically deployed to GitHub Pages.
+
+## Files
+
+- `generate_index.py` - Python script that generates the final `index.html` from the template and CSV data
+- `index.template.html` - HTML template for the leaderboard page
+- `runs.csv` - Model performance data
+- `orgs.csv` - Organization/provider information
+- `approaches.csv` - Approach/paper mapping data
+- `static/` - Static assets (CSS, JS, images)
+
+## Automatic Deployment
+
+The site is automatically built and deployed to GitHub Pages via the `.github/workflows/deploy-pages.yml` workflow:
+
+1. **Triggers**: Runs on pushes to the `main` branch, pull requests, or manual dispatch
+2. **Build Process**: 
+   - Checks out the repository
+   - Sets up Python 3.11
+   - Runs `generate_index.py` to create the final HTML
+   - Uploads the entire `docs/` directory as a Pages artifact
+3. **Deployment**: Deploys to GitHub Pages (only on pushes to `main`)
+
+## Manual Generation
+
+To generate the site locally:
 
-Then serve it using the following command.
 ```bash
-$ python3 -m http.server 8080
+cd docs
+python generate_index.py
 ```
 
-## Adding a new approach
+This will create/update the `index.html` file based on the current CSV data and template.
+
+## GitHub Pages Configuration
 
-To add a new approach, do the following:
+Make sure GitHub Pages is configured in your repository settings:
+1. Go to Settings → Pages
+2. Set Source to "GitHub Actions"
+3. The workflow will handle the rest automatically
 
-1) Add the approach to `approaches.csv`
-2) Add the organization to `orgs.csv`
-3) Add the specific run(s) to `runs.csv` (i.e., verified and lite if applicable)