From 03d7b5ba370532f39b42ae9f2148f7ed08cbb826 Mon Sep 17 00:00:00 2001 From: Ajesh Sen Thapa Date: Fri, 24 May 2024 18:12:10 +0545 Subject: [PATCH] docs: update usage information for v1 Release-As: 1.0.0 --- .../{test_action.yaml => commitlint.yaml} | 5 ++--- README.md | 17 +++++++---------- 2 files changed, 9 insertions(+), 13 deletions(-) rename .github/workflows/{test_action.yaml => commitlint.yaml} (62%) diff --git a/.github/workflows/test_action.yaml b/.github/workflows/commitlint.yaml similarity index 62% rename from .github/workflows/test_action.yaml rename to .github/workflows/commitlint.yaml index f4ce9ca..29964d0 100644 --- a/.github/workflows/test_action.yaml +++ b/.github/workflows/commitlint.yaml @@ -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 diff --git a/README.md b/README.md index 95d414d..ff166b2 100644 --- a/README.md +++ b/README.md @@ -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 ... ``` @@ -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 ... ``` @@ -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.