Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source
Page
Library
Module
Module type
Parameter
Class
Class type
Source
package dune-release
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source
Page
Library
Module
Module type
Parameter
Class
Class type
Source
Module Dune_release.VcsSource
VCS repositories.
VCS
Version control system repositories
The type for symbols resolving to a commit. The module uses "HEAD" for specifying the current checkout; use this symbol even if the underlying VCS is `Hg.
The type for version control systems repositories.
cmd r is the base VCS command to use to act on r.
Warning Prefer the functions below to remain VCS independent.
get is like find but returns an error if no VCS was found.
Repository state
is_dirty r is Ok true iff the working tree of r has uncommited changes.
Source
val commit_id :
?dirty:bool ->
?commit_ish:commit_ish ->
t ->
(string, Rresult.R.msg) Rresult.resultcommit_id ~dirty ~commit_ish r is the object name (identifier) of commit_ish (defaults to "HEAD"). If commit_ish is "HEAD" and dirty is true (default) and indicator is appended to the identifier if the working tree is dirty.
Source
val commit_ptime_s :
dry_run:bool ->
?commit_ish:commit_ish ->
t ->
(int, Rresult.R.msg) Rresult.resultcommit_ptime_s t ~commit_ish is the POSIX time in seconds of commit commit_ish (defaults to "HEAD") of repository r.
Source
val describe :
?dirty:bool ->
?commit_ish:commit_ish ->
t ->
(string, Rresult.R.msg) Rresult.resultdescribe ~dirty ~commit_ish r identifies commit_ish (defaults to "HEAD") using tags from the repository r. If commit_ish is "HEAD" and dirty is true (default) an indicator is appended to the identifier if the working tree is dirty.
Repository operations
Source
val clone :
dry_run:bool ->
?force:bool ->
?branch:string ->
dir:Fpath.t ->
t ->
(unit, Rresult.R.msg) Rresult.resultclone ~dir r clones r in directory dir.
Source
val checkout :
dry_run:bool ->
?branch:string ->
t ->
commit_ish:commit_ish ->
(unit, Rresult.R.msg) Rresult.resultcheckout r ~branch commit_ish checks out commit_ish. Checks out in a new branch branch if provided.
Source
val tag :
dry_run:bool ->
?force:bool ->
?sign:bool ->
?msg:string ->
?commit_ish:string ->
t ->
string ->
(unit, Rresult.R.msg) Rresult.resulttag r ~force ~sign ~msg ~commit_ish t tags commit_ish with t and message msg (if unspecified the VCS should prompt). if sign is true (defaults to false) signs the tag (`Git repos only). If force is true (default to false) doesn't fail if the tag already exists.
delete_tag r t deletes tag t in repo r.