change_log: Scrape change log from a validation project

In phuse-org/valtools: Automate Validated Package Creation

Scrape change log from a validation project

Description

Scrape change log from a validation project

Format change log info table for validation report

Initiate a change_log file

Usage

vt_scrape_change_log()

vt_kable_change_log(change_log_info, format = vt_render_to())

vt_use_change_log(date = NULL, version = NULL, open = interactive())

Arguments

change_log_info	data.frame as exported from vt_scrape_change_log
format	passed to knitr::kable
date	passed to template
version	version to set in news file
open	whether to open the file after

Value

data.frame with variables version, effective_date, description

a knitr_kable object

path to change log file, used for side effect of creating change_log

Note

Extracts validation version, date, and description from change log items that start with [validation].

Examples

withr::with_tempdir({
 file.create(".here")
 vt_use_validation()

 vt_use_change_log()

 log_data <- vt_scrape_change_log()
 print(log_data)

 vt_kable_change_log(log_data)

})

phuse-org/valtools documentation built on Nov. 10, 2024, 1:36 a.m.