mirror of
https://github.com/crate-ci/typos.git
synced 2025-01-11 09:11:39 -05:00
docs(action): Show a complete example
This commit is contained in:
parent
679c20bbe3
commit
92d01f198f
1 changed files with 22 additions and 0 deletions
|
@ -3,6 +3,28 @@
|
||||||
If you want an easy way to test your repository spelling (or a subset of files)
|
If you want an easy way to test your repository spelling (or a subset of files)
|
||||||
you can use the Typos Action!
|
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
|
## Input
|
||||||
|
|
||||||
| Name | Description | Required | Default |
|
| Name | Description | Required | Default |
|
||||||
|
|
Loading…
Reference in a new issue