https://github.com/f3ath/git-changelog
Changelog Release Notes Generator for Git and PHP
https://github.com/f3ath/git-changelog
Last synced: 10 months ago
JSON representation
Changelog Release Notes Generator for Git and PHP
- Host: GitHub
- URL: https://github.com/f3ath/git-changelog
- Owner: f3ath
- License: mit
- Created: 2016-11-15T09:54:52.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-01-07T01:48:34.000Z (about 9 years ago)
- Last Synced: 2025-01-23T15:38:19.278Z (12 months ago)
- Language: PHP
- Homepage:
- Size: 43 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Changelog generator for Git and PHP
Generates release notes in [changelog](http://keepachangelog.com/en/0.3.0/) format.
Like this:
```
## [0.0.1] - 2016-12-24
- RepoDetector fix
- Update README.md
- composer binary
- Initial commit
```
And like this:
```
## [0.0.2](https://github.com/f3ath/git-changelog/compare/0.0.1...0.0.2) - 2016-12-24
- Added: README example
```
## Install
With composer:
```bash
composer require f3ath/git-changelog --dev
```
## Usage
For the latest tag:
```bash
vendor/bin/changelog
```
For an arbitrary tag:
```bash
vendor/bin/changelog 0.0.3
```
## Configuration
By default, the remote named "origin" is used for getting details about tags, building the comparison URL, etc.
It is possible to change this behavior by placing a configuration file `.changelog.json` in the current directory.
```json
{
"remote": "upstream"
}
```
## Troubleshooting
Make sure you have fetched the latest state of your remote before running the generator.
```bash
git fetch upstream
```
## Contributing
is always welcome.