https://github.com/teohm/git-chlog
Generate changelog for any PR-based Git repository
https://github.com/teohm/git-chlog
changelog changelog-generator chlog git
Last synced: about 1 month ago
JSON representation
Generate changelog for any PR-based Git repository
- Host: GitHub
- URL: https://github.com/teohm/git-chlog
- Owner: teohm
- License: mit
- Created: 2017-11-01T13:28:24.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-11-04T23:57:48.000Z (over 8 years ago)
- Last Synced: 2025-02-05T04:49:05.059Z (over 1 year ago)
- Topics: changelog, changelog-generator, chlog, git
- Language: Ruby
- Homepage:
- Size: 36.1 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# git-chlog
A custom git command `git chlog` to print changelog containing a list of merged pull-requests grouped by tags.
[See CHANGELOG example](https://github.com/teohm/git-chlog/blob/master/CHANGELOG.md) generated by `git chlog`.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'git-chlog'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install git-chlog
## Usage
```sh
git chlog > CHANGELOG.md
```
### Prepare new release
To prepare new release, you want to update changelog before creating new git tag. You can specify to-be-released tag name, it'll group new merged pull-requests under this tag name:
```sh
git chlog --prepare-release=v2.29.0 > CHANGELOG.md
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/git-chlog. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the Git::Chlog project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/git-chlog/blob/master/CODE_OF_CONDUCT.md).