Deploy

A cheatsheet for deploying this project.

Documentation

To deploy the sphinx documentation to GitHub Pages a python program ghp-import is used.

To deploy the docs:

$ cd /path/to/project/docs
$ make html
$ ghp-import -n -p ./_build/html

The -n option in the ghp-import command above is the no-jekyll flag and is required for the sphinx docs to display correctly.

If you didn’t run pip install -r requirements.txt in your Python environment you can run pip install ghp-import to install ghp-import.

Docker Hub

Tags in the project will match the pattern: docker.io/lowcloudnine/lighthouse:x.y.z were x.y.z is the semanic version number of the image release and ideally there should be a tag in the git repo with the same version number.

An example deployment would look like:

$ cd /path/to/project
$ export VER=3.0.0  # or if you are in Powershell use: `$VER = "3.0.0"`
$ docker build -t lighthouse .
$ docker login
$ docker tag lighthouse docker.io/lowcloudnine/lighthouse:${VER}
$ docker push docker.io/lowcloudnine/lighthouse:${VER}

and then a push of the image to latest. The following commands assume you have completed the above commands:

$ docker tag lighthouse docker.io/lowcloudnine/lighthouse:latest
$ docker push docker.io/lowcloudnine/lighthouse:latest