Skip to content

Commit

Permalink
docs(config): add pretty scope config
Browse files Browse the repository at this point in the history
  • Loading branch information
marcocesarato committed Feb 12, 2021
1 parent f47356f commit 7fcca82
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ dir or use the `--config` option to specify the location of your configuration f
- **Hidden Hash:** Hide commit hash from changelog
- **Hidden Mentions:** Hide users mentions from changelog
- **Hidden References:** Hide issue references from changelog
- **Pretty Scope:** Prettify the scope commit part (section name) on changelog *(ex. UserManager => User Manager or
user_config => User config)*
- **Url Protocol:** The URL protocol of all repository urls on changelogs (http/https)
- **Commit Url Format:** A URL representing a specific commit at a hash
- **Compare Url Format:** A URL representing the comparison between two git sha
Expand Down Expand Up @@ -73,6 +75,7 @@ return [
'hiddenHash' => false,
'hiddenMentions' => false,
'hiddenReferences' => false,
'prettyScope' => true,
'urlProtocol' => 'https',
'commitUrlFormat' => '{{host}}/{{owner}}/{{repository}}/commit/{{hash}}',
'compareUrlFormat' => '{{host}}/{{owner}}/{{repository}}/compare/{{previousTag}}...{{currentTag}}',
Expand Down

0 comments on commit 7fcca82

Please sign in to comment.