Skip to content

Commit

Permalink
refactor!: use conventional commit types by default
Browse files Browse the repository at this point in the history
Signed-off-by: Ardalan Amini <[email protected]>
  • Loading branch information
ardalanamini committed Apr 29, 2023
1 parent 06b776e commit 7db6dea
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 27 deletions.
32 changes: 14 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,23 +67,22 @@ ${{ github.token }}

Commit types.

> The default value is based on the [Conventional Commits Specification](https://www.conventionalcommits.org/en/v1.0.0)
_Default:_

```yaml
breaking: Breaking Changes
feat: New Features
fix: Bug Fixes
revert: Reverts
build: Build System & Dependencies
perf: Performance Improvements
refactor: Refactors
deps: Dependencies
docs: Documentation Changes
style: Code Style Changes
build: Build System
ci: Continuous Integration
docs: Documentation
test: Tests
refactor: Refactors
chore: Chores
other: Other Changes
ci: CI
style: Code Style
revert: Reverts
```
#### `default-commit-type`
Expand Down Expand Up @@ -243,20 +242,17 @@ Using with custom inputs:
with:
github-token: ${{ github.token }}
commit-types: |
breaking: Breaking Changes
feat: New Features
fix: Bug Fixes
revert: Reverts
build: Build System & Dependencies
perf: Performance Improvements
refactor: Refactors
deps: Dependencies
docs: Documentation Changes
style: Code Style Changes
build: Build System
ci: Continuous Integration
docs: Documentation
test: Tests
refactor: Refactors
chore: Chores
other: Other Changes
ci: CI
style: Code Style
revert: Reverts
default-commit-type: Other Changes
release-name: v1.0.0
mention-authors: true
Expand Down
15 changes: 6 additions & 9 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,20 +19,17 @@ inputs:
description: Commit types
required: true
default: |
breaking: Breaking Changes
feat: New Features
fix: Bug Fixes
revert: Reverts
build: Build System & Dependencies
perf: Performance Improvements
refactor: Refactors
deps: Dependencies
docs: Documentation Changes
style: Code Style Changes
build: Build System
ci: Continuous Integration
docs: Documentation
test: Tests
refactor: Refactors
chore: Chores
other: Other Changes
ci: CI
style: Code Style
revert: Reverts
default-commit-type:
description: Default commit type to be used when the commit message matches none of the defined types
Expand Down

0 comments on commit 7db6dea

Please sign in to comment.