Recommend this page to a friend! |
Classes of Marco Cesarato | PHP Conventional Changelog | README.md | Download |
|
Download <div align="center"> <h1 align="center">PHP Conventional Changelog</h1> If this project helped you out, please support us with a star :star:<br> ![](docs/images/logo.png) </div> DescriptionGenerate changelogs from a project's commit messages and metadata using composer and automate versioning with semver and conventional-commits. This package can generate changelog and release notes from committing history. It provides a command that can be run from the terminal, or using composer scripts, to generate a changelog file in markdown for the current project. The command may take parameters that define the releases of the project that will be considered to extract the changes from the git history to generate the file. The package uses a configuration system with that permit to customize the settings you may want to have your desired changelog generated. How to contributeHave an idea? Found a bug? Please raise to ISSUES or PULL REQUEST. Contributions are welcome and are greatly appreciated! Every little bit helps. ? InstallationYou can install it easily with composer
Scripts (Optional)For easy use the changelog generator or release faster your new version you can add to your > Notes: you can customize it according to your needs
Now you can just run ? Configuration> Notes: this procedure is optional and permit to overwriting/merging the default settings For customize settings you just needs to create a file named > Notes:<br>
> - When a setting on the configuration file is not necessary just omit it
> - The default ignored types are: You can have more info about reading the config documentation. ? UsageThe changelog generator will generate a log of changes from the date of the last tag to the current date, and it will put all commit logs in the latest version just created. ![](docs/images/usage.gif) > Notes:<br>
> - Some of these options listed on examples could be used together at the same time (ex. ExamplesFirst version> Notes: use this option only if you don't need all history changes or is the first version, else run with To generate your changelog for the first version run:
New versionTo generate your changelog (without committing files)
New release (with commit and tag)To generate your changelog with auto commit and auto versioning tagging run:
or to amend at an existing commit you can run:
HistoryTo generate your changelog with the entire history of changes of all releases > Warn: this operation will overwrite the
Date rangeTo generate your changelog from a specified date to another specified date
Tag rangeTo generate your changelog from a specified tag to another specified tag
Specific versionTo generate your changelog with a specific version code
Commands List> Info: You can have more info about running
|