Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hubci/hugo-docker
A Docker image for Hugo, the static-site generator. This image focuses on a CI use-case, not production. Includes HTMLProofer for testing.
https://github.com/hubci/hugo-docker
circleci docker html-proofer hubci hugo static-site-generator
Last synced: 2 months ago
JSON representation
A Docker image for Hugo, the static-site generator. This image focuses on a CI use-case, not production. Includes HTMLProofer for testing.
- Host: GitHub
- URL: https://github.com/hubci/hugo-docker
- Owner: hubci
- License: mit
- Created: 2017-03-20T15:33:49.000Z (almost 8 years ago)
- Default Branch: trunk
- Last Pushed: 2024-10-24T19:47:54.000Z (3 months ago)
- Last Synced: 2024-11-02T16:03:37.304Z (3 months ago)
- Topics: circleci, docker, html-proofer, hubci, hugo, static-site-generator
- Language: Dockerfile
- Homepage: https://hub.docker.com/r/hubci/hugo/
- Size: 313 KB
- Stars: 64
- Watchers: 5
- Forks: 10
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-hugo - Docker Image for Hugo
README
# HubCI: Hugo [](https://circleci.com/gh/hubci/hugo) [](https://hub.docker.com/r/hubci/hugo/) [](https://raw.githubusercontent.com/hubci/hugo/trunk/LICENSE)
A Docker image for [Hugo](http://gohugo.io/), a static-site generator. Includes [HTMLProofer](https://github.com/gjtorikian/html-proofer) for testing. Hosted on [Docker Hub](https://hub.docker.com/r/hubci/hugo/).
Currently, this Docker image is designed to be used as a base image on CircleCI for building, testing, and deploying Hugo based websites.
I plan to make this image useful for local testing and build/test/deploy on other CI provider as well in the future.
## Using on CircleCI
Using this image to build your Hugo generated website on CircleCI can be as simple as using the following configuration in `.circleci/config.yml`:
```yaml
version: 2.1
jobs:
build:
docker:
- image: hubci/hugo:0.96.0
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
```
### Version
`0.96.0` is the version of Hugo to use.
You can use a complete SemVer version number such as `0.96.0` to specifically pin to that release.
You can also use `0.96` which will use Hugo `0.96.0`, and then `0.96.1`, and `0.96.2`, and so on as newer versions are released.
You can also use `nightly` to use the in-development version.
`nightly` is a snapshot of whatever is in the `master` branch of Hugo, which is unreleased, updated at least once a day.
`edge` - the edge tag is available as a testing ground for new changes to this image.
Changes to `trunk` will appear immediately in the `hugo:edge` image.
The next proper release will also include those changes unless they are removed before hand.
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](https://circleci.com/blog/build-test-deploy-hugo-sites/).
## Building The Images
To prepare new images, I run `./shared/gen-dockerfiles.sh` locally, passing it the current Hugo versions that I am "supporting". For example, for the initial release, I ran `./shared/gen-dockerfiles.sh 0.96.0`.
That creates the Dockerfiles and the build script for them.
For actual, proper releases though, I run the `./shared/release.sh` script.
This script runs `gen-dockerfiles.sh` but also does all the Git work to publish a proper release.
The flag `[release]` is added to the commit message to initiate a release.
## Websites Using This & Examples
The following sites use Hugo and this image (and some have their config public):
- ([repository](https://github.com/felicianotech/www.feliciano.tech))
- ([repository](https://github.com/felicianotech/hugonewsletter.com))
- ([repository](https://github.com/felicianotech/docsthursday.com))
- ([repository](https://github.com/discoursehub/www.discoursehub.com))
- [UNICEF Open Source Inventory](https://unicef.github.io/inventory/) ([repository](https://github.com/unicef/inventory))
- [UNICEF Drones for SDGs Toolkit](https://unicef.github.io/drone-4sdgtoolkit/) ([repository](https://github.com/unicef/drone-4sdgtoolkit))
## 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](https://discuss.gohugo.io/) and ping me, `FelicianoTech`. Pull Request welcome as well.