# Travis CI

# Setup

We use containerised checks.

Below is an example (.travis.yml) of a basic configuration for Travis CI.

---
language: generic
dist: xenial

services:
  - docker

stages:
  - test

jobs:
  include:
    - stage: test
      script:
      - docker run -v `pwd`/docs:/srv/test testthedocs/ttd-linkcheck docs
      - docker run --rm -i -v `pwd`:/lint/input:ro testthedocs/ttd-remark docs

# Configuration breakdown

# Language

language: minimal and language: generic are images available in Ubuntu Xenial.

dist: xenial and Ubuntu Trusty dist:trusty, that are not tailored to any particular programming language.

As their names suggest, one is optimized be faster and use less disk space, the other to have more languages and services available.

For more information, please check the Travis CI documentation.

# Docker

Travis CI builds can run and build Docker images.

To use Docker add the following settings to your .travis.yml:

services:
  - docker

Please check the Travis docs on Docker for more.

# Build stages

Build stages is a way to group jobs, and run jobs in each stage in parallel, but run one stage after another sequentially

Here’s how you’d set up the build configuration for this in your .travis.yml file:

jobs:
  include:
    - stage: test
      script: ./test 1
    - # stage name not required, will continue to use `test`
      script: ./test 2
    - stage: deploy
      script: ./deploy

Check the docs about build stages in the Travis docs.

# Working example

You can find a fully working example in the GitHub organization of TestTheDocs.