Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the docs #11

Merged
merged 4 commits into from
Jun 10, 2020
Merged

Update the docs #11

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2eff893
Update the docs with the correct repo
peternewman Jun 5, 2020
31e217a
Document some more parameters
peternewman Jun 6, 2020
ba475bf
Clarify the exclude_file input option behaviour
peternewman Jun 6, 2020
05ab9ab
Merge branch 'master' into peternewman-docs
peternewman Jun 9, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 51 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,55 @@ Any warnings or errors will be annotated in the Pull Request.
## Usage

```
uses: peternewman/actions-codespell@master
uses: codespell-project/actions-codespell@master
```

### Parameter: check_filenames

If set, check file names for spelling mistakes as well.

This parameter is optional; by default `codespell` will only check the file contents.

```
uses: codespell-project/actions-codespell@master
with:
check_filenames: true
```

### Parameter: check_hidden

If set, check hidden files (those starting with ".") for spelling mistakes as well.

This parameter is optional; by default `codespell` will not check hidden files.

```
uses: codespell-project/actions-codespell@master
with:
check_hidden: true
```

### Parameter: exclude_file

File with lines that should not be checked for spelling mistakes.

This parameter is optional; by default `codespell` will check all lines.

```
uses: codespell-project/actions-codespell@master
with:
exclude_file: src/foo
```

### Parameter: skip

Comma-separated list of files to skip (it accepts globs as well).

This parameter is optional; by default `codespell` won't skip any files.

```
uses: codespell-project/actions-codespell@master
with:
skip: foo,bar
```

### Parameter: path
Expand All @@ -17,7 +65,7 @@ This can be useful if your project has code you don't want to spell check for so
This parameter is optional; by default `codespell` will run on your whole repository.

```
uses: peternewman/actions-codespell@master
uses: codespell-project/actions-codespell@master
with:
path: src
```
Expand All @@ -31,7 +79,7 @@ All errors and warnings are annotated in Pull Requests, but it will act like eve
This parameter is optional; setting this to any value will enable it.

```
uses: peternewman/actions-codespell@master
uses: codespell-project/actions-codespell@master
with:
only_warn: 1
```
2 changes: 1 addition & 1 deletion action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ inputs:
requred: false
default: ''
exclude_file:
description: 'FILE with lines that should not be changed'
description: 'File with lines that should not be checked for spelling mistakes'
requred: false
default: ''
skip:
Expand Down