Skip to content

Commit

Permalink
Merge pull request #21 from aj3sh/actions-update
Browse files Browse the repository at this point in the history
fix: updated github actions name and readme docs for version info
sugat009 authored Feb 1, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
2 parents 11f7b08 + f81c9b5 commit 269941c
Showing 6 changed files with 17 additions and 9 deletions.
6 changes: 3 additions & 3 deletions .github/SECURITY.md
Original file line number Diff line number Diff line change
@@ -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

2 changes: 1 addition & 1 deletion .github/workflows/test_action.yaml
Original file line number Diff line number Diff line change
@@ -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
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.
5 changes: 4 additions & 1 deletion action.yml
Original file line number Diff line number Diff line change
@@ -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:
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
@@ -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]

0 comments on commit 269941c

Please sign in to comment.