CODEWITHSUNDEEP
javascriptperformancebuildgithub-pagesjekyll-bootstrap
john_science
john_science

Reputation: 6551

Minify JavaScript during GitHub Pages build?

I have a static website through GitHub Pages, built on Jekyll-Bootstrap. My little website includes a lot of JavaScript, and for maintainability I would like all of the JavaScript to remain human-readable in the GitHub repo.

But for the end-user of my website, I would prefer to minify the JavaScript.

Is there some way to build a hook into the GitHub Pages build process to minify/uglify JavaScript, so that the end user can download smaller files?

Upvotes: 13

Views: 4539

Answers (5)

Ari Cooper-Davis
Ari Cooper-Davis

Reputation: 3485

My approach to this is a Github action that:

  • checks out the main branch
  • performs the minification/purging etc
  • pushes the changes to a gh-pages branch

Then you just need to point Github Pages at the gh-pages branch rather than the main branch.

You'd need to choose appropriate CLI tools to perform the minifying/purging in the virtual machine that the action spins up. There are lots of options here. I'd suggest using packages that can be installed through node so that you only have to install that on the VM. For example:

This is relatively straightforward with a Github action that looks a bit like this:

# A Github Action that minifies html/css/js and pushes it to a new branch
name: purge-and-minify

# Run on pushes to `main` branch
on:
  push:
    branches:
      - 'main'

jobs:
  checkout-minify-push:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      
      # Install CLI tools
      - uses: actions/setup-node@v3
        with:
          node-version: '16'
      - run: npm install -g terser
      - run: npm install -g csso-cli
      - run: npm install -g html-minifier

      # Use CLI tools to minify, overwriting existing files
      - run: for i in ./js/*.js; do terser $i --compress -o $i; done
      - run: for i in ./css/*.css; do csso $i -o $i; done
      - run: for i in ./html/*.html; do html-minifier [--your-options-here] $i -o $i; done
      
      # Push changes to `gh-pages` branch
      - run: |
          git config user.name github-username
          git config user.email [email protected]
          git commit -am 'Automated minify of ${{ github.sha }}'
          git push --force -u origin main:gh-pages

Here is a working example of a similar process in a Github project of mine.

Upvotes: 1

Александр Меняйло
Александр Меняйло

Reputation: 41

You can try to use my own minifier https://github.com/Mendeo/jekyll-minifier. It is written purely on liquid, so you do not need any additional gems install and it is fully compatible with GitHub Pages.

Upvotes: 1

SeanFromIT
SeanFromIT

Reputation: 676

Netlify is an alternative to GitHub Pages that integrates with GitHub (even private repos) and similarly publishes the output of Jekyll (or other static site generators). There are some limits on the free tier, but most individual users are unlikely to run into them.

You should be able to add one of the Jekyll minifier plugins listed here to accomplish your goals. Here are plugin installation instructions.

Please add a comment if this worked for you! I'd love to hear how it went.

Upvotes: -1

wjdp
wjdp

Reputation: 1488

The GitHub pages build service cannot have any other code running on it other than Jekyll in safe mode and the small number of included plugins. This is done for security.

Your best option is to use an alternative service to build your site and push the result back to GitHub. The source for the site would reside in the master branch and the compiled source in gh-pages.

A suitable service for doing so would be one of many CI services, such as Travis CI. These are typically used to run software test suites on every push to a repo, but can be used to build your website and push the result back to you.

The Jekyll docs have a guide for testing builds on Travis. Pushing the output isn't mentioned. You'll need a script in the after_success derivative in the Travis conf file. An example from a site I maintain.

To authenticate your push the script will need access to your github personal access token. You can't just put this straight in the deploy script as it's a secret. See the Travis docs on encrypting environment variables.

Upvotes: 9

TBB
TBB

Reputation: 1227

If you are using Github to generate the site and display it, there is no option to do this because Github is strict about what it will process - for security.

A workaround is to do your compiling and processing locally, then push the resulting output to to gh-pages - which is happy to simply host static pages.

You can still use github to host the project. You just do not use Github to compile it.

Your dev process might be:

  1. Check you're master and local match.
  2. Do your work in dev mode.
  3. Build in production.
  4. Use grunt or other program to minify/uglify/etc the _site production files - outputting to a separate dist (distribution) folder.
  5. Push the contents of the dist folder to your gh-pages.
  6. Commit changes to the project files back to the master.

I am probably not making much sense, but perhaps this discussion might help more: https://gist.github.com/cobyism/4730490

Have fun!

Upvotes: 3

Related Questions