Skip to content
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

docs: update usage information for v1 #45

Merged
merged 1 commit into from
May 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,7 @@ jobs:
- 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
Loading