package dune-release

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Distribution description
Distribution description

dune-release
- Dune_release
  - App_log
  - Archive
  - Config
  - Delegate
  - Distrib
  - Github
    
    Parse
  - Lint
  - Opam
    
    Descr
    
    File
    
    Url
  - Pkg
  - Prompt
  - Sos
  - Text
    
    Pp
  - Vcs
  - Xdg

Legend:
Library
Module
Module type
Parameter
Class
Class type

Distribution description

type t

The type for describing distribution creation.

val v : 
  ?massage:(unit -> (unit, Rresult.R.msg) Rresult.result) ->
  ?exclude_paths:(unit -> (Fpath.t list, Rresult.R.msg) Rresult.result) ->
  unit ->
  t

distrib ~massage ~exclude_paths () influences the distribution creation process performed by the dune-release tool. See the full details about distribution creation.

In the following the distribution build directory is a private clone of the package's source repository's HEAD when dune-release distrib is invoked.

massage is invoked in the distribution build directory, before archiving. It can be used to generate distribution time build artefacts. Defaults to massage.
exclude_paths () is invoked in the distribution build directory, after massaging, to determine the paths that are excluded from being added to the distribution archive. Defaults to exclude_paths.

val default_massage : unit -> (unit, Rresult.R.msg) Rresult.result

default_massage is the default distribution massaging function. It is invoked in the distribution build directory and does nothing.

val default_exclude_paths : 
  unit ->
  (Fpath.t list, Rresult.R.msg) Rresult.result

default_exclude_paths () is the default list of paths to exclude from the distribution archive. It is invoked in the distribution build directory and returns the following static set of files.

fun () -> Ok [".git"; ".gitignore"; ".gitattributes"; ".hg"; ".hgignore";
              "build"; "Makefile"; "_build"]

val massage : t -> unit -> (unit, Rresult.R.msg) Rresult.result

val exclude_paths : t -> unit -> (Fpath.t list, Rresult.R.msg) Rresult.result