Download the PHP package ricardosierra/changelog without Composer
On this page you can find all versions of the php package ricardosierra/changelog. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download ricardosierra/changelog
More information about ricardosierra/changelog
Files in ricardosierra/changelog
Package changelog
Short Description Package to enable change logs to be parsed
License MIT
Homepage https://github.com/ricardosierra/changelog
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
ChangeLog
Quickly and easily modify change logs from a variety of sources.
Currently the package only supports the KeepAChangeLog format of change logs.
It is possible to read and write logs from/to:
- File
- Url (no support for output)
- Native string
- Flysystem
- GitHub repo via GitHub API (currently not for output as I've yet to find a sensible way to do this)
Logs can be formatted into the KeepAChangeLog format, xml and json through the use of various render classes.
Quick Examples
Creating a log
Note releases are sorted in accordance to Semantic Versioning automatically with the latest release at the top.
It is expected that all release names follow this and the only exception to this is unreleased which will always be at
the top of the release list.
Parsing a log
Writing a log
Merging Logs
Logs can be merged together to create a single change log. This includes releases and their changes.
Depending on your use case it might be useful to create an empty log first and merge other logs into that.
Command line utility
Common actions can be performed from the command line using the ./vendor/bin/changelog command or via the changelog.phar
at the releases page.
The command line utility expects a config file called changelog.config.php to exist in the working directory, or it
can be specified with the global --config option. An example config file can be found in changelog.config.example.php
All commands use the same four options to read, parse, render and finally output a change log. These all default to the "default" entry in their respective config arrays.
Eg: changelog.phar --renderer=json would use the json entry from the renderer entry of the config file to construct
a ChangeLog\Renderer\Json object to use to create the end content.
The current commands are:
- Add: Adds a change to a release
- Convert: Converts a release between formats. Simply runs the read, parse, render, write sequence.
- Release: Converts the "unreleased" release into a real release. Can take names such as
major,minor,patchto automatically create release numbers. - Merge: Merge multiple changelog into one.
Check changelog.phar help for more information.
Development
Current plans for development can be found in the repo's issue tracker. If you wish to request extra functionality then open an issue or pull request or give me a poke on twitter or anywhere else you can find me.
Feel free to report any issues on the issue tracker.
Author
Emlyn West
- GitHub
- Email: [email protected]
