feat: gh pages deployment (#14)

* feat: github pages deployment

* docs: update readme

* ci: update gh-pages pipeline

* docs: update readme

* docs: update readme

Author: zachspar

.github/workflows/github-pages.yml

@@ -0,0 +1,50 @@
+---
+name: Render & Publish Pages
+
+on:
+  push:
+    branches:
+      - main
+      - master
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+
+      - name: Install Jinja2
+        run: python3 -m pip install -U pip jinja2
+
+      - name: Render Templates
+        run: python3 tools/render_template.py
+
+      - name: Upload static files as artifact
+        id: deployment
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: rendered_artifacts/
+
+  deploy:
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    permissions:
+      pages: write
+      id-token: write
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4      
+

.github/workflows/pipeline.yml

@@ -1,3 +1,4 @@
+---
 name: Lint & Install Pipeline
 
 on:
@@ -8,20 +9,18 @@ on:
 
 jobs:
   build:
-
     runs-on: ubuntu-22.04
     strategy:
       max-parallel: 4
       matrix:
         python-version: ["3.9", "3.10", "3.11", "3.12"]
-
     steps:
     - uses: actions/checkout@v4
 
     - uses: psf/black@stable
       name: Lint
       with:
-        options: --check --line-length 120 .
+        options: --check --line-length 79 .
 
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v5
@@ -32,3 +31,4 @@ jobs:
       run: |
         python3 -m pip install --upgrade pip
         python3 -m pip install -r requirements.txt
+

.gitignore

@@ -5,3 +5,6 @@ __pycache__/
 *.log
 
 env/
+
+output.html
+rendered_artifacts/

README.md

@@ -5,6 +5,11 @@
 If you'd like to use this repo as a template, all you need to do is fork
 it and update `resume_config.toml` with your information accordingly.
 
+You should also update any static files to include your headshot if desired.
+
+### GitHub Pages Deployment
+By default, this repo will publish to GitHub pages from the `main` or `master` branch.
+
 ### Heroku Deployment
 [![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)
 

tools/render_template.py

@@ -0,0 +1,57 @@
+"""
+Render HTML resume templates and copy static files to output directory.
+"""
+
+import jinja2
+import tomllib
+import shutil
+from pathlib import Path
+
+
+def mock_url_for(endpoint, **kwargs):
+    """
+    Mock url_for function for Jinja2 templates.
+    Returns static file paths or endpoint routes.
+    """
+    if endpoint == "static":
+        filename = kwargs.get("filename", "")
+        return f"/resume/static/{filename}"
+    return f"/{endpoint}"
+
+
+def main():
+    # Set up output directory
+    output_dir = Path("rendered_artifacts")
+    output_dir.mkdir(exist_ok=True)
+
+    # Set up static output directory
+    static_output_dir = output_dir / "static"
+    static_output_dir.mkdir(exist_ok=True)
+
+    # Copy static files to output directory
+    static_dir = Path("static")
+    if static_dir.exists():
+        shutil.copytree(static_dir, static_output_dir, dirs_exist_ok=True)
+
+    # Set up Jinja2 environment
+    template_dir = Path("templates/home")
+    env = jinja2.Environment(loader=jinja2.FileSystemLoader(template_dir))
+    env.globals["url_for"] = mock_url_for  # Add mock url_for to Jinja2 globals
+
+    # Load the template
+    template = env.get_template("index_template.html")
+
+    # Load data from TOML file
+    with open("resume_config.toml", "rb") as file:
+        resume_data = tomllib.load(file)
+
+    # Render the template with the data
+    rendered_html = template.render(**resume_data)
+
+    # Save the rendered HTML to a file in output directory
+    with open(output_dir / "index.html", "w") as outfile:
+        outfile.write(rendered_html)
+
+
+if __name__ == "__main__":
+    main()