package b0

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Release metadata
Versions
Source archives
Change logs
Cmdlets

package b0

b0
- B0_build
- B0_cli
  - Arg
- B0_cmdlet
  - Env
  - Map
  - Set
- B0_def
  - Make
    
    Map
    
    Set
    
    V
  - S
    
    Map
    
    Set
  - Scope
  - VALUE
- B0_dir
- B0_driver
  - Cli
  - Compile
  - Conf
  - Env
  - Exit
- B0_file
- B0_meta
  - Key
- B0_pack
  - Map
  - Set
- B0_unit
  - Action
  - Map
  - Set
b0.b0
- B0_b0
  - Cli
  - Def
- B0_cmd_build
- B0_cmd_cmd
- B0_cmd_cmdlet
- B0_cmd_delete
- B0_cmd_file
- B0_cmd_list
- B0_cmd_log
- B0_cmd_pack
- B0_cmd_root
- B0_cmd_scope
- B0_cmd_unit
- B0_main
b0.b00
- B00
  - Env
  - Memo
  - Store
  - Tool
- B000
  - Exec
  - File_cache
  - Guard
  - Op
    
    Copy
    
    Delete
    
    Map
    
    Mkdir
    
    Notify
    
    Read
    
    Set
    
    Spawn
    
    Wait_files
    
    Write
  - Reviver
  - Trash
- B000_conv
  - Op
b0.b00.kit
- B00_base64
- B00_cli
  - Arg
  - B00_std
  - Exit
  - File_cache
  - Memo
    
    Log
  - Op
- B00_cmark
- B00_editor
  - Env
- B00_fexts
- B00_findex
- B00_github
  - Auth
  - Issue
  - Pages
  - Release
  - Repo
- B00_htmlg
  - At
    
    Name
  - El
- B00_http
  - Http
  - Httpr
  - Uri
- B00_jsoo
- B00_lines
- B00_ocaml
  - Archive
  - Cobj
    
    Map
    
    Set
  - Compile
  - Conf
  - Crunch
  - Lib
    
    Name
    
    Map
    
    Set
    
    Resolver
  - Link
  - Mod
    
    Name
    
    Ref
    
    Map
    
    Set
    
    Src
    
    Deps
  - Ocamlpath
  - Tool
- B00_odoc
  - Compile
    
    Dep
    
    Writes
  - Html
    
    Dep
    
    Writes
  - Html_fragment
  - Support_files
    
    Writes
  - Theme
- B00_os
- B00_pager
  - Env
- B00_pdf_viewer
  - Env
- B00_rsync
- B00_serialk_json
  - Json
  - Jsong
  - Jsonq
- B00_serialk_sexp
  - Sexp
  - Sexpg
  - Sexpq
- B00_serialk_text
  - Tdec
  - Tloc
- B00_trace
  - Compilation_database
  - Trace_event
- B00_vcs
  - Git
  - Hg
- B00_www_browser
  - Env
b0.b00.std
- B00_std
  - Bincode
  - Char
    
    Ascii
  - Cmd
  - Fmt
  - Fpath
    
    Map
    
    Set
  - Fut
    
    Syntax
  - Hash
    
    Murmur3_128
    
    T
    
    Xxh_64
  - List
  - Log
  - Os
    
    Cmd
    
    Cpu
    
    Dir
    
    Env
    
    Exit
    
    Fd
    
    File
    
    Path
  - Result
    
    Syntax
  - Rqueue
  - String
    
    Ascii
    
    Map
    
    Set
  - Tid
  - Time
    
    Span
  - Tty
b0.kit
- B0_jsoo
- B0_kit
  - V000
- B0_ocaml
  - Meta
- B0_ocaml_eco
- B0_opam
  - Cmdlet
  - File
  - Meta
- B0_release
  - Cmdlet
  - Meta
- B0_srcs

Legend:
Library
Module
Module type
Parameter
Class
Class type

B0 software release helpers.

Release metadata

module Meta : sig ... end

Metadata keys for releases.

Versions

val version_of_pack : 
  ?commit_ish:B00_vcs.commit_ish ->
  B0_pack.t ->
  (string, string) result

version_of_pack p looks for a VCS in the scope directory of p and gets its latest annotated tag reachable from commit_ish (defaults to "HEAD") and drops an initial 'v' or 'V'. TODO. add a meta key to prevent v drop.

Source archives

val src_archive_name_of_pack : B0_pack.t -> string

src_archive_name_of_meta m is the value or Meta.src_archive_name or the pack's basename if absent, unless this is "default" in which case the basename of the pack's scope is taken.

val src_archive_ext_of_pack : B0_pack.t -> string

src_archive_ext_of_pack p is the value of Meta.src_archive_ext of p or ".tbz".

val src_archive_url_of_pack : 
  version:string ->
  B0_pack.t ->
  (string, string) result

src_url_of_meta ~version p derives a source URL for the pack p. This looks up Meta.src_archive_url p and substitute the variables as follows:

%‌%ARCHIVE_NAME%‌% with the value of src_archive_name_of_pack.
%‌%ARCHIVE_EXT%‌% with the value of src_archive_name_of_ext.
%‌%VERSION%‌% with the value of version
%‌%VERSION_NUM%‌% with the value of version with an initial v or V chopped.

If Meta.src_archive_url is absent, let %%HOMEPAGE%% be the value of B0_meta.homepage and %%REPO%% be the value of B0_meta.repo without the final .git and initial git+ Then:

If the hostname of B0_meta.homepage is github the following URL pattern is used:

%‌%REPO%‌%/releases/download/%‌%VERSION%‌%/\
%‌%ARCHIVE_NAME%‌%-%‌%VERSION_NUM%‌%‌%‌%ARCHIVE_EXT%‌%

Otherwise the following URL pattern is used:

%‌%HOMEPAGE%‌%/releases/\
%‌%ARCHIVE_NAME%‌%-%‌%VERSION_NUM%‌%‌%‌%ARCHIVE_EXT%‌%

Change logs

val changes_file_of_pack : B0_pack.t -> (B00_std.Fpath.t option, string) result

changes_file_of_pack p looks for a CHANGES.md file located in the scope directory of p.

val changes_latest_of_file : 
  B00_std.Fpath.t ->
  ((string * string) option, string) result

changes_latest_of_file f extracts the latest release notes as the first markdown section of file f.

Cmdlets

module Cmdlet : sig ... end

.release.* Cmdlets