Add checkout action and problem matcher to README #32
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
peternewman
requested changes
Aug 21, 2021
README.md
Outdated
| @@ -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 | |||
| - uses: codespell-project/codespell-problem-matcher@v1 | |||
There was a problem hiding this comment.
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).
There was a problem hiding this comment.
I had no idea! https://github.com/codespell-project/codespell-problem-matcher lead me to believe that it had to be added.
There was a problem hiding this comment.
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?
peternewman
requested changes
Aug 21, 2021
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Just as a subtle hint for people to find the other ones easier.
Thanks for the nice action!