use_ghactions_badge: README badges

In r-lib/ghactions: GitHub actions for R

Description

These helpers produce the markdown text you need in your README to include badges that report information, such as the CRAN version or test coverage, and link out to relevant external resources. To add badges automatically ensure your badge block starts with a line containing only <!-- badges: start --> and ends with a line containing only <!-- badges: end -->.

Usage

use_ghactions_badge(workflow_name = NULL, badge_name = "Actions Status")

Arguments

workflow_name	[character(1)] Giving the name of the workflow as specified in the name: field of your *.yml. If no name: is given, this is the file path of the *.yml from the repository root. Defaults to NULL, in which case the first workflow in the first *.yml at .github/workflows/ is used.
badge_name	Badge name. Used in error message and alt text

See Also

Other setup: edit_workflow(), use_ghactions()

r-lib/ghactions documentation built on Dec. 15, 2020, 4:07 p.m.