Skip to content

Commit

Permalink
docs(readme): add configuration notes and update example
Browse files Browse the repository at this point in the history
  • Loading branch information
marcocesarato committed Jan 18, 2021
1 parent 9b9f079 commit 10c1f5a
Showing 1 changed file with 12 additions and 5 deletions.
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,24 +54,31 @@ Now you can just run `composer changelog` to generate your changelog.
Create a file named `.changelog` on the root of your project or on the working dir.

> **Note:** If you don't need to customize some settings just omit it from the configuration file
> **Note:** The default excluded types are: `build`, `ci`, `docs`, `refactor`, `revert`, `style`, `test`
Create your configuration settings with the help of the following example.

#### Config Example
```php
<?php
return [
'headerTitle' => 'My changelog',
'headerDescription' => 'This is my changelog file.',
'types' => [
// Add style type
'style' => [
'label' => 'Styles'
// Add improvements type (deprecated type)
'improvements' => [
'label' => 'Improvements',
'description' => 'Improvements to existing features'
],
'chore' => [
// Change chore default label
'label' => 'Others'
],
],
// Exclude refactor type
'excludedTypes' => ['refactor'],
// Exclude not notables types (following types are the default excluded types)
'excludedTypes' => ['docs', 'refactor', 'style', 'build', 'ci', 'revert', 'test'],
// File changelog (relative to the working dir)
'fileName' => 'docs/CHANGELOG.md',
'ignorePatterns' => [
Expand Down

0 comments on commit 10c1f5a

Please sign in to comment.