cibuilds/hugo repository overview

⁠CI Builds: Hugo

A Docker image for Hugo⁠, a static-site generator. Includes HTMLProofer⁠ for testing. Hosted on Docker Hub⁠.

Currently, this Docker image is designed to be used as a base image on CircleCI 2.0 for building, testing, and deploying Hugo based websites.

I plan to make this image useful for local testing and build/test/deploy on Travis CI as well in the future.

⁠Using on CircleCI

Using this image to build your Hugo generated website on CircleCI 2.0 can be as simple as using the following configuration in .circleci/config.yml:

version: 2
jobs:
  build:
    docker:
      - image: felicianotech/docker-hugo:0.50
    working_directory: ~/project
    steps:
      - checkout
      - run:
          name: "Run Hugo"
          command: HUGO_ENV=production hugo -v -s src/
      - run:
          name: "Test Website"
          command: htmlproofer src/public --allow-hash-href --check-html --empty-alt-ignore --disable-external

In this example, we assume the Hugo files are in a directory called src in the repo. A full walkthrough on how to do this can be found on CircleCI's blog⁠.

⁠Building The Images

To prepare new images, I run ./gen-dockerfiles.sh locally, passing it the current Hugo versions that I am "supporting". For example, for the initial release, I ran ./gen-dockerfiles.sh 0.18.1 0.19.

I then commit the resulting files and push up to GitHub. CircleCI builds everything and publishes the new Docker images to Docker Hub.

⁠Websites Using This & Examples

The following sites use Hugo and this image (and some have their config public):

• https://www.Feliciano.Tech⁠ (repository⁠)
• https://HugoNewsletter.com⁠ (repository⁠)
• https://www.DiscourseHub.com⁠ (repository⁠)

⁠Feedback & Contributing

Please feel free to open GitHub Issues for any questions, bugs, request, etc. You can also write a new post on Hugo's forum⁠ and ping me, FelicianoTech. Pull Request welcome as well.