Skip to content

README.md

Latest commit

 

History

History
59 lines (43 loc) · 1.87 KB

README.md

File metadata and controls

59 lines (43 loc) · 1.87 KB
Raw

DataSHIELD logo

DataSHIELD tests Dashboard

This repository contains scripts to aggregate (source/parse_test_report.R) results from {testthat} and {covr} packages (see the workflow: .github/workflows/dsbase-test-suite.yaml OR .github/workflows/dsbaseclient-test-suite.yaml).

There is a script to render (source/build_site.R) the results committed by the pipeline to the logs/ directory. This script generates a Quarto webpage using the files in site.

To configure additional branches, commits or releases to be tested, please modify the config files inside .github:

Local testing

To render the website locally, run the following command inside the root directory:

system("Rscript source/build_site.R")

Then,

browseURL("docs/index.html")

NOTE: for faster deployment, you might want to edit source/parse_logs.R locally to only parse a subset of the logs. To do so, you can modify the following:

logs_dirs_versions |>
  purrr::map(find_latest_version) |>
  purrr::list_c() |>
  # dplyr::slice(7) |>                  <<<<------ THIS LINE
  .
  .
  .

Flow

The workflow runs the following steps:

Run unit tests & coverage [GHA] >>> Parse results >>> >>> Render Quarto webpage >>> Publish site [GitHub pages]