Download the PHP package tfarla/changelog-parser without Composer
On this page you can find all versions of the php package tfarla/changelog-parser. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download tfarla/changelog-parser
More information about tfarla/changelog-parser
Files in tfarla/changelog-parser
Package changelog-parser
Short Description Extract release information from the changelog
License MIT
Informations about the package changelog-parser
Changelog parser
Requirements
- php 7.1 or greater (supported versions)
Why
A changelog contains information about all the changes in a project. This parsers can be used to extract information about a specific release. That information may then be distributed towards your friends, clients, colleagues and other parties.
Installation
Usage
Given we have the following markdown file:
When we parse that markdown file using the MarkdownParser
:
Then we will receive the following output:
Tested changelog formats can be found under the tests/fixtures
directory.
Running tests
This project uses golden files to assert expected behaviour.
These golden files should be part stored in the git repository and can be generated by setting the GOLDEN
environment variable to 1
:
Contributing
Thanks for reading this far into the README and considering contributing to this project. If you have any questions or suggestions feel free to create an issue.
If you want to modify the code then please follow these steps:
- Fork it (https://github.com/TFarla/changelog-parser)
- Create your feature branch (git checkout -b feature/fooBar)
- Commit your changes (git commit -am 'Add some fooBar')
- Push to the branch (git push origin feature/fooBar)
- Create a new Pull Request