workflows.md

What do these workflows do?

check.yml

Runs devtools::check() and devtools::test() on the R package inside the checked out repository.

test.yml

Runs tests on the installed package, generates the qc documentation and uploads it as an artifact for later consumption.

lintr.yml

Runs lintr on the repo with the linting settings specified in the container image, except when overriden by a repository-specific .lintr.R configuration file.

pkgdown.yml

Generates man/*.Rd documentation through roxygen. Renders a pkgdown website and uploads it to Github Pages.

release.yml

Checks that version numbers in NEWS.md and DESCRIPTION match. Checks that version numbers don't have a fourth component (major.minor.patch.dev) on PRs targeting main.

shared_ci.yml

Builds a reusable workflow to be called from other repositories.

Example configuration for main branch:

---
name: Checks 🧩

on:
  pull_request:
    types:
      - opened
      - synchronize
      - reopened
      - ready_for_review
    branches:
      - main
  push:
    branches:
      - main
  workflow_dispatch:

jobs:
  check-test:
    name: Check 📦
    uses: boehringer-ingelheim/dv.templates/.github/workflows/check.yml@main

  lintr:
    name: Lintr 🔍
    uses: boehringer-ingelheim/dv.templates/.github/workflows/lintr.yml@main
    with:
      lintr_error_on_lint: true

  pkgdown:
    name: Pkgdown 📖
    uses: boehringer-ingelheim/dv.templates/.github/workflows/pkgdown.yml@main