From f81c9b5c68962e412234e910879b507788a9f3d7 Mon Sep 17 00:00:00 2001 From: Ajesh Sen Thapa Date: Thu, 1 Feb 2024 12:33:14 +0545 Subject: [PATCH] fix: updated github actions name and readme docs for version info --- .github/SECURITY.md | 6 +++--- .github/workflows/test_action.yaml | 2 +- CHANGELOG.md | 5 +++++ README.md | 6 +++--- action.yml | 5 ++++- setup.cfg | 2 +- 6 files changed, 17 insertions(+), 9 deletions(-) diff --git a/.github/SECURITY.md b/.github/SECURITY.md index c659946..e9a4296 100644 --- a/.github/SECURITY.md +++ b/.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 diff --git a/.github/workflows/test_action.yaml b/.github/workflows/test_action.yaml index ecc3d55..f05ec9a 100644 --- a/.github/workflows/test_action.yaml +++ b/.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 diff --git a/CHANGELOG.md b/CHANGELOG.md index af5cab4..01ad5ee 100644 --- a/CHANGELOG.md +++ b/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. diff --git a/README.md b/README.md index 6ef379b..4b74a4d 100644 --- a/README.md +++ b/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. diff --git a/action.yml b/action.yml index 8b641bf..693c167 100644 --- a/action.yml +++ b/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: diff --git a/setup.cfg b/setup.cfg index f33379e..27cb72c 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,6 +1,6 @@ [metadata] name = commitlint -version = 0.2.0 +version = 0.2.1 license = MIT author = opensource-nepal author_email = aj3sshh@gmail.com, sugatbajracharya49@gmail.com