package dune-release

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Ustar archives
Bzip2 compression and unarchiving

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

Archive creation.

Ustar archives

val tar : 
  Fpath.t ->
  exclude_paths:Fpath.set ->
  root:Fpath.t ->
  mtime:int64 ->
  (string, Bos_setup.R.msg) Bos_setup.result

tar dir ~exclude_paths ~root ~mtime is a (us)tar archive that contains the file hierarchy dir except the relative hierarchies present in exclude_paths. In the archive, members of dir are rerooted at root and sorted according to Fpath.compare. They have their modification time set to mtime and their file permissions are 0o775 for directories and files executable by the user and 0o664 for other files. No other file metadata is preserved.

Note. This is a pure OCaml implementation, no tar tool is needed.

Bzip2 compression and unarchiving

val ensure_bzip2 : unit -> (unit, Bos_setup.R.msg) Bos_setup.result

ensure_bzip2 () makes sure the bzip2 utility is available.

val bzip2 : 
  dry_run:bool ->
  ?force:bool ->
  dst:Fpath.t ->
  string ->
  (unit, Bos_setup.R.msg) Bos_setup.result

bzip2 dst s compresses s to dst using bzip2.

val untbz : 
  dry_run:bool ->
  ?clean:bool ->
  Fpath.t ->
  (Fpath.t, Bos_setup.R.msg) Bos_setup.result

untbz ~clean ar untars the tar bzip2 archive ar in the same directory as ar and returns a base directory for ar. If clean is true (defaults to false) first delete the base directory if it exists.