Skip to content

Add checkout action and problem matcher to README #32

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add checkout action and problem matcher to README #32

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d57775b
Add checkout action and problem matcher
vadi2 Aug 21, 2021
d4a556e
Update README.md
vadi2 Aug 21, 2021
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
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ Any warnings or errors will be annotated in the Pull Request.
## Usage

```
uses: codespell-project/actions-codespell@master
- uses: actions/checkout@v2
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- uses: actions/checkout@v2
- uses: actions/checkout@v4

- uses: codespell-project/codespell-problem-matcher@v1
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You shouldn't need the matcher @vadi2 , it's built into this action (but provided separately for people who want to do things a bit differently).

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had no idea! https://github.com/codespell-project/codespell-problem-matcher lead me to believe that it had to be added.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please feel free to open a PR if we can improve the wording of that repo so it's clear it's not required with our main action?

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

### Parameter: check_filenames
Expand Down