latest-resume-for-public

KO | EN

gitlite — search

#database #cloud-native #developer-tools #cpp #awesome-list #c #javascript #mcp #privacy #chatbot

latest-resume-for-public

(★ 9)

No description available.

File Explorer

ZIP Download

- - build-deploy.yml
- - client-workflow.mmd
  - maintainer-workflow.mmd
  - server-workflow.mmd
- archeticture.mmd
- Automated Resume Builder abstract workflow.png
- USAGE.md
- build.py
- data.yaml
- index.html
- template.tex
.dockerignore
.gitignore
.python-version
CONTRIBUTING.md
Dockerfile
LICENSE
pyproject.toml
README.md
uv.lock

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Version

File

Link

Example

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

An automated CI/CD pipeline for generating a professional LaTeX resume from structured YAML data.

Instead of editing LaTeX directly, resume content is maintained as structured data. Every push to GitHub automatically generates a fresh PDF and publishes it through GitHub Pages.

[![Build and Deploy Resume](https://github.com/DEVOLOPER-1/latest-resume-for-public/actions/workflows/build-deploy.yml/badge.svg)](https://github.com/DEVOLOPER-1/latest-resume-for-public/actions/workflows/build-deploy.yml)
[![pages-build-deployment](https://github.com/DEVOLOPER-1/latest-resume/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/DEVOLOPER-1/latest-resume-for-public/actions/workflows/pages/pages-build-deployment)
[![Live Site](https://img.shields.io/badge/Live%20Site-devoloper--1.github.io%2Flatest--resume-blue?logo=githubpages)](https://devoloper-1.github.io/latest-resume/)
---

## Features

- Resume content stored as YAML
- LaTeX template powered by Jinja2
- Custom Jinja delimiters — no conflicts with LaTeX syntax
- Automatic PDF generation
- Dockerized build environment
- GitHub Actions CI/CD
- Automatic deployment to GitHub Pages
- Fully reproducible builds via `uv` lockfile

---

## Documentation & Contribution

- **[Usage Guide](docs/USAGE.md)**: Comprehensive guide on local development, prerequisites, YAML schema, template customization, and Docker instructions.
- **[Contributing Guidelines](CONTRIBUTING.md)**: Instructions on how to fork, customize the builder, write tests, format using Ruff, and contribute back.

---

# Architecture

The complete system architecture is documented in [docs/archeticture.mmd](docs/archeticture.mmd).

![Automated Resume Builder Workflow](https://raw.githubusercontent.com/DEVOLOPER-1/latest-resume-for-public/main/docs/Automated%20Resume%20Builder%20abstract%20workflow.png)

The build pipeline consists of four logical stages:

```
Developer
      │
      ▼
GitHub Actions
      │
      ▼
Docker Build Environment
      │
      ▼
PDF Generation
      │
      ▼
GitHub Pages
```

---

# Repository Layout

```
.
├── .github/
│   └── workflows/
│       └── build-deploy.yml
│
├── docs/
│   ├── Automated Resume Builder abstract workflow.png
│   ├── archeticture.mmd
│   ├── USAGE.md
│   └── workflows/
│       ├── client-workflow.mmd
│       ├── maintainer-workflow.mmd
│       └── server-workflow.mmd
│
├── src/
│   ├── build.py
│   ├── data.yaml
│   ├── index.html
│   └── template.tex
│
├── tailored/
│   ├── contain other tailored .yaml for other job openings
│   ├── for example :  new-job-title-tailored-resume.yaml
│   ├── how to use it : uv run src/build.py tailored/new-job-title-tailored-resume.yaml`
├── CONTRIBUTING.md
├── Dockerfile
├── LICENSE
├── pyproject.toml
├── README.md
├── uv.lock
└── .gitignore
```

`resume.pdf` and `generated.tex` are written to the project root during the CI build and are never committed to the repository. `generated.tex` is excluded via `.gitignore`; `resume.pdf` is uploaded directly as a Pages artifact.

---

# Component Overview

## data.yaml

Contains all resume information.

Examples include:

- Personal information
- Education
- Experience
- Projects
- Technologies
- Courses
- Honors & Awards
- Extracurricular activities

No formatting should exist here.

Only data.

---

## template.tex

Responsible only for presentation.

Because LaTeX uses `{` and `}` heavily, the template uses custom Jinja2 delimiters to avoid syntax conflicts:

| Purpose | Delimiter |
|---------|-----------|
| Variables | `<< variable >>` |
| Blocks | `<% for ... %>` / `<% if ... %>` |
| Comments | `<# comment #>` |

Example usage:

```latex
<< personal.name >>

<% for job in experience %>
    \textbf{<< job.title >>}, << job.company >>
<% endfor %>
```

There should be no business logic inside the template.

> **Avoid reserved Python dict method names as YAML keys.** Keys like `items`, `keys`, `values`, and `get` are resolved by Jinja2 as built-in dict methods rather than YAML data. Use descriptive alternatives — e.g. `tools` instead of `items`.

---

## build.py

Acts as the bridge between data and presentation.

Responsibilities:

- Read YAML
- Validate required top-level keys
- Render Jinja template
- Produce `generated.tex` at project root
- Invoke `pdflatex` with `-output-directory` pointed at project root
- Rename `generated.pdf` → `resume.pdf`
- Report build failures with truncated pdflatex log

All output paths are derived from `Path(__file__).parent.parent` (project root), making the script invocation-location-independent.

---

## generated.tex

This file is automatically generated and written to the project root.

It should never be edited manually.

```
data.yaml
      +
template.tex
      │
      ▼
generated.tex  (project root)
```

---

## resume.pdf

Final compiled artifact, written to the project root during the CI build.

This is the document published to GitHub Pages. It is never committed to the repository.

---

## index.html

Static landing page served as the root of the GitHub Pages site.

Located at `src/index.html` and copied into the Pages artifact during the build step.

Responsibilities:

- Introduce the author and project context
- Provide a clearly labelled download link to `resume.pdf`
- Signal to the viewer that the PDF is generated automatically (trust signal)

No build step is required — it is plain HTML and is copied as-is.

---

# Build Pipeline

Every push triggers the following workflow.

```
git push
      │
      ▼
GitHub Actions
      │
      ▼
Checkout Repository
      │
      ▼
Build Docker Image
      │
      ▼
Run Build Container
      │
      ▼
Run build.py
      │
      ▼
Render LaTeX
      │
      ▼
Compile PDF
      │
      ▼
Copy index.html → _site/
      │
      ▼
Deploy to GitHub Pages
```

No manual intervention is required.

---

# Why Docker?

Installing a full TeX distribution during every GitHub Actions run is slow.

Instead, the workflow builds and caches this repository's `Dockerfile` image containing

- TeX Live
- Python
- Jinja2
- PyYAML

Benefits:

- Faster CI
- Identical local and CI environments
- Reproducible builds
- No dependency drift

---

# Why uv?

Dependencies are managed with [uv](https://github.com/astral-sh/uv) rather than pip. The `uv.lock` file pins every transitive dependency to an exact version, guaranteeing that local builds and CI produce identical environments.

Benefits:

- Deterministic installs across machines
- Significantly faster than pip
- Single `uv sync` replaces `pip install -r requirements.txt`
- No need to manually maintain `requirements.txt`

---

# Local Development

Install dependencies

```bash
uv sync
```

Run

```bash
uv run src/build.py
```

The script generates the following files at the project root:

```
generated.tex
resume.pdf
```

`build.py` resolves all output paths relative to its own location, so the script works correctly regardless of the working directory it is invoked from.

---

# GitHub Actions

The workflow performs:

1. Checkout repository
2. Build and cache Docker image
3. Run containerized build (`uv sync --frozen && uv run src/build.py`)
4. Copy `resume.pdf` and `src/index.html` into `_site/`
5. Upload `_site/` as the Pages artifact
6. Deploy to GitHub Pages (with automatic one-retry on transient failures)

---

# Data Flow

```
data.yaml
      │
      ▼
PyYAML
      │
      ▼
Python Dictionary
      │
      ▼
Jinja2 (custom delimiters)
      │
      ▼
generated.tex  (project root)
      │
      ▼
pdflatex
      │
      ▼
resume.pdf  (project root)
```

---

# Extending the Resume

## Adding a new section

1. Add data to `data.yaml`

```yaml
awards:
  - title: Best Developer
    year: 2025
```

2. Update `template.tex`

```latex
<% for award in awards %>
    \textbf{<< award.title >>} --- << award.year >>
<% endfor %>
```

No changes to `build.py` are required unless the new key must be validated.

---

## Adding new variables

Introduce a new YAML key and reference it in the template.

`data.yaml`

```yaml
location: Cairo, Egypt
```

`template.tex`

```latex
<< location >>
```

---

## Changing the Layout

Only edit `template.tex`.

No modifications to the YAML structure are necessary unless additional data is required.

---

# Troubleshooting

## Missing PDF

Check

- YAML syntax errors
- LaTeX compilation errors in `generated.tex`
- Missing or misspelled template variables

---

## Jinja Errors

Usually caused by

- Misspelled variable names
- Missing YAML fields referenced in the template
- Using a reserved Python dict method name as a YAML key (`items`, `keys`, `values`, `get`, `update`, `pop`)

---

## LaTeX Errors

Inspect `generated.tex` rather than `template.tex`.

The generated file reflects the exact document sent to pdflatex.

Also check `generated.log` at the project root for the full pdflatex transcript.

---

# Design Principles

The project intentionally separates concerns.

| Layer | Responsibility |
|-------|----------------|
| YAML | Data |
| Jinja2 | Template rendering |
| LaTeX | Visual presentation |
| Python | Build orchestration |
| uv | Dependency management |
| Docker | Reproducible environment |
| GitHub Actions | Automation |
| GitHub Pages | Distribution |

Each component has exactly one responsibility.

---

# Future Improvements

Potential enhancements include:

- Multiple resume themes
- Multiple language support
- PDF optimization
- Automatic spell checking
- Resume versioning
- Cover letter generation
- Unit tests for YAML validation
- Schema validation using JSON Schema or Pydantic

latest-resume-for-public

File Explorer

# Use via CDN

Was this content helpful?

Recent Feedback

Download README