Skip to content

Commit

Permalink
feat: changed bot commit msg to conventional commits format
Browse files Browse the repository at this point in the history
To clarify the purpose of the commit.
see: https://www.conventionalcommits.org/en/v1.0.0/
  • Loading branch information
shufo authored Jul 21, 2022
1 parent 1141e7a commit 1520e4a
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,10 +137,10 @@ You can add these optional parameters in your action script to modify the appear
| use_username | false | To use username instead of full name | false |
| columns_per_row | 6 | Number of columns in a row | false |
| collaborators | direct | Type of collaborators options: all/direct/outside | false |
| commit_message | contrib-readme-action has updated readme | Commit message of the github action | false |
| commit_message | docs(contributor): contrib-readme-action has updated readme | Commit message of the github action | false |
| committer_username | "" | Username on commit | false |
| committer_email | "" | Email id of committer | false |
| pr_title_on_protected | contributors readme action update | Title of the PR that will be created if the branch is protected | false |
| pr_title_on_protected | docs(contributor): contributors readme action update | Title of the PR that will be created if the branch is protected | false |
| auto_detect_branch_protection | true | To override auto protected branch detection | false |

> committer_username and committer_email both must be provided to use as a replacement to GH action committer
Expand Down
4 changes: 2 additions & 2 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ inputs:
default: "direct"
commit_message:
description: "Commit message of the github action"
default: "contrib-readme-action has updated readme"
default: "docs(contributor): contrib-readme-action has updated readme"
required: false
committer_username:
description: "Username on commit"
Expand All @@ -37,7 +37,7 @@ inputs:
required: false
pr_title_on_protected:
description: "Title of the PR that will be created if the branch is protected"
default: "contributors readme action update"
default: "docs(contributor): contributors readme action update"
required: false
outputs:
pr_id: # id of pr
Expand Down

0 comments on commit 1520e4a

Please sign in to comment.