package yocaml_git

  1. Overview
  2. Docs
On This Page
  1. API

Module Yocaml_gitSource

Allows you to define a Runtime that uses Git as a compilation target.

API

Sourceval execute : (module Yocaml_git__.Runtime.RUNTIME) -> (module Mirage_clock.PCLOCK) -> ctx:Mimic.ctx -> ?author:string -> ?email:string -> ?comment:string -> string -> 'a Yocaml.Effect.t -> ('a, [> `Msg of string ]) result Lwt.t

Executes a YOCaml program using a given Runtime for processing with Source and using a Git Store as compilation target. What the YOCaml progam generates is compared with what you can view from the given remote repository and updated with a new Git commit. Then, we push these changes to the remote repository.

ctx contains multiple informations needed to initiate a communication with the given remote repository. See Git_unix.ctx for more details.