Check-package.yaml

# This is the primary workflow for checking the state of the package
# It will run unittest (incl.) codecov and R CMD checks - furthermore it will check for problematic dependencies and key leakage.


on:
  push:
    branches: [main, stage, dev]
  pull_request:
    branches: [main, stage, dev]
  workflow_dispatch:
  workflow_call:

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

name: Check Package 📦

jobs:
  # Runs dependency scan powered by oysteR - checks for known security vulnerabilities
  audit:
    name: Audit Dependencies 🕵️‍♂️
    uses: insightsengineering/r.pkg.template/.github/workflows/audit.yaml@main

  # Generates a license report of package dependencies
  licenses:
    name: License Check 🃏
    uses: insightsengineering/r.pkg.template/.github/workflows/licenses.yaml@main

  # # Runs R CMD check using the local R-CMD-check.yaml workflow
  # check:
  #   name: RMD check 📦
  #   uses: ./.github/workflows/R-CMD-check.yaml

  # Runs R CMD check with specific version(s) of R and cran-snapshot
  check-versions:
    name: RMD check versions 📜
    uses: ./.github/workflows/R-CMD-check-versions.yaml

  # Runs unittests while capturing code:cov and uploads to Codecov io. See local subflow
  test:
    name: Test 🧪
    uses: ./.github/workflows/Test.yaml

  # Checks for git keys etc.
  gitleaks:
    name: gitleaks 💧
    uses: insightsengineering/r.pkg.template/.github/workflows/gitleaks.yaml@main
    with:
      check-for-pii: false #Currently fails on R packages (not that the test check fails, but that the test fails to run.)