Skip to content

Commit f91bff8

Browse files
committed
chore: add branding, rename action name
1 parent 8ce9f0e commit f91bff8

File tree

3 files changed

+12
-16
lines changed

3 files changed

+12
-16
lines changed

.github/workflows/check-commit.yml

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
1-
name: Check Commit
1+
name: Check Commit Message
22

3-
on:
4-
pull_request:
5-
push:
6-
branches:
7-
- "*"
3+
on: [pull_request, push]
84

95
jobs:
106
check:

README.md

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
<img alt="GitHub Actions status" src="https://github.com/actions/checkout/workflows/Build%20and%20Test/badge.svg">
44
</a>
55

6-
# Check Commit Syntax
6+
# Check Commit Message
77

8-
Action to check if the commit follows proper syntax as specified [here](http://karma-runner.github.io/latest/dev/git-commit-msg.html)
8+
Action to check if the commit follows proper guidelines as specified [here](http://karma-runner.github.io/latest/dev/git-commit-msg.html)
99

1010
## Usage
1111

@@ -16,13 +16,9 @@ your repository then use this [action](https://github.com/adityaa30/check-commit
1616
Refer to the example below,
1717

1818
```yaml
19-
name: Check Commit
19+
name: Check Commit Message
2020

21-
on:
22-
pull_request:
23-
push:
24-
branches:
25-
- "*"
21+
on: [pull_request, push]
2622

2723
jobs:
2824
check:
@@ -76,5 +72,5 @@ npm run build
7672
- [x] Helper functions to check commit message based on rules
7773
- [x] Add input parameter `compulsory-scope`
7874
- [x] Add input parameter `max-header-length`
79-
- [ ] Provide a **[CLI](https://en.wikipedia.org/wiki/Command-line_interface)**
75+
- [ ] Add a **[CLI](https://en.wikipedia.org/wiki/Command-line_interface)**
8076
- [ ] Add custom **[input parameters](https://help.github.com/en/actions/building-actions/metadata-syntax-for-github-actions#inputs)**

action.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: "Check Commit"
1+
name: "Check Commit Message"
22
description: "Action to check if the commit follows proper syntax"
33

44
inputs:
@@ -19,3 +19,7 @@ inputs:
1919
runs:
2020
using: node12
2121
main: dist/index.js
22+
23+
branding:
24+
icon: 'message-circle'
25+
color: 'green'

0 commit comments

Comments
 (0)