package datakit-github

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature
Token
Synchronisation
Webhooks

datakit-github
- Datakit_github_api
  - Webhook
datakit-github.client
- Datakit_github
  - API
    
    Webhook
  - Capabilities
  - Commit
    
    Set
  - Diff
  - ELT
  - Elt
    
    IdSet
    
    Set
  - Event
  - MAP
  - PR
    
    Index
    
    Set
  - Ref
    
    Index
    
    Set
  - Repo
    
    Map
    
    Set
  - SET
  - Set
    
    E
  - Snapshot
  - State
    
    API
    
    Webhook
  - Status
    
    Index
    
    Set
  - Status_state
- Datakit_github_conv
  - Make
    
    DK
    
    Branch
    
    Commit
    
    Transaction
    
    Tree
- Datakit_github_sync
  - Make
    
    API
    
    Webhook
    
    DK
    
    Branch
    
    Commit
    
    Transaction
    
    Tree
datakit-github.server
- Datakit_github_vfs
  - Make
    
    API
    
    Webhook

Legend:
Library
Module
Module type
Parameter
Class
Class type

API State: TODO find a better name?

Parameters

module API : API

Signature

Token

type token

The type for state token.

val token : API.token -> Capabilities.t -> token

token t c is the token using the GitHub API token t limited by the capabilities c.

val capabilities : token -> Capabilities.t

capabilities t is the token t's capabilities.

val with_capabilities : Capabilities.t -> token -> token

with_capabilities c t is t with the capabilities c.

Synchronisation

val import : token -> Snapshot.t -> Elt.IdSet.t -> Snapshot.t Lwt.t

import token t r imports the state of GitHub for the elements in r into t. API calls use the token token.

val apply : token -> Diff.t -> unit Lwt.t

apply token d applies the snapshot diff d as a series of GitHub API calls, using the token token.

Webhooks

val add_webhooks : 
  token ->
  watch:(Repo.t -> unit Lwt.t) ->
  Repo.Set.t ->
  unit Lwt.t

add_webhooks t rs adds webhooks for the repositories rs.

val import_webhook_events : 
  token ->
  events:(unit -> Event.t list) ->
  Snapshot.t ->
  Snapshot.t Lwt.t

import_webhook_events t ~events s applies events () on top of s. Note: it ensure that all the metadata are correctly updated by inserting (possibly) missing events in the mix. For instance, GitHub never sends status events, so import_events has to reconstruct them.