use_dpkg_badge: Use a markdown badge for a dpkg's latest github release

In dpkg: Create, Stow, and Read Data Packages

Use a markdown badge for a dpkg's latest github release

Description

The badge relies on shields.io for the images, which will always display to the most recently released version and will link to the releases specific to the dpkg name.

Usage

use_dpkg_badge(x)

Arguments

x	a data package (dpkg) object

Details

Note that this relies on the structure of the release created with dpkg_gh_release(), but relies on a dpkg object before it is released. This will lead to broken release badges and links until an initial dpkg release is created with dpkg_gh_release().

Value

character string of markdown

Examples

## Not run: 
as_dpkg(mtcars,
  version = "0.0.0.9000", 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"
    )
) |>
  use_dpkg_badge()

## End(Not run)

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