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",
    "tinyxml2"
  ],
  "c-flags": {
    "build_options": [
      "c-flags:tests=true"
    ]
  },
  "cairo": {
    "_comment": "Some tests fails and they are still run despite -Dtests=disabled",
    "skip_tests": true
  },
  "cexception": {
    "build_options": [
      "cexception:werror=false"
    ]
  },
  "cli11": {
    "build_options": [
      "cpp_std=c++14"
    ]
  },
  "cppzmq": {
    "debian_packages": [
      "libzmq3-dev"
    ],
    "brew_packages": [
      "zeromq"
    ],
    "msys_packages": [
      "zeromq"
    ],
    "_comment": "- libzmq not yet available as wrap",
    "build_on": {
      "windows": false
    }
  },
  "curl": {
    "_comment": [
      "don't bother installing samba: not usable by the testuite due to smbd non-standard install name",
      "don't install stunnel: it breaks the testsuite (certificates issues)",
      "even with libpsl installed, the dependency is not detected…",
      "ditto with openldap (“unknown version” at dependency check)"
    ],
    "brew_packages": [
      "gnutls",
      "krb5",
      "libidn2",
      "libpsl",
      "nghttp2",
      "openldap",
      "rtmpdump"
    ],
    "debian_packages": [
      "gnutls-bin",
      "krb5-multidev",
      "libgsasl-dev",
      "libidn2-dev",
      "libldap-dev",
      "libnghttp2-dev",
      "libpsl-dev",
      "librtmp-dev",
      "libssh2-1-dev",
      "nghttp2-proxy",
      "python3-impacket",
      "samba",
      "stunnel4",
      "winbind"
    ],
    "msys_packages": [
      "gss",
      "libpsl",
      "libssh2",
      "nghttp2",
      "rtmpdump"
    ],
    "build_options": [
      "curl:ca_bundle=",
      "curl:ca_path="
    ]
  },
  "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
    }
  },
  "fontconfig": {
    "fatal_warnings": false
  },
  "freeglut": {
    "brew_packages": [
      "libx11",
      "libxi",
      "libxrandr",
      "libxxf86vm",
      "mesa"
    ],
    "debian_packages": [
      "libgl-dev",
      "libglu1-mesa-dev",
      "libxi-dev"
    ]
  },
  "fuse": {
    "_comment": "- relies on Linux and BSD specific APIs",
    "build_on": {
      "darwin": false,
      "msys2": false,
      "windows": false
    }
  },
  "gdbm": {
    "_comment": "- Requires POSIX platform.",
    "build_on": {
      "msys2": false,
      "windows": false
    }
  },
  "gdk-pixbuf": {
    "_comment": [
      "- Disable man because it requires rst2man",
      "- Disable fatal warnings because of CMake Toolchain: Failed to determine CMake compilers state",
      "- Disable fatal warnings because of https://gitlab.gnome.org/GNOME/gdk-pixbuf/-/merge_requests/156",
      "- Disable tests because one is broken: https://gitlab.gnome.org/GNOME/gdk-pixbuf/-/issues/215",
      "- Disable tests because they fail on macOS"
    ],
    "build_options": [
      "gdk-pixbuf:man=false"
    ],
    "fatal_warnings": false,
    "skip_tests": true
  },
  "gee": {
    "_comment": "- needs valac, not easy to install on Windows",
    "build_on": {
      "windows": false
    },
    "brew_packages": [
      "vala"
    ],
    "debian_packages": [
      "valac"
    ],
    "msys_packages": [
      "vala"
    ]
  },
  "giflib": {
    "_comment": "Unnecessary <unistd.h> include in gif_hash.h breaks the build",
    "build_on": {
      "windows": false
    },
    "msys_packages": [
      "diffutils"
    ]
  },
  "glbinding": {
    "debian_packages": [
      "libxi-dev",
      "libxkbcommon-dev"
    ],
    "build_options": [
      "glbinding:build_tests=enabled"
    ]
  },
  "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"
    ]
  },
  "gumbo-parser": {
    "build_options": [
      "gumbo-parser:examples=enabled",
      "gumbo-parser:tests=enabled"
    ]
  },
  "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"
    ],
    "skip_dependency_check": [
      "harfbuzz-cairo"
    ]
  },
  "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"
    ]
  },
  "jbig2dec": {
    "msys_packages": [
      "libpng"
    ]
  },
  "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"
    ]
  },
  "leptonica": {
    "debian_packages": [
      "gnuplot",
      "libgif-dev",
      "libwebp-dev"
    ],
    "msys_packages": [
      "giflib",
      "gnuplot",
      "libjpeg-turbo",
      "libpng",
      "libtiff",
      "libwebp",
      "openjpeg2"
    ],
    "_comment": "Some tests takes more than 30s to complete.",
    "test_options": [
      "--timeout-multiplier=2"
    ]
  },
  "libdrm": {
    "_comment": "- relies on Linux and BSD specific APIs",
    "build_on": {
      "darwin": false,
      "msys2": 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"
    ]
  },
  "libffi": {
    "_comment": "libffi has too many unit tests and it exceed command line limit to rebuild test targets",
    "test_options": [
      "--no-rebuild"
    ]
  },
  "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": "Broken with Windows because of a header issue",
    "build_on": {
      "msys2": false,
      "windows": false
    }
  },
  "libjpeg-turbo": {
    "brew_packages": [
      "nasm"
    ],
    "choco_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": "broken",
    "build_on": {
      "msys2": false,
      "windows": false
    }
  },
  "libliftoff": {
    "_comment": "- depends on libdrm",
    "build_on": {
      "darwin": false,
      "msys2": false,
      "windows": false
    },
    "debian_packages": [
      "libpciaccess-dev"
    ]
  },
  "libtirpc": {
    "_comment": "Linux only",
    "build_on": {
      "darwin": false,
      "msys2": 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,
      "msys2": 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": {
      "msys2": false,
      "windows": false
    }
  },
  "libxext": {
    "_comment": "X11 needs a POSIX system",
    "build_on": {
      "msys2": false,
      "windows": false
    }
  },
  "libxinerama": {
    "_comment": "X11 needs a POSIX system",
    "build_on": {
      "msys2": false,
      "windows": false
    }
  },
  "libxrandr": {
    "_comment": "X11 needs a POSIX system",
    "build_on": {
      "msys2": false,
      "windows": false
    }
  },
  "libxrender": {
    "_comment": "X11 needs a POSIX system",
    "build_on": {
      "msys2": false,
      "windows": false
    }
  },
  "libxv": {
    "_comment": "X11 needs a POSIX system",
    "build_on": {
      "msys2": false,
      "windows": false
    }
  },
  "libxxf86vm": {
    "_comment": "X11 needs a POSIX system",
    "build_on": {
      "msys2": false,
      "windows": false
    }
  },
  "lmdb": {
    "_comment": "Tests and programs disabled by default",
    "build_options": [
      "lmdb:tests=true",
      "lmdb:programs=true"
    ]
  },
  "magic_enum": {
    "build_options": [
      "magic_enum:test=false"
    ],
    "skip_tests": 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"
    ],
    "msys_packages": [
      "boost"
    ],
    "build_options": [
      "msgpackc-cxx:tests=true"
    ]
  },
  "nowide": {
    "build_options": [
      "nowide:tests=true"
    ]
  },
  "oatpp-openssl": {
    "build_on": {
      "darwin": false
    },
    "_comment": "openssl wrap fails on darwin (known) and the native openssl doesn't get detected (by default) so it can't be built atm"
  },
  "openh264": {
    "brew_packages": [
      "nasm"
    ],
    "debian_packages": [
      "nasm"
    ],
    "choco_packages": [
      "nasm"
    ],
    "msys_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,
      "msys2": false,
      "windows": false
    },
    "debian_packages": [
      "libtext-template-perl",
      "nasm"
    ],
    "build_options": [
      "openssl:build_cli=true"
    ]
  },
  "opus": {
    "_comment": "Remove when fixed: https://github.com/xiph/opus/pull/285",
    "fatal_warnings": false,
    "_comment2": "Remove when fixed: https://github.com/xiph/opus/pull/287",
    "test_options": [
      "--timeout-multiplier=2"
    ]
  },
  "pango": {
    "_comment": [
      "- harfbuzz triggers warnings",
      "- Known test failure: https://gitlab.gnome.org/GNOME/pango/-/issues/682"
    ],
    "fatal_warnings": false,
    "skip_tests": true
  },
  "pixman": {
    "_comment": "Some tests takes more than 2min to complete.",
    "test_options": [
      "--timeout-multiplier=3"
    ]
  },
  "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"
    ],
    "msys_packages": [
      "boost"
    ],
    "debian_packages": [
      "libmdds-dev",
      "libboost-filesystem-dev",
      "libboost-iostreams-dev"
    ]
  },
  "qarchive": {
    "build_on": {
      "windows": false
    },
    "msys_packages": [
      "qt5-base"
    ],
    "debian_packages": [
      "qtbase5-dev"
    ],
    "brew_packages": [
      "qt6"
    ]
  },
  "quazip": {
    "_comment": "- Windows needs qt",
    "build_on": {
      "windows": false
    },
    "brew_packages": [
      "qt"
    ],
    "msys_packages": [
      "qt5-base"
    ],
    "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
    }
  },
  "sqlitecpp": {
    "_comment": "required to not use the default sqlite3 in MacOS to avoid compilation errors/tests failures, also add pkgconfig path to find sqlite3(keg-only)",
    "build_options": [
      "sqlitecpp:SQLITECPP_BUILD_TESTS=true",
      "sqlitecpp:SQLITECPP_BUILD_EXAMPLES=true",
      "pkg_config_path=/usr/local/opt/sqlite/lib/pkgconfig"
    ],
    "brew_packages": [
      "sqlite"
    ]

  },
  "tinyfsm": {
    "build_options": [
      "tinyfsm:build_examples=true"
    ]
  },
  "wayland": {
    "_comment": "- relies on Linux-specific APIs",
    "build_on": {
      "darwin": false,
      "msys2": false,
      "windows": false
    },
    "build_options": [
      "wayland:documentation=false"
    ]
  },
  "wayland-protocols": {
    "_comment": "- relies on wayland-scanner which uses Linux-specific APIs",
    "build_on": {
      "darwin": false,
      "msys2": false,
      "windows": false
    },
    "debian_packages": [
      "libwayland-bin",
      "libwayland-dev"
    ],
    "build_options": [
      "wayland:documentation=false",
      "wayland:libraries=false",
      "wayland:tests=false",
      "wayland:dtd_validation=false"
    ]
  }
}