gitlab-unix

GitLab APIv4 OCaml library
README


Native OCaml bindings to Gitlab REST API v4.

The API coverage is incomplete (currently we support many of the Commit, Project, User and Event
APIs) but if you find something missing please create an Issue or PR.

Pre-requisites

  • Plain opam / ocaml for building.

Configuration

Gitlab can be hosted in multiple places and configurations. By default the library uses
the public gitlab.com site with it's API endpoint of https://gitlab.com/api/v4. This
can be changed with:

GITLAB_URL # to configure the GitLab instance to connect to.

or programatically by overriding the Env module.

Debugging

Two environment variables will cause more debugging to be output:

GITLAB_DEBUG=1   # API calls output to stderr
COHTTP_DEBUG=1   # even more HTTP-level debugging

If using the bindings from the toplevel, you can also set Gitlab.log_active
to true to get the same effect as setting the GITLAB_DEBUG environment
variable.

Lab Cli

A command line client is provided called lab in the style of a similarly named
tool hub for GitHub. From source you can run as:

dune exec -- lab <arguments>

If you opam install lab then the executable is available as lab.

Run lab -h for more information about cli options.

Tests

Running mdx tests for lab cli:

# Run integration tests against real gitlab instance
dune runtest --profile non-deterministic

# Promote any changes
dune runtest --profile non-deterministic --auto-promote

NOTE that ocaml-ci doesn't run these tests, any changes to the cli need to be validated manually.

Resources

MDX Setup in RWO

Install
Sources
lab-0.1.3.tbz
sha256=4b6107f10cbe34638378946f4a475ac5d7d66f88fc26046203a22c532f426002
sha512=be937237ae8e81fef02a7c2f027ffc5094107e76393b19b346fe3b4f75dd6bf69742c35a55cfaf3ab45746147941eb300052ac5bc909fd3efa9f7bb17df522be
Dependencies
odoc
with-doc
alcotest
with-test
lwt
>= "2.4.4"
tls
>= "0.11.0"
cohttp
>= "4.0"
cmdliner
>= "1.1.0"
gitlab
= version
ocaml
>= "4.08.0"
dune
>= "2.9"
Reverse Dependencies