util/docker/coreboot.org-status/board-status.html/README

   1 Tool to publish board-status data to the website
   2 ================================================
   3
   4 This tool parses the board-status repository (and the coreboot repository as
   5 companion) to build a meaningful representation of the test coverage stored
   6 in board-status.
   7
   8 The server runs these regularly to update
   9 https://coreboot.org/status/board-status.html
  10
  11 How to use
  12 ----------
  13 When modifying the tool, or when publishing the results elsewhere, you
  14 might want to run it yourself. You'll need the board-status and the coreboot
  15 repository checked out.
  16
  17 To build the tool, run the following commands
  18
  19     $ go mod download
  20     $ go build
  21
  22 To run it, use
  23
  24     $ ./board-status.html \
  25       -board-status-dir .../board-status.git \
  26       -coreboot-dir .../coreboot.git > out.html
  27
  28 There will be a few errors about missing revisions, those come from status
  29 reports based on unpublished commits.
  30
  31 LIMITATIONS
  32 -----------
  33 The tool doesn't support board variants or "clone of" specifiers in
  34 board-info.txt. The output is also a bit unwieldy, leading to many megabytes
  35 of HTML in a single file.