dpkg_gh_release: Use a dpkg to create a github release

In dpkg: Create, Stow, and Read Data Packages

Use a dpkg to create a github release

Description

A GitHub release will be created based on the current commit, tagged and named according to the name and version of the dpkg. The dpkg description is used for the release body.

Usage

dpkg_gh_release(x, draft = TRUE)

Arguments

x	a data package (dpkg) object
draft	logical; mark release as draft?

Details

The GITHUB_PAT environment variable must be set and the working directory must be inside of a git repository with a GitHub remote.

The GitHub release will not be set to the latest release in order to prevent problems with other automated actions that rely on the latest release, like R universe or remotes "*release" syntax or other GitHub actions.

Release tags are required to be unique, so this will fail if a release with the same name and version already exists.

Value

the URL to the release (invisibly)

Examples

## Not run: 
dpkg_gh_release(
  as_dpkg(mtcars,
    version = "0.0.0.9001", title = "Foofy Cars",
    homepage = "https://github.com/cole-brokamp/dpkg",
    description =
      paste("# Foofy Cars\n",
        "This is a test for the [dpkg](https://github.com/cole-brokamp/dpkg) package.",
        collapse = "\n"
      )
  ),
  draft = FALSE
)

## End(Not run)
#> created release at: https://github.com/cole-brokamp/dpkg/releases/tag/mtcars-v0.0.0.9001

dpkg documentation built on April 4, 2025, 12:30 a.m.