Skip to content

Automate resume creation with LaTeX and GitHub Actions. Docker integration ensures consistent builds. Manage data and outputs efficiently.

License

Notifications You must be signed in to change notification settings

EchoSingh/resume-builder

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

LaTeX Resume Builder πŸ“„

Build Resume GitHub Pages

License Last Commit Repo Size Contributors Stars Forks

A robust, automated solution for creating and maintaining a professional resume using LaTeX, Docker, and GitHub Actions. This project provides a streamlined workflow for generating a high-quality PDF from a .tex source, ensuring consistency and simplifying version control.

Workflow

The following sequence-diagram illustrates the automated build process: Workflow Diagram

Project Structure

The repository is organized as follows:

resume-builder/
β”œβ”€β”€ .github/
β”‚   └── workflows/
β”‚       └── compile.yml   # GitHub Actions workflow for automated builds
β”œβ”€β”€ data/
β”‚   └── resume.tex        # The main LaTeX source file for the resume
β”œβ”€β”€ docs/
β”‚   └── resume.pdf        # The generated PDF output
β”œβ”€β”€ Dockerfile            # Defines the containerized build environment
β”œβ”€β”€ action.yml            # Defines the custom GitHub Action
└── README.md             # This file

Usage

Automated Workflow (Recommended)

  1. Edit data/resume.tex with your information.
  2. Commit and push your changes to the main branch.
  3. GitHub Actions will automatically:
    • Compile the LaTeX source file.
    • Commit the updated resume.pdf to the docs/ directory.

Local Compilation

Prerequisites

Using Docker

This method uses the containerized environment for a consistent build.

# Build the Docker image
docker build -t resume-builder .

# Run the container, mounting the current directory
# The generated PDF will be in the `docs/` folder
docker run --rm -v "$(pwd):/github/workspace" resume-builder

Manual Compilation

If you have a local LaTeX installation, you can compile the resume directly.

# Compile the .tex file and place the output in the docs/ directory
pdflatex -output-directory=docs data/resume.tex

Contributing

Contributions are welcome! If you have suggestions for improvements, please open an issue or submit a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.

About

Automate resume creation with LaTeX and GitHub Actions. Docker integration ensures consistent builds. Manage data and outputs efficiently.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •