package dune-release

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Descr file

package dune-release

dune-release
- Dune_release
  - App_log
  - Archive
  - Check
  - Config
    
    Cli
    
    Draft_pr
    
    Draft_release
    
    Opam_repo_fork
    
    Release_asset_name
    
    S
  - Curl
  - Curl_option
  - Deprecate
    
    Config_user
    
    Opam_1_x
  - Distrib
  - Github
    
    Parse
  - Github_repo
  - Github_v3_api
    
    Archive
    
    Request
    
    Response
    
    Pull_request
    
    Request
    
    Response
    
    Release
    
    Request
    
    Response
  - Github_v4_api
    
    Pull_request
    
    Request
    
    Response
  - Json
  - Lint
  - Opam
    
    Descr
    
    File
    
    Url
  - Opam_file
  - Pkg
  - Prompt
  - Sos
  - Stdext
    
    List
    
    Option
    
    O
    
    Path
    
    Result
    
    List
    
    Sbytes
    
    String
    
    Unix
  - Text
    
    Pp
  - Uri_helpers
  - Vcs
    
    Tag
    
    Tag_or_commit_ish
  - Version
    
    Changelog
  - Xdg

Legend:
Library
Module
Module type
Parameter
Class
Class type

descr files.

Descr file

type t = string * string option

The type for opam descr files, the package synopsis and the description.

val of_string : string -> (t, Bos_setup.R.msg) Bos_setup.result

of_string s is a description from the string s.

val to_string : t -> string

to_string d is d as a string.

val of_readme_file : Fpath.t -> (t, Bos_setup.R.msg) Bos_setup.result

of_readme_file f extracts an opam description file from a readme file f using Text.flavour_of_fpath.