package dune-release

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Publish

dune-release
- Dune_release
  - App_log
  - Archive
  - Check
  - Config
    
    Cli
    
    Draft_pr
    
    Draft_release
    
    Opam_repo_fork
    
    Release_asset_name
    
    S
  - Curl
  - Curl_option
  - Delegate
  - Deprecate
    
    Config_user
    
    Delegates
    
    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
    
    Version
  - 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

Interface with Github.

module Parse : sig ... end

Publish

val publish_distrib : 
  token:string ->
  dry_run:bool ->
  msg:string ->
  archive:Fpath.t ->
  yes:bool ->
  draft:bool ->
  Pkg.t ->
  (string, Bos_setup.R.msg) Result.result

Push the tag, create a Github release, upload the distribution archive and return the release archive download URL

val publish_doc : 
  dry_run:bool ->
  msg:string ->
  docdir:Fpath.t ->
  yes:bool ->
  Pkg.t ->
  (unit, Bos_setup.R.msg) Result.result

val undraft_release : 
  token:string ->
  dry_run:bool ->
  owner:string ->
  repo:string ->
  release_id:string ->
  name:string ->
  (string, Bos_setup.R.msg) Result.result

undraft_release updates an existing release to undraft it and returns the release archive download URL.

val open_pr : 
  token:string ->
  dry_run:bool ->
  title:string ->
  fork_owner:string ->
  branch:Vcs.commit_ish ->
  opam_repo:(string * string) ->
  draft:bool ->
  string ->
  Pkg.t ->
  ([ `Url of string | `Already_exists ], Bos_setup.R.msg) Bos_setup.result

val undraft_pr : 
  token:string ->
  dry_run:bool ->
  opam_repo:(string * string) ->
  pr_id:string ->
  (string, Bos_setup.R.msg) Bos_setup.result

undraft_pr updates an existing pull request to undraft it and returns the pull request URL.