package dune-release

  1. Overview
  2. Docs

Module Dune_release.PkgSource

Package descriptions.

Package

Sourcetype t

The type for package descriptions.

Sourceval v : dry_run:bool -> ?name:string -> ?version:string -> ?tag:string -> ?keep_v:bool -> ?delegate:Bos_setup.Cmd.t -> ?build_dir:Fpath.t -> ?opam:Fpath.t -> ?opam_descr:Fpath.t -> ?readme:Fpath.t -> ?change_log:Fpath.t -> ?license:Fpath.t -> ?distrib_uri:string -> ?distrib_file:Fpath.t -> ?publish_msg:string -> ?distrib:Distrib.t -> unit -> t
Sourceval infer_pkg_names : Fpath.t -> string list -> (string list, Bos_setup.R.msg) Bos_setup.result

Infer the package list.

Sourceval name : t -> (string, Bos_setup.R.msg) Bos_setup.result

name p is p's name.

Sourceval with_name : t -> string -> t

with_name t n is r such that like name r is n and f r is f t otherwise.

Sourceval version : t -> (string, Bos_setup.R.msg) Bos_setup.result

version p is p's version string.

delegate p is p's delegate.

Sourceval build_dir : t -> (Fpath.t, Bos_setup.R.msg) Bos_setup.result

build_dir p is p's build directory.

Sourceval opam : t -> (Fpath.t, Bos_setup.R.msg) Bos_setup.result

opam p is p's opam file.

opam_descr p is p's opam description.

Sourceval opam_homepage : t -> (string option, Bos_setup.R.msg) Bos_setup.result
Sourceval opam_doc : t -> (string option, Bos_setup.R.msg) Bos_setup.result
Sourceval opam_field : t -> string -> (string list option, Bos_setup.R.msg) Bos_setup.result

opam_field p f looks up field f of p's opam file.

Sourceval opam_field_hd : t -> string -> (string option, Sos.error) Bos_setup.result
Sourceval readmes : t -> (Fpath.t list, Bos_setup.R.msg) Bos_setup.result

readmes p are p's readme files.

Sourceval change_logs : t -> (Fpath.t list, Bos_setup.R.msg) Bos_setup.result

change_logs p are p's change logs.

Sourceval change_log : t -> (Fpath.t, Bos_setup.R.msg) Bos_setup.result

change_log p is the first element of change_logs p.

Sourceval licenses : t -> (Fpath.t list, Bos_setup.R.msg) Bos_setup.result

licenses p are p's license files.

Sourceval distrib_uri : ?raw:bool -> t -> (string, Bos_setup.R.msg) Bos_setup.result

distrib_uri p is p's distribution URI. If raw is true defaults to false, p's raw URI distribution pattern is returned.

Sourceval distrib_file : dry_run:bool -> t -> (Fpath.t, Bos_setup.R.msg) Bos_setup.result

distrib_file p is p's distribution archive.

Sourceval publish_msg : t -> (string, Bos_setup.R.msg) Bos_setup.result

publish_msg p is p's distribution publication message.

Distribution

Sourceval distrib_archive : dry_run:bool -> keep_dir:bool -> t -> (Fpath.t, Bos_setup.R.msg) Bos_setup.result

distrib_archive ~keep_dir p creates a distribution archive for p and returns its path. If keep_dir is true the repository checkout used to create the distribution archive is kept in the build directory.

Sourceval distrib_archive_path : t -> (Fpath.t, Rresult.R.msg) Bos_setup.result
Sourceval archive_url_path : t -> (Fpath.t, Bos_setup.R.msg) Bos_setup.result

archive_url_path is the path to the file where the archive download URL is saved

Sourceval distrib_filename : ?opam:bool -> t -> (Fpath.t, Bos_setup.R.msg) Bos_setup.result

distrib_filename ~opam p is a distribution filename for p. If opam is true (defaults to false), the name follows opam's naming conventions.

Uri

Sourceval doc_uri : t -> (string, Bos_setup.R.msg) Bos_setup.result
Sourceval doc_dir : Fpath.t
Sourceval doc_user_repo_and_path : t -> (string * string * Fpath.t, Bos_setup.R.msg) Bos_setup.result
Sourceval distrib_user_and_repo : t -> (string * string, Bos_setup.R.msg) Bos_setup.result

Test

Sourceval test : f

Build

Sourceval build : f

Tag

Sourceval extract_tag : t -> (string, Sos.error) Bos_setup.result

Dev repo

Sourceval dev_repo : t -> (string option, Sos.error) Bos_setup.result