5
0
Fork 0
mirror of https://github.com/wagoid/commitlint-github-action.git synced 2025-11-07 16:06:56 +00:00

docs: update docs to use v5

This commit is contained in:
Wagner Santos 2022-06-18 06:50:00 -03:00 committed by GitHub
parent fd248645f9
commit 7711466212
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -17,7 +17,7 @@ jobs:
- uses: actions/checkout@v3 - uses: actions/checkout@v3
with: with:
fetch-depth: 0 fetch-depth: 0
- uses: wagoid/commitlint-github-action@v4 - uses: wagoid/commitlint-github-action@v5
``` ```
Alternatively, you can run on other event types such as `on: [push]`. In that case the action will lint the push event's commit(s) instead of linting commits from a pull request. You can also combine `push` and `pull_request` together in the same workflow. Alternatively, you can run on other event types such as `on: [push]`. In that case the action will lint the push event's commit(s) instead of linting commits from a pull request. You can also combine `push` and `pull_request` together in the same workflow.
@ -26,7 +26,7 @@ Alternatively, you can run on other event types such as `on: [push]`. In that ca
## Inputs ## Inputs
You can supply these inputs to the `wagoid/commitlint-github-action@v4` step. You can supply these inputs to the `wagoid/commitlint-github-action@v5` step.
### `configFile` ### `configFile`
@ -143,7 +143,7 @@ jobs:
- run: npm install - run: npm install
# Run the commitlint action, considering its own dependencies and yours as well 🚀 # Run the commitlint action, considering its own dependencies and yours as well 🚀
# `github.workspace` is the path to your repository. # `github.workspace` is the path to your repository.
- uses: wagoid/commitlint-github-action@v4 - uses: wagoid/commitlint-github-action@v5
env: env:
NODE_PATH: ${{ github.workspace }}/node_modules NODE_PATH: ${{ github.workspace }}/node_modules
``` ```