package opam-ci
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=0aa95de2b2a3448bfd42344fe5ef56af6897bffe57310645355d708225e63d08
md5=ec811f2e406f9bea44549bb2a331a70b
Description
The opam-ci tool provides an interface to the opam 2.0 continuous integration cluster, which regularly rebuilds the package repository across a variety of OCaml compiler versions, operating system distributions and CPU architectures. These builds are done regularly in remote infrastructure and the results are pushed to a metadata repository where they are fetched by this command to give you a summary of the status of your own packages.
The opam ci status command shows a dashboard of the build results
across this matrix. Packages can be filtered by maintainer substrings
or tag names in the opam package description, so you see only those
relevant to you.
The opam ci logs command will show you the build errors so you can fix
them. It also generates a Dockerfile of the precise build to reproduce
the environment locally for you.
To get started, try these commands with the maintainer argument replaced with your own information or tags:
# show all the failing MirageOS packages
opam ci status -m org:mirage | less -R
# show all the packages maintained by anil@recoil.org
opam ci status -m anil@recoil.org --filter=all | less -R
# show all the packages failing on the latest RC of the OCaml compiler
opam ci status --filter=variants:rc | less -R
# display all failure logs for the mirage-xen package
opam ci logs mirage-xen
See the --help pages for the subcommands below for more detailed
information.
README
OCaml Build Infrastructure
This repository contains the scripts, libraries and command-line tools to access the opam2 bulk build infrastructure that checks on the health of the opam package manager.
The main services and repositories associates with this infrastructure are:
Documentation:
https://github.com/ocaml/infrastructure/wiki/Containers is rebuilt automatically with the latest information
GitHub: Git repositories
https://github.com/ocaml/obi: for the source code
https://github.com/ocaml/obi-logs: for the build logs
Docker Hub: container images
https://hub.docker.com/r/ocaml/opam2: opam2 and OCaml compiler images
https://hub.docker.com/r/ocaml/opam2-staging: intermediate container images for bulk builds
Coordination:
https://buildkite.com/ocaml: the coordination Hub (account required until buildkite#137 is resolved)
Getting Started
The main tool you will want to try out is opam-ci, which provides CLI access to build results. You can get this by:
opam pin add -n obi https://github.com/ocaml/obi.git
opam pin add opam-ci https://github.com/ocaml/obi.git
and then try it out via:
opam-ci --help
opam-ci status --help
opam-ci logs --help
Further Information
CHANGES.md is the repository changelog for source code and Buildkite scripts.
METADATA.md contains a changelog for the Obi sexp format that is published on https://github.com/ocaml/obi-logs/tree/index.
While we are assembling the documentation, please contact @avsm for more information.