Skip to content

Commit

Permalink
Encourage the use of semantic versioning in the README (#58)
Browse files Browse the repository at this point in the history
Follow community practices by recommending semantic versioning so
changes to actions-codespell does not break workflows.

For example, the actions/checkout does the same:
https://github.com/actions/checkout
  • Loading branch information
jdufresne authored Jan 2, 2023
1 parent bcf481f commit 9c63fdd
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Any warnings or errors will be annotated in the Pull Request.
## Usage

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

### Parameter: check_filenames
Expand All @@ -16,7 +16,7 @@ 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
uses: codespell-project/actions-codespell@v1
with:
check_filenames: true
```
Expand All @@ -28,7 +28,7 @@ If set, check hidden files (those starting with ".") for spelling mistakes as we
This parameter is optional; by default `codespell` will not check hidden files.

```
uses: codespell-project/actions-codespell@master
uses: codespell-project/actions-codespell@v1
with:
check_hidden: true
```
Expand All @@ -40,7 +40,7 @@ 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
uses: codespell-project/actions-codespell@v1
with:
exclude_file: src/foo
```
Expand All @@ -52,7 +52,7 @@ 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
uses: codespell-project/actions-codespell@v1
with:
skip: foo,bar
```
Expand All @@ -64,7 +64,7 @@ Comma-separated list of builtin dictionaries to use.
This parameter is optional; by default `codespell` will use its default selection of built in dictionaries.

```
uses: codespell-project/actions-codespell@master
uses: codespell-project/actions-codespell@v1
with:
builtin: clear,rare
```
Expand All @@ -77,7 +77,7 @@ Words are case sensitive based on how they are written in the dictionary file.
This parameter is optional; by default `codespell` will check all words for typos.

```
uses: codespell-project/actions-codespell@master
uses: codespell-project/actions-codespell@v1
with:
ignore_words_file: .codespellignore
```
Expand All @@ -90,7 +90,7 @@ Words are case sensitive based on how they are written in the dictionary file.
This parameter is optional; by default `codespell` will check all words for typos.

```
uses: codespell-project/actions-codespell@master
uses: codespell-project/actions-codespell@v1
with:
ignore_words_list: abandonned,ackward
```
Expand All @@ -104,7 +104,7 @@ If set to "*", all misspelling in URIs and emails will be ignored.
This parameter is optional; by default `codespell` will check all URIs and emails for typos.

```
uses: codespell-project/actions-codespell@master
uses: codespell-project/actions-codespell@v1
with:
uri_ignore_words_list: abandonned
```
Expand All @@ -117,7 +117,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: codespell-project/actions-codespell@master
uses: codespell-project/actions-codespell@v1
with:
path: src
```
Expand All @@ -131,7 +131,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: codespell-project/actions-codespell@master
uses: codespell-project/actions-codespell@v1
with:
only_warn: 1
```

0 comments on commit 9c63fdd

Please sign in to comment.