Developer Guide

Documentation

The project uses the MOOSE docs system to generate its HTML documentation. The HTML artifacts are generated and deployed within Hippo's CI. The CI pipeline is run on any pull request and also on a push to main (i.e., a merged pull request). The documentation pages are always built, however they are only deployed on a push to main.

Docker

The Dockerfile docker/Dockerfile contains the build definition for Hippo's CI environment. This environment does not contain Hippo itself, as it is used for testing the build.

The Docker image should be built using the deploy-docker GitHub action. Developers should tag the Docker image with the first 20 characters of the Git revision they are building the image with. Once the image has been built and pushed to Quay.io, a developer should open a PR that updates .github/ci.yml to use the new tag. Once that PR has passed the CI it can be merged. The newest version of the Docker image can then be tagged with latest on Quay.io.