Merge pull request #3 from UAVCAN/issue/2

Adding container for building LaTeX

Author: thirtytwobits

README.md

@@ -1,4 +1,4 @@
 ![UAVCAN](uavcan_logo.svg) UAVCAN Containerized Toolchains
 ===================
 
-This repository contains the Dockerfiles, instructions, and some utilities for building containers to be used as common toolchains for the UAVCAN project. These containers are published to the [uavcan organization on Docker Hub](https://cloud.docker.com/u/uavcan).
+This repository contains the Dockerfiles, instructions, and some utilities for building containers to be used as common toolchains for the UAVCAN project. These containers are published to the [uavcan organization on Docker Hub](https://cloud.docker.com/u/uavcan) and are used by the build automation for UAVCAN projects. You can use these same containers to get consistent build results in your local development environment.

texer/Dockerfile

@@ -0,0 +1,39 @@
+#
+# Builds the c_cpp/ubuntu-16.04 toolchain container.
+#
+FROM ubuntu:16.04
+
+VOLUME /repo
+
+WORKDIR /repo
+
+
+ENV DEBIAN_FRONTEND=noninteractive
+
+ENV LANG=en_US.UTF-8
+ENV LANGUAGE=en_US:en
+ENV LC_ALL=en_US.UTF-8
+
+RUN apt-get update
+
+# setup locales in the container so Python can default to utf-8.
+RUN apt-get -y install locales
+
+# from http://jaredmarkell.com/docker-and-locales/
+RUN locale-gen en_US.UTF-8
+
+RUN apt-get -y install software-properties-common
+RUN apt-get -y install apt-utils
+RUN apt-get -y install texlive-full
+RUN apt-get -y install lyx
+RUN apt-get -y install git
+
+RUN add-apt-repository -y ppa:deadsnakes/ppa
+RUN apt-get update
+
+RUN apt-get -y install python3.7
+RUN update-alternatives --install /usr/bin/python3 python3 /usr/bin/python3.7 999
+RUN apt-get -y install python3-pip
+RUN python3 -m pip install --upgrade pip
+
+RUN python3 -m pip install pygments

texer/README.md

@@ -0,0 +1,71 @@
+# Texer Docker
+
+Builds and pushes a docker environment used by the UAVCAN project to build [LaTeX](https://www.latex-project.org/) documents.
+
+## Build and Push
+
+These instructions are for maintainers with permissions to push to the "uavcan" organization on Docker Hub.
+
+```bash
+docker build .
+```
+
+```bash
+docker images
+
+REPOSITORY      TAG            IMAGE ID
+texer           latest         d7ab132649d6
+```
+
+```bash
+docker tag d7ab132649d6 uavcan/texer:ubuntu-16.04
+docker login --username=yourhubusername
+docker push uavcan/texer:ubuntu-16.04
+```
+
+## Testing out the container
+
+Start an interactive session:
+
+```bash
+docker run --rm -it -v ${PWD}:/repo uavcan/texer:ubuntu-16.04
+```
+
+On macintosh you'll probably want to optimize osxfs with something like cached or delegated:
+
+```bash
+docker run --rm -it -v ${PWD}:/repo:delegated uavcan/texer:ubuntu-16.04
+```
+
+See ["Performance tuning for volume mounts"](https://docs.docker.com/docker-for-mac/osxfs-caching/) for details.
+
+## Travis CI
+
+You can use this in your .travis.yml like this:
+
+```none
+services:
+  - docker
+
+before_install:
+- docker pull uavcan/texer:ubuntu-16.04
+
+script:
+- docker run --rm -v $TRAVIS_BUILD_DIR:/repo uavcan/uavcan/texer:ubuntu-16.04 /bin/sh -c ./compile.sh
+
+```
+
+## BuildKite
+
+Example pipeline.yml:
+
+```yaml
+- label: ":github: my containerized build"
+    command: "compile"
+    plugins:
+      - docker#v3.5.0:
+          workdir: /repo
+          image: "uavcan/texer:ubuntu-16.04"
+          propagate-environment: true
+          mount-ssh-agent: true
+```