docs(action): Show a complete example

This commit is contained in:
Ed Page 2024-12-30 08:25:17 -06:00
parent 679c20bbe3
commit 92d01f198f

View file

@ -3,6 +3,28 @@
If you want an easy way to test your repository spelling (or a subset of files)
you can use the Typos Action!
```yaml
name: Spelling
permissions:
contents: read
on: [pull_request]
env:
CLICOLOR: 1
jobs:
spelling:
name: Spell Check with Typos
runs-on: ubuntu-latest
steps:
- name: Checkout Actions Repository
uses: actions/checkout@v4
- name: Spell Check Repo
uses: crate-ci/typos@v1.28.4
```
## Input
| Name | Description | Required | Default |