Skip to content

Commit

Permalink
docs: update usage information for v1
Browse files Browse the repository at this point in the history
Release-As: 1.0.0
  • Loading branch information
aj3sh committed May 24, 2024
1 parent 8503ef5 commit c84aba8
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 15 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,8 @@ jobs:
runs-on: ubuntu-latest
name: Commitlint
steps:
- uses: actions/checkout@v4

- name: Run commitlint
uses: ./ # Uses an action in the root directory
# or use a released GitHub Action
# uses: opensource-nepal/commitlint@v0.2.1
# uses: opensource-nepal/commitlint@v1
uses: ./
with:
verbose: true
17 changes: 7 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,12 @@ For more details, please refer to the Conventional Commits specification at http

```yaml
repos:
...

- repo: https://github.com/opensource-nepal/commitlint
rev: v0.2.1
hooks:
- id: commitlint
...

- repo: https://github.com/opensource-nepal/commitlint
rev: v1
hooks:
- id: commitlint
...
```

Expand All @@ -70,7 +69,7 @@ If you have any existing workflows, add the following steps:
steps:
...
- name: Run commitlint
uses: opensource-nepal/commitlint@v0.2.1
uses: opensource-nepal/commitlint@v1
...
```

Expand All @@ -89,10 +88,8 @@ jobs:
runs-on: ubuntu-latest
name: Commitlint
steps:
- uses: actions/checkout@v4
- name: Run commitlint
uses: opensource-nepal/commitlint@v0.2.1
uses: opensource-nepal/commitlint@v1
```

> **_NOTE:_** commitlint GitHub Actions will only be triggered by "push" or "pull_request" events.
Expand Down

0 comments on commit c84aba8

Please sign in to comment.