R Package Validation Report Workflow
This GitHub Actions workflow generates a validation report for an R package. The report is triggered by manual dispatch, workflow call, or the publication of a release. It’s mainly using the validatoR downstream action.
Workflow Structure
The workflow consists of a single job:
r-pkg-validation
.
r-pkg-validation
Job
This job generates a validation report for a specified version of R.
The report is built using thevalidatoR
action and uploaded
to the release upon success. The PDF report is then attached to the
release within GitHub.
Steps
- Get branch names: Extracts branch names.
- Checkout repo: Checks out the repository based on the event type (push or pull request).
- Normalize inputs: Normalizes the input R version, defaulting to ‘4.1’ if not specified.
- Restore cache: Restores cached dependencies.
- Run Staged dependencies: Executes staged dependencies action.
- Install dependencies from DESCRIPTION: install dependencies from DESCRIPTION (in case of missing dependencies in parent admiralci docker image)
-
Build report: Uses
thevalidatoR
action to build the validation report. - Upload report to release: Uploads the validation report to the release if the job is successful.