Download the PHP package boscho87/changelog-checker without Composer
On this page you can find all versions of the php package boscho87/changelog-checker. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download boscho87/changelog-checker
More information about boscho87/changelog-checker
Files in boscho87/changelog-checker
Package changelog-checker
Short Description Tool to validate the CHANGELOG.md format with the "keep a changelog" instructions
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package changelog-checker
Changelog Checker © Boscho87
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
Execute the Commands
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.
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.cheksumand.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
