Functions to query and manipulate GitHub releases. These functions are +currently experimental.
+Details
+ +List releases
+ + + + + + + + + + +Get information about a release
+ +Description
+ + +ghr$get()
downloads information about a release, including
+release assets.
ghr$async_get
is the async version of ghr$get
.
Value
+ + +Named list, see +https://docs.github.com/en/rest/releases/releases#get-a-release +for the entries.
+List assets of a release
+ + + + + + + + + + +Add a release asset
+ +Description
+ + +ghr$add_asset()
adds an asset to a GitHub release.
ghr$async_add_asset()
is the async version of ghr$add_asset()
.
Arguments
+ +repo
: repository slug, e.g.cran/cli
.
+file
: path to file to upload as an asset.
+tag
: tag name to add the asset to. It must exist on GitHub.
+name
: file name of the asset in the release.
+
Value
+ + +Response from GitHub as a named list. See +https://docs.github.com/en/rest/releases/assets#upload-a-release-asset +for the structure.
+Delete a release asset
+ +Description
+ + +ghr$delete_asset()
deleted a release asset.
ghr$async_delete_asset()
is an async version of ghr$delete_asset()
.
Create a GitHub release
+ +Description
+ + +ghr$create()
creates a GitHub release from a tag.
ghr$async_create()
is an async version of ghr$create()
.
Arguments
+ +repo
: repository slug, e.g.cran/cli
.
+tag
: tag name to create a release for. It must exist on GitHub.
+description
: release description.
+draft
: whether to create a draft release.
+prerelease
: whether to create a prerelease.
+generate_release_notes
: whether to auto-generate release notes.
+
Value
+ + +Response from GitHub as a named list. See +https://docs.github.com/en/rest/releases/releases#create-a-release +for the structure.
+