Skip to content

Commit 9cc4f77

Browse files
committed
docs: Add note about checkout action
1 parent 5925ba7 commit 9cc4f77

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,15 @@ Github action is available to use with your CI pipelines and most arguments from
4141
convcommitlint:
4242
runs-on: ubuntu-latest
4343
steps:
44+
- uses: actions/checkout@v4
4445
- uses: coolapso/convcommitlint@v0
4546
```
4647

4748
You can find the available inputs in the [action.yaml](action.yaml) file, if a input is not available you still should be able to use it by setting the associated ENV variable.
4849

50+
> [!IMPORTANT]
51+
> Be sure to include the Checkout in your workflow, this action won't do it for you!
52+
4953
### Docker
5054

5155
You can run convcommitlint with docker, containers are provided both on dockerhub and ghcr.io

0 commit comments

Comments
 (0)