Resume Ops with GitHub Actions 🚀

✨ Build your resume with LaTeX, leverage version control of git to track changes, and perform CI/CD with GtiHub Actions. ✨

🤔 Why use git?

Do I even need to explain this? It's a mess when you have to keep numerous versions of resumes for different purposes—academic and industry—tailored for multiple stakeholders across disciplines and sectors. So it make sense to have a version control for your resume.

🐳 Why docker?

LaTeX can be quite heavy to carry around on a local environment. I know there are online alternatives, like Overleaf, but they have their own limitations. Signing in on new devices (public ones esp), accounts geting lost with changing emails (especially when leaving uni or workplace), paid access for collaborating, and having a reliable internet connection all the time (even for editing docs) make this whole resume-making exercise cumbersome. And let's not forget the amount of control you get with a your favourite local IDE (VSCode ❤️). Additionally, setting up LaTeX on a new system can be a nightmare. You have to take care of versions, OS, packages, fonts... so many things.

Docker containerises LaTeX and lets you develop locally without having to deal with all the configurations and dependencies. You can execute a container on your host from a variety of opensource LaTeX images, and start writing and compiling LaTeX immediately.

😕 Why GitHub Actions?

Let's say you don't have LaTeX, or VS Code, or a running Docker container with LaTeX inside, or even this repository cloned on your desktop. However, what you do have is an internet connection and such a remote repo on GitHub. Now, you are in a university library without your laptop sipping coffee when you get to know there's a job fair today. You know you have to get several copies (and versions) of your resume quickly. However, the resume versions you already have on the repo are not updated, or are not tailored to the employers visiting. What should you do? You can't just start installing LaTeX with all the peculiar configurations, fonts and colours on a library computer, or even your friends' laptops. There's simply no time to install this heavy package, let alone troubleshoot potential errors. You also can't build the docker image there since it will take a lot of space (which these devices may not have), fast internet, and a lot of time. Here's what you should be able to do.

Sign in to your Github account ✅
Go to your repo 📁
Edit the latex files (assume only light editing like moving and adding sections, editing text content, etc.)
Commit the changes! 🚀

LaTeX should automatically be able to run and compile in a cloud instance somewhere on GitHub servers and get you your precious resumes :'). This is possible with GitHub Actions 👁️👄👁️

GitHub Actions provides you with CI/CD support to do such tasks easily. Just define a YAML file and you're done—GitHub will automatically run the workflow jobs you defined in the YAML file.

🧐 So what does it exactly do?

Contains the lucid moderncv themed reusable tex code 😌
Allows tracking commit history of your resume ⌛—useful when you want to revert back to a previous version of your resume
Produces PDF files from .tex files right on this repository 🏌️ always available for download—can house multiple concurrent versions of your resume (one-pager, two-pager, developer, research, etc.)
Identifies only the changed .tex files on every git push and compiles them 🎯 thus saving overhead and track history effectively
TODO 🔧: Uploads the resumes (PDF) to a GDrive folder

Run

First, fork and clone the repo
Dive straight to creating your resume! You can use your favourite editor locally. We use moderncv LaTeX package for creating lucid resumes. You can follow their documentation here.
Test the output locally by compiling. There are two ways of doing this:
- Install TeX Live distribution yourself. If you use VSCode, LaTeX Workshop extension is recommended. Follow their guide to install all requirements. This is tedious way, but not impossible.
- Use docker! This repo uses the docker image from blang/latex-docker to compile tex files and generate PDFs in the GitHub Actions workflow.
```
cd resume-ops-latex
./latexdockercmd.sh latexmk -outdir=./resumes -pdf sample.tex
```
LaTeX Workshop can also be used inside a docker environment with VSCode's Remote – Container extension, as mentioned the wiki.

Add, commit, push! ⛳

git add .
git commit -m "Update resume"
git push

⚠️ Note ⚠️

For all subsequent times when you try to make changes, ALWAYS RUN git pull before making any commits. This is because the GitHub Actions workflow compiles the tex files and then add-commit-pushes the generated PDFs to the repository's file system. Essentially, this means a change was made on the remote repository and that your local repository is behind by 1 commit. Making a pull beforehand would ensure there are no conflicts. Hence, your ideal set of git commands should be:
```
git pull
git add .
git commit -m "Update resume"
git push   
```
You can also create an alias in .gitconfig under the [alias] tag. Here's how to do it:
```
vi ~/.gitconfig

# Press `i` and then type the following:
[alias]
    update-resume = !git pull && git add . && git commit -m 'Update resume' && git push
```
Now, every time you want to publish changes to your resume(s), run:
```
git update-resume
```
In order to avoid duplication, .gitignore attempts to remove any PDFs in the root folder of the repo because our workflow is also generating PDFs at ./resumes. This can be changed according to the user's discretion.

⚙️ Workflow

Our YAML file .github/workflows/run_ci.yml does the following things in order each time we push:

Checks out (copies) the repository on GitHub's remote workspace.
Gets a list of all modified .tex files by comparing the most recent commit with the previous commit¹.
Builds a docker image and executes latexmk commands inside a container (blang/latex-docker) to compile each .tex file obtained from above; stores PDFs inside ./resumes/ folder².
Add, commit, push using git-auto-commit-action to actually persist the changes (new PDFs) on the remote repository's file system.

$Workflow$

Acknowledgements

Docker image to compile my LaTeX files: https://github.com/blang/latex-docker
Inspired from: https://ljvmiranda921.github.io/notebook/2018/04/23/postmortem-shift-to-docker/
git-auto-commit-action: stefanzweifel/git-auto-commit-action

Footnotes

1. TeX files checked for changes are supposed to be present only in the root directory of the repo, not in any subfolder.
2. It takes approximately 2 minutes to run the complete workflow for one push.

qb1968 / resume-ops-latex