package b0

You can search for identifiers within the package.

in-package search v0.2.0

Software construction and deployment kit

Install

Dune Dependency

erratique.ch Readme Changelog ISC; BSD-2-Clause License Edit opam file Versions (6)

Authors

T

The b0 programmers

Maintainers

Daniel Bünzli

Sources

b0-0.0.1.tbz

sha256=dba2fc571f39f3b8e87ee55c77bdec7ec6a5ddc7d99b8b20aeda848af546be04

md5=51ee1d66acc4d7f87bdceac1341b7711

doc/b00_kit/B00_github/index.html

Module `B00_github`

GitHub interaction.

GitHub authentication

type auth

The type for GitHub authentication.

val auth : user:string -> unit -> (auth, string) Stdlib.result

auth ~http ~user () determines a personal access token for user user. It first looks up the contents of the B0_GITHUB_TOKEN environment variable if that fails it looks up for an existing token in the Os.Dir.config () /github/b0-$USER.token file. If that fails instructions are printed on how to setup the token.

GitHub API requests

type content_type = string

The type for content types.

type v3_body = [

| `Json of B00_serialk_json.Jsong.t
| `Other of content_type * string
| `Empty

]

The type for GitHub V3 request bodies. Either JSON or something else tagged with its content type or nothing.

val req_json_v3 : 
  ?headers:B00_http.Http.headers ->
  B00_http.Httpr.t ->
  auth ->
  path:string ->
  B00_http.Http.meth ->
  v3_body ->
  (B00_serialk_json.Json.t, string) Stdlib.result

req_json_v3 auth path m ~headers body performs the request for json on path using method m, additional headers headers, body body and authentication auth.

val query_v4 : 
  B00_http.Httpr.t ->
  auth ->
  string ->
  (B00_serialk_json.Json.t, string) Stdlib.result

query_v4 auth q performs the the GitHub GraphQL V4 query q using authentication auth.

Higher-level interface

module Repo : sig ... end

GitHub repositories.

module Issue : sig ... end

Repository issues.

module Release : sig ... end

Repository releases.

module Pages : sig ... end

Publish to GitHub pages.

On This Page

GitHub authentication
GitHub API requests
Higher-level interface