Skip to content

Latest commit

 

History

History
59 lines (38 loc) · 2.81 KB

README.md

File metadata and controls

59 lines (38 loc) · 2.81 KB

ccjmne-resume

Compile and Publish Resume

This project lets me build my current static one-page resume.

Take a look at it here.

Inside the Box

This generates a simple HTML page, printed out to PDF with Puppeteer.

Technologies used:

How-To

Development merely uses the standard NodeJS process (using npm);
Publication is automated through Continuous Deployment, leverating GitHub Actions.

Set up

Install with npm install.

Build

Continuously watch-rebuild with npm start (or webpack serve --mode development) during development;
Perform a one-off compilation with npm run build (or webpack --mode production).

The PDF output (and the pre-compiled HTML-CSS-JS assets in dev. mode) will be generated under dist/.

Deploy

There is nothing to do, this process is automated.

With each newly published release on GitHub,

  1. a GitHub Action will use Webpack to:
  2. a subsequent job will:
    • retrieve the compiled artifact,
    • generate a stripped-down index.html that merely sets up an HTML Meta Refresh to the PDF resume,
    • push a new commit to the gh-pages branch, referencing the original commit to master that triggered the rebuild-redeploy
  3. this commit to gh-pages triggers another GitHub Action that publishes my resume here, with GitHub Pages

Licensing

GPL-3.0

You may copy, distribute and modify the software as long as you track changes/dates in source files. Any modifications to or software including (via compiler) GPL-licensed code must also be made available under the GPL along with build & install instructions.

Refer to the LICENSE file for more details.