R spellcheck action

Description

Checks for spelling errors in R packages

Action Type

Composite

Author

Insights Engineering

Inputs

• path:

  Description: Path to package root

  Required: false

  Default: .

• exclude:

  Description: Comma separated list of files or folders to exclude from spellcheck. Accepts globs.

  Required: false

  Default: ""

• additional_options:

  Description: Additional options to pass to Rscript.

  Required: false

  Default: --vanilla

Outputs

None

Usage

Here's an example workflow demonstrating how this action can be used:

---
name: Spellcheck

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main

jobs:
  check:
    runs-on: ubuntu-latest
    name: Spellcheck
    container:
      image: rocker/tidyverse:4.1.2
    steps:
      - name: Checkout repo
        uses: actions/checkout@v3

      - name: Run Spelling Check test
        uses: insightsengineering/r-spellcheck-action@v2

An example of the output of the action can be seen below: