config.md

Configuration

For customize settings you just needs to create a file named .changelog on the root of your project/ on the working dir or use the --config option to specify the location of your configuration file.

Notes:

• When a setting on the configuration file is not necessary just omit it
• To allow all types just keep empty types and set empty ignoreTypes

Settings

• Root: Working directory of your project
• Path: Path to your changelog file (relative to the working dir/root)
• Header Title: Header title of the changelog
• Header Description: Header subtitle of the changelog
• Sort By: Sort changes by commit metadata (date, subject, authorName, authorEmail, authorDate, committerName, committerEmail, committerDate)
• Preset: Add new types preset or modify existing types preset labels and description
• Types: Types allowed and showed on changelog. This setting could overwrite ignored types.
• Package Bump: Bump the package version in composer.json or package.json if files exists on the root path
• Package Lock Commit: Commit the package lock file (ex. composer.lock, package.lock, yarn.lock...)
• Ignore Types: Types ignored and so hidden on changelog
• Ignore Patterns: Patterns ignored and so hidden on changelog with a specific description. (Regex are enabled)
• Tag Prefix: Add prefix to release tag
• Tag Suffix: Add suffix to release tag
• Skip Bump: Skip automatic version code bump
• Package Bumps: Array of files to replace version, defaults to ['ConventionalChangelog\PackageBump\ComposerJson', 'ConventionalChangelog\PackageBump\PackageJson']
• Skip Tag: Skip automatic commit tagging
• Skip Verify: Skip the pre-commit and commit-msg hooks
• Disable Links: Render text instead of link in changelog
• 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)
• Date Format: The format of the outputted date string
• Changelog Version Format: Allows the version header in changelog to have a configurable format
• Commit Url Format: A URL representing a specific commit at a hash
• Compare Url Format: A URL representing the comparison between two git sha
• Issue Url Format: A URL representing the issue format (allowing a different URL format to be swapped in for Gitlab, Bitbucket, etc)
• User Url Format: A URL representing the a user's profile URL on GitHub, Gitlab, etc. This URL is used for substituting @abc with https://github.com/abc in commit messages
• Hidden Version Separator: Hide version separator
• Release Commit Message Format: A string to be used to format the auto-generated release commit message
• Pre Run: Run a callback or command before run the script
• Post Run: Run a callback or command after run the script
• Merged: Only include commits whose tips are reachable from HEAD

Default settings

These are the default settings:

<?php

return [
  'root' => getcwd(),
  'path' => 'CHANGELOG.md',
  'headerTitle' => 'Changelog',
  'headerDescription' => 'All notable changes to this project will be documented in this file.',
  'sortBy' => 'subject',
  'preset' => [
    // Breaking changes section
    'breaking_changes' => ['label' => '⚠ BREAKING CHANGES', 'description' => 'Code changes that potentially causes other components to fail'],
    // Types section
    'feat'     => ['label' => 'Features', 'description' => 'New features'],
    'perf'     => ['label' => 'Performance Improvements', 'description' => 'Code changes that improves performance'],
    'fix'      => ['label' => 'Bug Fixes', 'description' => 'Bugs and issues resolution'],
    'refactor' => ['label' => 'Code Refactoring', 'description' => 'A code change that neither fixes a bug nor adds a feature'],
    'style'    => ['label' => 'Styles', 'description' => 'Changes that do not affect the meaning of the code'],
    'test'     => ['label' => 'Tests', 'description' => 'Adding missing tests or correcting existing tests'],
    'build'    => ['label' => 'Builds', 'description' => 'Changes that affect the build system or external dependencies '],
    'ci'       => ['label' => 'Continuous Integrations', 'description' => 'Changes to CI configuration files and scripts'],
    'docs'     => ['label' => 'Documentation', 'description' => 'Documentation changes'],
    'chore'    => ['label' => 'Chores', 'description' => "Other changes that don't modify the source code or test files"],
    'revert'   => ['label' => 'Reverts', 'description' => 'Reverts a previous commit'],
  ],
  'types' => [],
  'packageBump' => true,
  'packageBumps' => [],
  'packageLockCommit' => true,
  'ignoreTypes' => ['build', 'chore', 'ci', 'docs', 'perf', 'refactor', 'revert', 'style', 'test'],
  'ignorePatterns' => ['/^chore\(release\):/i'],
  'tagPrefix' => 'v',
  'tagSuffix' => '',
  'skipBump' => false,
  'skipTag' => false,
  'skipVerify' => false,
  'disableLinks' => false,
  'hiddenHash' => false,
  'hiddenMentions' => false,
  'hiddenReferences' => false,
  'prettyScope' => true,
  'urlProtocol' => 'https',
  'dateFormat' => 'Y-m-d',
  'changelogVersionFormat' => '## {{version}} ({{date}})',
  'commitUrlFormat' => '{{host}}/{{owner}}/{{repository}}/commit/{{hash}}',
  'compareUrlFormat' => '{{host}}/{{owner}}/{{repository}}/compare/{{previousTag}}...{{currentTag}}',
  'issueUrlFormat' => '{{host}}/{{owner}}/{{repository}}/issues/{{id}}',
  'userUrlFormat' => '{{host}}/{{user}}',
  'releaseCommitMessageFormat' => 'chore(release): {{currentTag}}',
  'hiddenVersionSeparator' => false,
  'preRun' => null,
  'postRun' => null,
  'merged' => false,
];

Examples

Configure your preferences with the help of the following examples.

Short Example

<?php

return [
    // Types allowed on changelog
    'types' => ['feat', 'fix', 'perf', 'docs', 'chore'],
    // Ignore chores with changelogs scope
    'ignorePatterns' => [
        '/chore\(changelog\)[:].*/i'
    ],
];

Full Example

<?php

return [
  'root' => dirname(__DIR__), // (ex. configs/changelog.php using --config option)
  // File changelog (relative to the working dir/root)
  'path' => 'docs/CHANGELOG.md', // You can specify a different folder
  'headerTitle' => 'My changelog',
  'headerDescription' => 'This is my changelog file.',
  'preset' => [
    // Add improvements type (deprecated type)
    'improvements' => [
      'label' => 'Improvements',
      'description' => 'Improvements to existing features'
    ],
    'chore' => [
      // Change chore default label
      'label' => 'Others'
    ],
  ],
   // Types allowed on changelog
  'types' => ['feat', 'fix', 'pref'], // These could overwrite ignored types
  // Exclude not notables types (following types are the default excluded types)
  'ignoreTypes' => ['build', 'chore', 'ci', 'docs', 'refactor', 'revert', 'style', 'test'],
  'ignorePatterns' => [
    // Exclude all commits with this specific description
    'chore(deps): update dependencies',
    // You can also use regex to exclude all commit like 'chore(changelog): updated'
    '/chore\(changelog\)[:].*/i'
  ],
  'tagPrefix' => 'ver',
  'tagSuffix' => '',
  'skipBump' => false,
  'skipTag' => false,
  'skipVerify' => true,
];