package datakit-ci

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Job Targets

package datakit-ci

datakit-ci
- CI_ACL
- CI_cache
  - Make
    
    B
    
    Key
  - Path
- CI_char_stream
- CI_config
- CI_docker
  - Image
- CI_engine
- CI_escape_parser
- CI_eval
  - Make
    
    C
    
    Infix
- CI_form
  - Html
  - State
  - Validator
- CI_git
  - Commit
- CI_history
  - State
- CI_live_log
- CI_log_reporter
- CI_main
- CI_monitored_pool
- CI_output
- CI_process
- CI_result
- CI_s
  - BUILDER
    
    Key
  - CONTEXT
  - TERM
    
    Infix
- CI_secrets
- CI_static
- CI_target
  - Branch_escape
  - Map
  - Set
- CI_term
  - Infix
- CI_utils
  - Client9p
    
    LowLevel
  - DK
    
    Branch
    
    Commit
    
    Infix
    
    Transaction
    
    Tree
  - Infix
  - Log
- CI_web
- CI_web_templates
  - Error
  - Settings
- CI_web_utils
  - Auth
  - Session_data
  - User
  - Wm
    
    resource
  - auth_intro
  - auth_setup
  - form_page
  - github_auth_settings
  - github_callback
  - html_page
  - login_page
  - logout_page
  - post_page
  - protected_page
  - resource
  - resource_with_session
  - static
  - static_crunch
- Datakit_ci
  - ACL
  - BUILDER
    
    Key
  - Cache
    
    Make
    
    B
    
    Key
    
    Path
  - Config
  - DK
    
    Branch
    
    Commit
    
    Infix
    
    Transaction
    
    Tree
  - Docker
    
    Image
  - Git
  - Live_log
  - Monitored_pool
  - Output
  - Private
    
    Client9p
    
    LowLevel
  - Process
  - Target
  - Term
    
    Infix
  - Utils
    
    Infix
  - Web

Legend:
Library
Module
Module type
Parameter
Class
Class type

Job Targets

type t = [

| `PR of Datakit_github.PR.id
| `Ref of Datakit_github.Ref.id

]

The type for computation targets. A target can either be a pull-request ID, e.g. a GitHub repository and a number; or a reference ID, e.g. a GitHub repository and a reference name (given as a list of string, e.g. "heads/master" should be split into ["heads"]; ["master"]).

val compare : t -> t -> int

compare is the comparison function for GitHub targets.

val repo : t -> Datakit_github.Repo.t

repo t is t's repository.

val id : t -> [ `PR of int | `Ref of string list ]

id t is t's ID, e.g either a pull-request number or a reference name split on '/'.

val pp : t Fmt.t

pp is the pretty-printer for GitHub targets.

type v = [

| `PR of Datakit_github.PR.t
| `Ref of Datakit_github.Ref.t

]

The type for resolved GitHub targets. Resolved pull-request and references contains the head commit and other metadata (see Datakit_github's documentation for more details).

val head : v -> Datakit_github.Commit.t

head v is the head commit of v.

val compare_v : v -> v -> int

compare_v compares values of type v.

val repo_v : v -> Datakit_github.Repo.t

repo_v v is v's repository.

val pp_v : v Fmt.t

pp_v is the pretty-printer for resolved GitHub targets.