Skip to content

Latest commit

 

History

History
63 lines (45 loc) · 1.81 KB

README.md

File metadata and controls

63 lines (45 loc) · 1.81 KB
Raw

Litani

Litani is a build system that provides an HTML dashboard of job results, as well as a JSON-formatted record of job results. It provides platform-independent job control (timeouts, return code control) and an output format that is easy to render into reports (for example, using the built-in renderer).

Documentation

Hosted here. The Homebrew and Debian packages also install the man pages locally, try man litani-add-job.

Installation

To install with Homebrew:

brew install litani

On Ubuntu, Install Litani by downloading the *.deb package built by each release, available on the releases page and run

apt install -y litani-x.xx.x.deb  # where x.xx.x is the release version.

Dependencies

If you are cloning the source code, you will need the following dependencies:

Required

  • Python3
  • Ninja
    • apt-get install ninja-build, brew install ninja
  • Jinja
    • pip3 install jinja2

Recommended

  • Graphviz DOT
    • apt-get install graphviz, brew install graphviz
  • Gnuplot to generate graphs on the dashboard
    • apt-get install gnuplot, brew install gnuplot

Optional

  • Voluptuous to perform sanity-checking on internal data structures
    • pip3 install voluptuous
  • coreutils to build the documentation
    • brew install coreutils
  • mandoc to build the documentation
    • brew install mandoc
  • scdoc to build the documentation
    • brew install scdoc