workflows.md

What 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.

gitleaks.yml

Runs gitleaks on the repo to discover any secrets that might have been hardcoded.

lintr.yml

Runs lintr on the repo with the linting settings specified in the container image.

pkgdown.yml

Generates a pkgdown website and uploads it to Github Pages.

roxygen.yml

Uses roxygen to generate .Rd files in the man/ directory. It also checks if manuals are up-to-date with roxygen comments in the code.

release.yml

Uses adds additional checks before merging the PR to 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

  gitleaks:
    name: Gitleaks 🌧️
    uses: boehringer-ingelheim/dv.templates/.github/workflows/gitleaks.yml@main

  roxygen:
    name: Roxygen 📄
    uses: boehringer-ingelheim/dv.templates/.github/workflows/roxygen.yml@main

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