Skip to content

Commit c84aba8

Browse files
committed
docs: update usage information for v1
Release-As: 1.0.0
1 parent 8503ef5 commit c84aba8

File tree

2 files changed

+9
-15
lines changed

2 files changed

+9
-15
lines changed

Diff for: .github/workflows/test_action.yaml renamed to .github/workflows/commitlint.yaml

+2-5
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,8 @@ jobs:
1010
runs-on: ubuntu-latest
1111
name: Commitlint
1212
steps:
13-
- uses: actions/checkout@v4
14-
1513
- name: Run commitlint
16-
uses: ./ # Uses an action in the root directory
17-
# or use a released GitHub Action
18-
# uses: opensource-nepal/[email protected]
14+
# uses: opensource-nepal/commitlint@v1
15+
uses: ./
1916
with:
2017
verbose: true

Diff for: README.md

+7-10
Original file line numberDiff line numberDiff line change
@@ -43,13 +43,12 @@ For more details, please refer to the Conventional Commits specification at http
4343

4444
```yaml
4545
repos:
46-
...
47-
48-
- repo: https://github.com/opensource-nepal/commitlint
49-
rev: v0.2.1
50-
hooks:
51-
- id: commitlint
46+
...
5247

48+
- repo: https://github.com/opensource-nepal/commitlint
49+
rev: v1
50+
hooks:
51+
- id: commitlint
5352
...
5453
```
5554

@@ -70,7 +69,7 @@ If you have any existing workflows, add the following steps:
7069
steps:
7170
...
7271
- name: Run commitlint
73-
uses: opensource-nepal/commitlint@v0.2.1
72+
uses: opensource-nepal/commitlint@v1
7473
...
7574
```
7675

@@ -89,10 +88,8 @@ jobs:
8988
runs-on: ubuntu-latest
9089
name: Commitlint
9190
steps:
92-
- uses: actions/checkout@v4
93-
9491
- name: Run commitlint
95-
uses: opensource-nepal/commitlint@v0.2.1
92+
uses: opensource-nepal/commitlint@v1
9693
```
9794
9895
> **_NOTE:_** commitlint GitHub Actions will only be triggered by "push" or "pull_request" events.

0 commit comments

Comments
 (0)