Merge pull request #21 from aj3sh/actions-update

fix: updated github actions name and readme docs for version info

Author: sugat009

.github/SECURITY.md

@@ -6,9 +6,9 @@ The 'commitlint' project is committed to maintaining the security and integrity
 
 We provide security updates and support for the latest stable release of the 'commitlint' package. It is important to keep your software up to date to ensure you have the latest security patches.
 
-| Version | Supported          |
-| ------- | ------------------ |
-| 0.2.0   | :white_check_mark: |
+| Version  | Supported          |
+| -------- | ------------------ |
+| >= 0.2.0 | :white_check_mark: |
 
 ## Reporting a Vulnerability
 

.github/workflows/test_action.yaml

@@ -15,4 +15,4 @@ jobs:
       - name: Run commitlint
         uses: ./ # Uses an action in the root directory
         # or use a released GitHub Action
-        # uses: opensource-nepal/commitlint@0.2.0
+        # uses: opensource-nepal/commitlint@v0.2.1

CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## 0.2.1
+
+- Update Github actions name.
+- Updated documentations for Github actions and pre-commit hook.
+
 ## 0.2.0
 
 - Created commitlint CLI.

README.md

@@ -19,7 +19,7 @@ commitlint is a tool designed to lint your commit messages according to the [Con
    ...
 
    - repo: https://github.com/opensource-nepal/commitlint
-       rev: 0.2.0
+       rev: v0.2.1
        hooks:
        - id: commitlint
 
@@ -42,7 +42,7 @@ If you have any existing workflows, add the following steps:
 steps:
     ...
     - name: Run commitlint
-    uses: opensource-nepal/commitlint@0.2.0
+    uses: opensource-nepal/commitlint@v0.2.1
     ...
 ```
 
@@ -64,7 +64,7 @@ jobs:
       - uses: actions/checkout@v4
 
       - name: Run commitlint
-        uses: opensource-nepal/commitlint@0.2.0
+        uses: opensource-nepal/commitlint@v0.2.1
 ```
 
 > **_NOTE:_** commitlint GitHub Actions will only be triggered by "push" or "pull_request" events.

action.yml

@@ -1,5 +1,8 @@
-name: "commitlint"
+name: "Conventional Commitlint"
 description: "A GitHub Action to check conventional commit message"
+branding:
+  color: "red"
+  icon: "git-commit"
 runs:
   using: "composite"
   steps:

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = commitlint
-version = 0.2.0
+version = 0.2.1
 license = MIT
 author = opensource-nepal
 author_email = [email protected], [email protected]