https://github.com/insightsengineering/r-spellcheck-action
Github Action that performs a spell check on an R package
https://github.com/insightsengineering/r-spellcheck-action
github-actions r spellcheck
Last synced: about 1 year ago
JSON representation
Github Action that performs a spell check on an R package
- Host: GitHub
- URL: https://github.com/insightsengineering/r-spellcheck-action
- Owner: insightsengineering
- License: apache-2.0
- Created: 2021-10-26T12:58:36.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-03-15T16:01:29.000Z (about 2 years ago)
- Last Synced: 2025-03-26T12:51:14.026Z (about 1 year ago)
- Topics: github-actions, r, spellcheck
- Language: R
- Homepage: https://github.com/marketplace/actions/r-spellcheck-action
- Size: 47.9 KB
- Stars: 5
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# 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:
```yml
---
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:
