boscho87/changelog-checker

Tool to validate the CHANGELOG.md format with the "keep a changelog" instructions

1.3.0 2021-07-10 16:55 UTC

Requires

• symfony/console: ^5.3

Requires (Dev)

• phpunit/phpunit: ^9.5

MIT

• Simon D. Müller

README

Master:

Check if the Changelog has proper format, and if it was updated since the last commit. Some problems can be fixed by the tool if you want (see more in configs)

On Every command it will create a Changelog Backup for you. It will rotate 4 Backlog files.

Follows the Guidelines from Keep A Changelog

This tool should only be used in development environments.

Requirements

• > php7.4
• some checks and actions requires git

Installation

Best practice: Install in a subdirectory to avoid dependency Problems

mkdir --parents tools/changelog-checker
## install in working dir
composer require --working-dir=tools/changelog-checker boscho87/changelog-checker
## ignore backup files
echo  .clc.* >> .gitignore 
echo  tools/changelog-checker/vendor >> .gitignore

Execute the Commands

### With default config (or own config file) if your Changelog name is CHANGELOG.md
/tools/changelog-checker/vendor/bin/changelog-checker clc:validate # uses the Changelog and config file from the dir, the command is executed
### Define the Changelog File
/tools/changelog-checker/vendor/bin/changelog-checker clc:validate -f CHANGELOG.md
### Define the config File
/tools/changelog-checker/vendor/bin/changelog-checker clc:validate -c _clc.php
### Force (overwrite the configs) to not only Check, but to resolve the Problems
/tools/changelog-checker/vendor/bin/changelog-checker clc:validate --with-fix=1
### Force (overwrite the configs) to not Fix the Problems
/tools/changelog-checker/vendor/bin/changelog-checker clc:validate --with-fix=0
### Create a new Release (from the Unreleased Section) - ALPHA FEATURE
/tools/changelog-checker/vendor/bin/changelog-checker release # uses the Changelog and composer.json from the dir, the command is executed
### Set a specific  Changelog.md file
/tools/changelog-checker/vendor/bin/changelog-checker release -f CHANGELOG.md
### Set a specific composer.json file 
/tools/changelog-checker/vendor/bin/changelog-checker release -c composer.json
### Commit the Updated Changelog and create a git tag (requires git)
/tools/changelog-checker/vendor/bin/changelog-checker release commit

Config

Create a file named {project-root}/_clc.php to Overwrite the default configs

Be Aware that some options depends on some kind of Correctness of the Changelog E.g. if there is no [Unreleased] tag, the Increased Checker can not add commit messages underneath it. but the AscendingVersionChecker can resolve this and add an Unreleased Tag, so you should turn fix to true.

<?php
//if you leave something empty, the default will be used
return [
    'ascendingVersion' => [
        'check' => true,
        'error' => true,
        'fix' => false,
    ],
    'versionBrackets' => [
        'check' => true,
        'error' => true,
        'fix' => false,
    ],
    'actions' => [
        'check' => true,
        'error' => true,
        'fix' => false,
    ],
    //has still some bugs
    'increased' => [
        'check' => false,
        'error' => true,
        'fix' => false,
        //commits allowed without a changelog change
        'fail_after' => 1,
    ],
    'sequence' => [
        'check' => true,
        'error' => true,
        'fix' => false,
    ],
    'linkChecker' => [
        'check' => true,
        'error' => true,
        'fix' => false,
    ],
];

Releaser (release command)

• Creates a new Release including the Git Tag

Checkers (validate command)

This Checks are Implemented and can be activated

Default Checkers

• String replacement e.g more than two spaces will be removed with only one
• Fix > yes
• No Options available

Version Brackets

• Are the Version numbers in Brackets? If not > Error
• Fix > yes
• No Options available

Ascending Versioning

• Is the Version Ascending and will never decrease
• Also avoids duplicate Version Numbers
• Fix > no

Type Checker

• Check if the Type String is Valid (Added|Fixed etc.)
• Fix > no

Increased Checker

• Check if the Changelog Changed since the last 4 commits
• Fix Adds Commit messages to the unreleased Section
• creates two files .clc.cheksum and .clc.version
• requires git, runs git log --oneline -n 4 (4 can change)

Link Checker

• Check if the Changelog has Links at the and of the File (Version Brackets are Required for this)
• Fix > (Not Yet Implemented)
• requires git

Roadmap

• Add more Checkers
• Implement more fix methods (where possible)
• Implement tests for all "Checkers"
• Refactor the Checker, after tests are written
• Refactor the CreateRelease Command
• Check Support for alpha/beta etc. Releases and Versions