datakit-github 0.8.1 · OCaml Package

type token

API tokens

The type for API tokens.

type 'a result = ('a, string) Result.result Lwt.t

The type for results.

val user_exists : token -> user:string -> bool result

exist_user t ~user is true iff user exists.

val repo_exists : token -> Datakit_github.Repo.t -> bool result

exists_repo t r is true iff the repository r exists.

val repos : token -> user:string -> Datakit_github.Repo.t list result

repos t ~user is the list of repositories owned by user user.

val status : 
  token ->
  Datakit_github.Commit.t ->
  Datakit_github.Status.t list result

status t c returns the list of status attached to the commit c.

val set_status : token -> Datakit_github.Status.t -> unit result

set_status t s updates Status.commit s's status with s.

val set_ref : token -> Datakit_github.Ref.t -> unit result

set_ref t r updates the reference named Ref.name r with r.

val remove_ref : token -> Datakit_github.Repo.t -> string list -> unit result

remove_ref t n removes the reference named n.

val set_pr : token -> Datakit_github.PR.t -> unit result

set_pr t pr updates the PR number PR.number pr with pr.

val prs : token -> Datakit_github.Repo.t -> Datakit_github.PR.t list result

prs t r is the list of open pull-requests for the repo r.

val pr : token -> Datakit_github.PR.id -> Datakit_github.PR.t option result

pr t id is the contents of the pull request whose ID Is id.

val refs : token -> Datakit_github.Repo.t -> Datakit_github.Ref.t list result

refs t r is the list of references for the the repo r.

val ref : token -> Datakit_github.Ref.id -> Datakit_github.Ref.t option result

ref t id is the Git reference whose ID is id.

val events : 
  token ->
  Datakit_github.Repo.t ->
  Datakit_github.Event.t list result

event t r is the list of events attached to the repository r. Note: can be slow/costly if multiple pages of events.

module Webhook : sig ... end

package datakit-github