ci_config.json

{
  "_comment": ["This is intentionally undocumented in README.md, do not use it.",
               "Using it is an automatic CI error.",
               "broken_linux, broken_windows and broken_macos are lists of wraps that are known",
               "to be broken on the CI and ***MUST*** get repaired before updates",
               "will be accepted. If upstream does not support an Operating System,",
               "explicitly disable that Operating System in build_on.",
               "Please remove projects from those lists once they are updated."],
  "broken_linux": [
    "arduinocore-avr"
  ],
  "broken_windows": [
    "arduinocore-avr",
    "google-woff2",
    "libgpiod",
    "mocklibc",
    "termbox",
    "ludocode-mpack",
    "m4",
    "tinyply"
  ],
  "broken_darwin": [
    "arduinocore-avr",
    "google-woff2",
    "graphite2",
    "libgpiod",
    "mocklibc",
    "rtaudio",
    "tinyxml2"
  ],
  "c-flags": {
    "build_options": [
      "c-flags:tests=true"
    ]
  },
  "cexception": {
    "build_options": [
      "cexception:werror=false"
    ]
  },
  "cli11": {
    "build_options": [
      "cpp_std=c++14"
    ]
  },
  "cppzmq": {
    "debian_packages": [
      "libzmq3-dev"
    ],
    "brew_packages": [
      "zeromq"
    ],
    "_comment": "- libzmq not yet available as wrap",
    "build_on": {
      "windows": false
    }
  },
  "cpr": {
    "debian_packages": [
      "libcurl4-gnutls-dev"
    ],
    "_comment": "curl not available with MSVC CI",
    "build_on": {
      "windows": false
    }
  },
  "dlfcn-win32": {
    "_comment": "- Requires Windows",
    "build_on": {
      "darwin": false,
      "linux": false
    }
  },
  "epoxy": {
    "debian_packages": [
      "libgl-dev",
      "libegl-dev"
    ],
    "_comment": "- tests are failing under MSVC",
    "build_options": [
      "epoxy:tests=false"
    ]
  },
  "facil": {
    "_comment": "- Requires POSIX platform.",
    "build_on": {
      "windows": false
    }
  },
  "fuse": {
    "_comment": "- relies on Linux and BSD specific APIs",
    "build_on": {
      "darwin": false,
      "windows": false
    }
  },
  "gdbm": {
    "_comment": "- Requires POSIX platform.",
    "build_on": {
      "windows": false
    }
  },
  "glew": {
    "debian_packages": [
      "libgl-dev"
    ]
  },
  "glfw": {
    "debian_packages": [
      "libxi-dev",
      "libxkbcommon-dev"
    ],
    "build_options": [
      "glfw:tests=true",
      "glfw:examples=true"
    ]
  },
  "glib": {
    "_comment": "- Disable unit tests because upstream does not run them on Windows and some are flaky on Linux.",
    "build_options": [
      "glib:tests=false"
    ],
    "skip_dependency_check": [
      "gio-windows-2.0",
      "gio-unix-2.0"
    ]
  },
  "harfbuzz": {
    "_comment": [
      "- Currently builds with no warnings other than an incorrect warning() function",
      "  tracked at https://github.com/harfbuzz/harfbuzz/issues/3378",
      "  Absolutely impossible to fix on Windows."
    ],
    "fatal_warnings": false,
    "build_options": [
      "harfbuzz:glib=enabled",
      "harfbuzz:gobject=enabled",
      "harfbuzz:freetype=enabled",
      "harfbuzz:icu=enabled"
    ]
  },
  "hinnant-date": {
    "build_options": [
      "hinnant-date:use_system_tzdb=true"
    ]
  },
  "htslib": {
    "_comment": "- relies on lots of POSIX interfaces",
    "build_on": {
      "windows": false
    },
    "build_options": [
      "htslib:tests=true"
    ]
  },
  "json-glib": {
    "_comment": "gettext is not optional: https://gitlab.gnome.org/GNOME/json-glib/-/merge_requests/50",
    "debian_packages": [
      "gettext"
    ]
  },
  "imgui": {
    "debian_packages": [
      "liballegro5-dev",
      "libglfw3-dev",
      "libsdl2-dev",
      "libvulkan-dev"
    ]
  },
  "imgui-sfml": {
    "debian_packages": [
      "libgl-dev",
      "libopenal-dev",
      "libudev-dev",
      "libxrandr-dev"
    ]
  },
  "libdrm": {
    "_comment": "- relies on Linux and BSD specific APIs",
    "build_on": {
      "darwin": false,
      "windows": false
    },
    "_comment": "- Upstream has no idea how to use feature options",
    "build_options": [
      "libdrm:amdgpu=enabled",
      "libdrm:etnaviv=enabled",
      "libdrm:exynos=enabled",
      "libdrm:freedreno=enabled",
      "libdrm:intel=enabled",
      "libdrm:nouveau=enabled",
      "libdrm:omap=enabled",
      "libdrm:radeon=enabled",
      "libdrm:tegra=enabled"
    ],
    "debian_packages": [
      "libpciaccess-dev"
    ]
  },
  "libffmpegthumbnailer": {
    "brew_packages": [
      "ffmpeg@4"
    ],
    "debian_packages": [
      "libavcodec-dev",
      "libavfilter-dev",
      "libavformat-dev",
      "libavutil-dev"
    ],
    "_comment": "ffmpeg4 is keg-only. Need to add pkgconfig path.",
    "build_options": [
      "pkg_config_path=/usr/local/opt/ffmpeg@4/lib/pkgconfig"
    ],
    "_comment": "ffmpeg is not available with MSVC CI",
    "build_on": {
      "windows": false
    }
  },
  "libjpeg-turbo": {
    "brew_packages": [
      "nasm"
    ],
    "debian_packages": [
      "nasm"
    ]
  },
  "libkqueue": {
    "_comment": "- MacOS already provides kqueue",
    "build_on": {
      "darwin": false
    }
  },
  "liblastfm": {
    "brew_packages": [
      "curl"
    ],
    "debian_packages": [
      "libcurl4-gnutls-dev"
    ],
    "build_options": [
      "liblastfm:tests=enabled"
    ],
    "_comment": "libcurl is not available with MSVC CI",
    "build_on": {
      "windows": false
    }
  },
  "libliftoff": {
    "_comment": "- depends on libdrm",
    "build_on": {
      "darwin": false,
      "windows": false
    },
    "debian_packages": [
      "libpciaccess-dev"
    ]
  },
  "libnpupnp": {
    "brew_packages": [
      "libmicrohttpd"
    ],
    "debian_packages": [
      "libcurl4-gnutls-dev",
      "libmicrohttpd-dev"
    ],
    "_comment": "libmicrohttpd and libcurl are not available with MSVC CI",
    "build_on": {
      "windows": false
    }
  },
  "libtirpc": {
    "_comment": "Linux only",
    "build_on": {
      "darwin": false,
      "windows": false
    }
  },
  "libupnp": {
    "_comment": "Requires some special pthread library",
    "build_on": {
      "windows": false
    }
  },
  "liburing": {
    "_comment": "- relies on Linux-specific APIs",
    "build_on": {
      "darwin": false,
      "windows": false
    }
  },
  "libusb": {
    "_comment": "non udev backend fails at running in a container.",
    "debian_packages": [
      "libudev-dev"
    ]
  },
  "libxcursor": {
    "_comment": "X11 needs a POSIX system",
    "build_on": {
      "windows": false
    }
  },
  "libxext": {
    "_comment": "X11 needs a POSIX system",
    "build_on": {
      "windows": false
    }
  },
  "libxinerama": {
    "_comment": "X11 needs a POSIX system",
    "build_on": {
      "windows": false
    }
  },
  "libxrandr": {
    "_comment": "X11 needs a POSIX system",
    "build_on": {
      "windows": false
    }
  },
  "libxrender": {
    "_comment": "X11 needs a POSIX system",
    "build_on": {
      "windows": false
    }
  },
  "libxv": {
    "_comment": "X11 needs a POSIX system",
    "build_on": {
      "windows": false
    }
  },
  "libxxf86vm": {
    "_comment": "X11 needs a POSIX system",
    "build_on": {
      "windows": false
    }
  },
  "lmdb": {
    "_comment": "Tests and programs disabled by default",
    "build_options": [
      "lmdb:tests=true",
      "lmdb:programs=true"
    ]
  },
  "mpdecimal": {
    "build_options": [
      "mpdecimal:examples=true",
      "mpdecimal:tests=true"
    ]
  },
  "msgpackc-cxx": {
    "_comment": "- depends on Boost, which is not available on WrapDB",
    "build_on": {
      "windows": false
    },
    "brew_packages": [
      "boost"
    ],
    "debian_packages": [
      "libboost-dev",
      "libboost-system-dev",
      "libboost-test-dev"
    ],
    "build_options": [
      "msgpackc-cxx:tests=true"
    ]
  },
  "nowide": {
    "build_options": [
      "nowide:tests=true"
    ]
  },
  "openh264": {
    "brew_packages": [
      "nasm"
    ],
    "debian_packages": [
      "nasm"
    ],
    "choco_packages": [
      "nasm"
    ],
    "_comment": "Disable tests because they are too slow to run on our CI",
    "build_options": [
      "openh264:tests=disabled"
    ]
  },
  "openssl": {
    "_comment": "- The NodeJS generator requires Linux",
    "build_on": {
      "darwin": false,
      "windows": false
    },
    "debian_packages": [
      "libtext-template-perl",
      "nasm"
    ],
    "build_options": [
      "openssl:build_cli=true"
    ]
  },
  "pkgconf": {
    "_comment": "Tests cannot be run without kyua, which is difficult to install when not packaged.",
    "build_options": [
      "pkgconf:tests=false"
    ]
  },
  "orcus": {
    "_comment": "- depends on Boost, which is not available on WrapDB",
    "build_on": {
      "windows": false
    },
    "brew_packages": [
      "boost"
    ],
    "debian_packages": [
      "libmdds-dev",
      "libboost-filesystem-dev",
      "libboost-iostreams-dev"
    ]
  },
  "qarchive": {
    "build_on": {
      "windows": false
    },
    "debian_packages": [
        "qtbase5-dev"
    ],
    "brew_packages": [
        "qt6"
    ]
  },
  "quazip": {
    "_comment": "- Windows needs qt",
    "build_on": {
      "windows": false
    },
    "brew_packages": [
      "qt"
    ],
    "debian_packages": [
      "qtbase5-dev"
    ]
  },
  "rdkafka": {
    "_comment": "- broken CI finds bad version of OpenSSL on Windows",
    "build_options": [
      "rdkafka:WITH_SSL=disabled"
    ]
  },
  "re2": {
    "build_options": [
      "cpp_std=c++14"
    ]
  },
  "rtaudio": {
    "debian_packages": [
      "libpulse-dev",
      "libasound2-dev",
      "libjack-dev"
    ]
  },
  "sds": {
    "build_on": {
      "windows": false
    },
    "build_options": [
      "sds:tests=true"
    ]
  },
  "sfml": {
    "debian_packages": [
      "libgl-dev",
      "libopenal-dev",
      "libudev-dev",
      "libxrandr-dev"
    ]
  },
  "slirp": {
    "_comment": "- relies on lots of POSIX interfaces",
    "build_on": {
      "windows": false
    }
  },
  "tinyfsm": {
    "build_options": [
      "tinyfsm:build_examples=true"
    ]
  },
  "wayland": {
    "_comment": "- relies on Linux-specific APIs",
    "build_on": {
      "darwin": false,
      "windows": false
    },
    "build_options": [
      "wayland:documentation=false"
    ]
  },
  "wayland-protocols": {
    "_comment": "- relies on wayland-scanner which uses Linux-specific APIs",
    "build_on": {
      "darwin": false,
      "windows": false
    },
    "debian_packages": [
      "libwayland-bin",
      "libwayland-dev"
    ]
  }
}