Download the PHP package dr-bock/git-changelog without Composer
On this page you can find all versions of the php package dr-bock/git-changelog. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
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 git-changelog
GIT Changelog Generator
composer require --dev dr-bock/git-changelog
Composer package which provides services to generate a changelog for your composer-project from your local git history.
The package is still a beta version. Not all features are fully supported yet. Until the first stable release there may be breaking changes. Use at your own risk.
Disclaimer
I know there are many node- or python-scripts that create a changelog. But I'm a PHP developer and wanted something I could really handle. Maybe nobody but me needs this package.
Installation and Usage...
Add this package to your composer project (ideally as dev-requirement). In the deployed project you certainly don't want to create a changelog.
...as composer command
Add this configuration to your projects composer.json:
Possible options:
| Option | Description |
|---|---|
| commitUrl | Url to a single Commit in your Git-Repository, you can use "%HASH%" and "%SHOT_HASH%" as placeholder for the commit hash. |
| issueUrl | Url to a issue in your helpdesk software. You can use "%ISSUE% as placeholder for the ticket number. |
| changelogIndexFile | Relative path (from your composer projects root) to the changelog overview file. |
| changelogFolder | Relative path (from your composer projects root) to the folder, where to place the detailed changelog files. |
| issueFormat | Format in which issues are tagged in commit message. E.g. "#1234" ("github") or "FOO-12345" ("jira"). Currently only the JIRA format is supported. |
Add this script to your projects composer.json:
A changelog can now be generated with the following command (in the root directory of your composer project):
Options overview:
| Option | Description | |
|---|---|---|
| releaseDate | Date of the release. Format: 2019-08-24 | required |
| releaseName | Name of the release | optional |
| fromTag | If a tag is specified, the changelog is only created from the commits created after this git tag (revision). Ideally the tag of the last release should be used here. | optional |
| fromDate | In addition, the selection of commits used to create the changelog can be restricted by a start date. Format: 2019-08-24 | optional |
| toDate | In addition, the selection of commits used to create the changelog can be restricted by an end date. Format: 2019-08-24 | optional |
| sorting | Specify the sorting of the commits in changelog. ASC (default) or DESC. | optional |
| dryRun | If set, no files are written and the result is only displayed in the console. | optional |
...as php library
Screenshots
Example changelog index:
Example changelog details:
