-
Notifications
You must be signed in to change notification settings - Fork 21
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.
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
base: master
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just one comment
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.
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).
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Having the usage example be valid action YAML certainly makes sense, would you mind making all the examples match though please throughout the doc?
@@ -6,7 +6,8 @@ Any warnings or errors will be annotated in the Pull Request. | |||
## Usage | |||
|
|||
``` | |||
uses: codespell-project/actions-codespell@master | |||
- uses: actions/checkout@v2 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- uses: actions/checkout@v2 | |
- uses: actions/checkout@v4 |
Just as a subtle hint for people to find the other ones easier.
Thanks for the nice action!