make_release_notes: Build the Release Notes document and write it to output...

View source: R/make-release-notes.R

make_release_notesR Documentation

Build the Release Notes document and write it to output file(s)

Description

Build the Release Notes document and write it to output file(s)

Usage

make_release_notes(
  product_name,
  version,
  repo_url = NULL,
  release_notes = NULL,
  style_dir = NULL,
  out_file = RLS_NOTES_FILE,
  output_dir = getwd(),
  type = "package",
  word_document = TRUE
)

Arguments

product_name

The name of the product you are validating, to be included in the output document.

version

The version number of the product you are validating, to be included in the output document.

repo_url

Character string denoting the url of repository.

release_notes

list of release notes, formatted for rmarkdown.

style_dir

Directory to check for a docx style reference that has the same base name as out_file.

out_file

Filename to write markdown file out to. Any extension will be ignored and replaced with .Rmd

output_dir

Directory to write the output documents to. Defaults to working directory.

type

the type of doc you want to render ("package" or "metworx")

word_document

Logical scaler indicating whether to render a docx document


metrumresearchgroup/mrgvalidate documentation built on March 4, 2023, 7:54 a.m.