Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 1, 2024
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/SECURITY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test_action.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
View file
Open in desktop
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.
Expand Down
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
...
```

Expand All @@ -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.
Expand Down
5 changes: 4 additions & 1 deletion action.yml
View file
Open in desktop
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:
Expand Down
2 changes: 1 addition & 1 deletion setup.cfg
View file
Open in desktop
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 = aj3sshh@gmail.com, sugatbajracharya49@gmail.com
Expand Down