Merge branch 'master' into develop
This commit is contained in:
Petr Korolev
commit
ed179ed7be
408
README.md
408
README.md
|
|
@ -1,194 +1,216 @@
|
||||||
[](http://badge.fury.io/rb/github_changelog_generator)
|
[](http://badge.fury.io/rb/github_changelog_generator)
|
||||||
[](https://gemnasium.com/skywinder/github-changelog-generator)
|
[](https://gemnasium.com/skywinder/github-changelog-generator)
|
||||||
[](https://travis-ci.org/skywinder/github-changelog-generator)
|
[](https://travis-ci.org/skywinder/github-changelog-generator)
|
||||||
[](http://inch-ci.org/github/skywinder/github-changelog-generator)
|
[](http://inch-ci.org/github/skywinder/github-changelog-generator)
|
||||||
[](https://codeclimate.com/github/skywinder/github-changelog-generator)
|
[](https://codeclimate.com/github/skywinder/github-changelog-generator)
|
||||||
[](https://codeclimate.com/github/skywinder/github-changelog-generator)
|
[](https://codeclimate.com/github/skywinder/github-changelog-generator)
|
||||||
|
|
||||||
GitHub Changelog Generator 
|
GitHub Changelog Generator 
|
||||||
==================
|
==================
|
||||||
|
|
||||||
- [Installation](#installation)
|
- [Installation](#installation)
|
||||||
- [Output example](#output-example)
|
- [Output example](#output-example)
|
||||||
- [Usage](#usage)
|
- [Usage](#usage)
|
||||||
- [Params](#params)
|
- [Params](#params)
|
||||||
- [GitHub token](#github-token)
|
- [GitHub token](#github-token)
|
||||||
- [Features and advantages of this project](#features-and-advantages-of-this-project)
|
- [Features and advantages of this project](#features-and-advantages-of-this-project)
|
||||||
- [Alternatives](#alternatives)
|
- [Alternatives](#alternatives)
|
||||||
- [Projects using this library](#projects-using-this-library)
|
- [Projects using this library](#projects-using-this-library)
|
||||||
- [Am I missing some essential feature?](#am-i-missing-some-essential-feature)
|
- [Am I missing some essential feature?](#am-i-missing-some-essential-feature)
|
||||||
- [Contributing](#contributing)
|
- [Contributing](#contributing)
|
||||||
- [License](#license)
|
- [License](#license)
|
||||||
|
|
||||||
|
|
||||||
### Changelog generation has never been so easy:
|
### Changelog generation has never been so easy:
|
||||||
|
|
||||||
**Fully automate changelog generation** - This gem generates change log file based on **tags**, **issues** and merged **pull requests** (and splits them into separate lists according labels) from :octocat: GitHub Issue Tracker.
|
**Fully automate changelog generation** - This gem generates change log file based on **tags**, **issues** and merged **pull requests** (and splits them into separate lists according labels) from :octocat: GitHub Issue Tracker.
|
||||||
|
|
||||||
Since now you don't have to fill your `CHANGELOG.md` manually: just run the script, relax and take a cup of :coffee: before your next release! :tada:
|
Since now you don't have to fill your `CHANGELOG.md` manually: just run the script, relax and take a cup of :coffee: before your next release! :tada:
|
||||||
|
|
||||||
>### *What’s the point of a change log?*
|
>### *What’s the point of a change log?*
|
||||||
To make it easier for users and contributors to see precisely what notable changes have been made between each release (or version) of the project.
|
To make it easier for users and contributors to see precisely what notable changes have been made between each release (or version) of the project.
|
||||||
### *Why should I care?*
|
### *Why should I care?*
|
||||||
Because software tools are for people. If you don’t care, why are you contributing to open source? Surely, there must be a kernel (ha!) of care somewhere in that lovely little brain of yours.
|
Because software tools are for people. If you don’t care, why are you contributing to open source? Surely, there must be a kernel (ha!) of care somewhere in that lovely little brain of yours.
|
||||||
|
|
||||||
> :copyright: *[http://keepachangelog.com](http://keepachangelog.com/)*
|
> :copyright: *[http://keepachangelog.com](http://keepachangelog.com/)*
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
[sudo] gem install github_changelog_generator
|
[sudo] gem install github_changelog_generator
|
||||||
|
|
||||||
## Output example
|
## Output example
|
||||||
|
|
||||||
- Look at **[CHANGELOG.md](https://github.com/skywinder/Github-Changelog-Generator/blob/master/CHANGELOG.md)** for this project
|
- Look at **[CHANGELOG.md](https://github.com/skywinder/Github-Changelog-Generator/blob/master/CHANGELOG.md)** for this project
|
||||||
- [ActionSheetPicker-3.0/CHANGELOG.md](https://github.com/skywinder/ActionSheetPicker-3.0/blob/master/CHANGELOG.md) was generated by command:
|
- [ActionSheetPicker-3.0/CHANGELOG.md](https://github.com/skywinder/ActionSheetPicker-3.0/blob/master/CHANGELOG.md) was generated by command:
|
||||||
|
|
||||||
github_changelog_generator -u skywinder -p ActionSheetPicker-3.0
|
github_changelog_generator -u skywinder -p ActionSheetPicker-3.0
|
||||||
|
|
||||||
- In general it looks like this:
|
- In general it looks like this:
|
||||||
|
|
||||||
> ## [1.2.5](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.5) (2015-01-15)
|
> ## [1.2.5](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.5) (2015-01-15)
|
||||||
>
|
>
|
||||||
> [Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.4...1.2.5)
|
> [Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.4...1.2.5)
|
||||||
>
|
>
|
||||||
> **Implemented enhancements:**
|
> **Implemented enhancements:**
|
||||||
>
|
>
|
||||||
> - Use milestone to specify in which version bug was fixed [\#22](https://github.com/skywinder/Github-Changelog-Generator/issues/22)
|
> - Use milestone to specify in which version bug was fixed [\#22](https://github.com/skywinder/Github-Changelog-Generator/issues/22)
|
||||||
>
|
>
|
||||||
> **Fixed bugs:**
|
> **Fixed bugs:**
|
||||||
>
|
>
|
||||||
> - Error when trying to generate log for repo without tags [\#32](https://github.com/skywinder/Github-Changelog-Generator/issues/32)
|
> - Error when trying to generate log for repo without tags [\#32](https://github.com/skywinder/Github-Changelog-Generator/issues/32)
|
||||||
>
|
>
|
||||||
> **Merged pull requests:**
|
> **Merged pull requests:**
|
||||||
>
|
>
|
||||||
> - PrettyPrint class is included using lowercase 'pp' [\#43](https://github.com/skywinder/Github-Changelog-Generator/pull/43) ([schwing](https://github.com/schwing))
|
> - PrettyPrint class is included using lowercase 'pp' [\#43](https://github.com/skywinder/Github-Changelog-Generator/pull/43) ([schwing](https://github.com/schwing))
|
||||||
>
|
>
|
||||||
> - support enterprise github via command line options [\#42](https://github.com/skywinder/Github-Changelog-Generator/pull/42) ([glenlovett](https://github.com/glenlovett))
|
> - support enterprise github via command line options [\#42](https://github.com/skywinder/Github-Changelog-Generator/pull/42) ([glenlovett](https://github.com/glenlovett))
|
||||||
|
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
**It's really simple**:
|
**It's really simple**:
|
||||||
|
|
||||||
- If your **git remote** `origin` refers to your GitHub repo, then just go to your project folder and run:
|
- If your **git remote** `origin` refers to your GitHub repo, then just go to your project folder and run:
|
||||||
|
|
||||||
github_changelog_generator
|
github_changelog_generator
|
||||||
|
|
||||||
- or from anywhere:
|
- or from anywhere:
|
||||||
- `github_changelog_generator -u github_username -p github_project`
|
- `github_changelog_generator -u github_username -p github_project`
|
||||||
- `github_changelog_generator github_username/github_project`
|
- `github_changelog_generator github_username/github_project`
|
||||||
|
|
||||||
As output you will get `CHANGELOG.md` file with pretty *Markdown-formatted* changelog.
|
As output you will get `CHANGELOG.md` file with pretty *Markdown-formatted* changelog.
|
||||||
|
|
||||||
### Params
|
### Params
|
||||||
Type `github_changelog_generator --help` for details.
|
Type `github_changelog_generator --help` for details.
|
||||||
|
|
||||||
More detailed info about params you can find in Wiki page: [**Advanced change log generation examples**](https://github.com/skywinder/github-changelog-generator/wiki/Advanced-change-log-generation-examples)
|
More detailed info about params you can find in Wiki page: [**Advanced change log generation examples**](https://github.com/skywinder/github-changelog-generator/wiki/Advanced-change-log-generation-examples)
|
||||||
|
|
||||||
### GitHub token
|
### GitHub token
|
||||||
|
|
||||||
Since GitHub allows you to make only 50 requests without authentication it's recommended to run this script with a token (`-t, --token` option)
|
Since GitHub allows you to make only 50 requests without authentication it's recommended to run this script with a token (`-t, --token` option)
|
||||||
|
|
||||||
**You can easily [generate it here](https://github.com/settings/tokens/new?description=GitHub%20Changelog%20Generator%20token)**.
|
**You can easily [generate it here](https://github.com/settings/tokens/new?description=GitHub%20Changelog%20Generator%20token)**.
|
||||||
|
|
||||||
And:
|
And:
|
||||||
|
|
||||||
- Run with key `-t [your-16-digit-token]`
|
- Run with key `-t [your-40-digit-token]`
|
||||||
- Or set environment variable `CHANGELOG_GITHUB_TOKEN` and specify there your token.
|
- Or set environment variable `CHANGELOG_GITHUB_TOKEN` and specify there your token.
|
||||||
|
|
||||||
i.e. add to your `~/.bash_profile` or `~/.zshrc` or any other place to load ENV variables string :
|
i.e. add to your `~/.bash_profile` or `~/.zshrc` or any other place to load ENV variables string :
|
||||||
|
|
||||||
export CHANGELOG_GITHUB_TOKEN="your-40-digit-github-token"
|
export CHANGELOG_GITHUB_TOKEN="your-40-digit-github-token"
|
||||||
|
|
||||||
So, if you got error like this:
|
So, if you got error like this:
|
||||||
>! /Library/Ruby/Gems/2.0.0/gems/github_api-0.12.2/lib/github_api/response/raise_error.rb:14:in `on_complete'
|
>! /Library/Ruby/Gems/2.0.0/gems/github_api-0.12.2/lib/github_api/response/raise_error.rb:14:in `on_complete'
|
||||||
|
|
||||||
It's time to create this token or wait for 1 hour before GitHub reset the counter for your IP.
|
It's time to create this token or wait for 1 hour before GitHub reset the counter for your IP.
|
||||||
|
|
||||||
##Features and advantages of this project
|
## Migrating from a manual changelog
|
||||||
- Generate canonical, neat change log file, followed by [basic change log guidelines](http://keepachangelog.com/) :gem:
|
|
||||||
- Possible to generate **Unreleased** changes (closed issues that have not released yet) :dizzy:
|
Knowing how dedicated you are to your project, you probably haven't been waiting for github-changelog-generator to keep a changelog,
|
||||||
- **GitHub Enterprise support** via command line options! :factory:
|
but you most likely wouln't like to have to open issues and PRs for all past features listed in your historic changelog.
|
||||||
- Flexible format **customisation**:
|
|
||||||
- **Customize** issues, that **should be added** to changelog :eight_spoked_asterisk:
|
That's where `--base` comes handy. This option lets you pass a static changelog to be appended at the end of the generated entries.
|
||||||
- **Custom date format** supported (but get in mind [ISO 8601](http://xkcd.com/1179/) ) :date:
|
|
||||||
- Ability to manually specify in which version issue was fixed (in case, when closed date is not match) by setting `milestone` of issue the same name as tag of required version :pushpin:
|
If you have a `HISTORY.md` file in your project, it will automatically be picked as the static historical changelog and appended.
|
||||||
- Automatically **exclude specific issues**, not-related to change log (any issue, that has label `question` `duplicate` `invalid` `wontfix`by default) :scissors:
|
|
||||||
- **Distinguish** issues **according labels**. :mag_right:
|
### Rake task
|
||||||
- Merged pull requests (all `merged` pull-requests) :twisted_rightwards_arrows:
|
|
||||||
- Bug fixes (by label `bug` in issue) :beetle:
|
You love Rake? So do we! And so we've made it easier for you by providing a Rake task library for your Change log generation. In your Rakefile, use:
|
||||||
- Enhancements (by label `enhancement` in issue) :star2:
|
|
||||||
- Issues (closed issues `w/o any labels`) :non-potable_water:
|
```ruby
|
||||||
|
GitHubChangelogGenerator::RakeTask.new :changelog do |config|
|
||||||
- You can manually set which labels should be included/excluded. :wrench:
|
config.since_tag = '0.1.14'
|
||||||
- Apply a lot of other customisations, to fit changelog for your personal style :tophat:
|
config.future_release = '0.2.0'
|
||||||
(*look `github_changelog_generator --help` for details)*
|
end
|
||||||
|
```
|
||||||
|
|
||||||
###Alternatives
|
All command line options can be passed to the Rake task as `config` parameters. Since you're naming the Rake task yourself, you can create as many as you want, too.
|
||||||
Here is a [wikipage list of alternatives](https://github.com/skywinder/Github-Changelog-Generator/wiki/Alternatives), that I found. But none satisfied my requirements.
|
|
||||||
|
##Features and advantages of this project
|
||||||
*If you know other projects - feel free to edit this Wiki page!*
|
- Generate canonical, neat change log file, followed by [basic change log guidelines](http://keepachangelog.com/) :gem:
|
||||||
|
- Possible to generate **Unreleased** changes (closed issues that have not released yet) :dizzy:
|
||||||
|
- **GitHub Enterprise support** via command line options! :factory:
|
||||||
### Projects using this library
|
- Flexible format **customisation**:
|
||||||
[Wikipage with list of projects](https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator)
|
- **Customize** issues, that **should be added** to changelog :eight_spoked_asterisk:
|
||||||
|
- **Custom date format** supported (but get in mind [ISO 8601](http://xkcd.com/1179/) ) :date:
|
||||||
|
- Ability to manually specify in which version issue was fixed (in case, when closed date is not match) by setting `milestone` of issue the same name as tag of required version :pushpin:
|
||||||
|
- Automatically **exclude specific issues**, not-related to change log (any issue, that has label `question` `duplicate` `invalid` `wontfix`by default) :scissors:
|
||||||
|
- **Distinguish** issues **according labels**. :mag_right:
|
||||||
|
- Merged pull requests (all `merged` pull-requests) :twisted_rightwards_arrows:
|
||||||
|
- Bug fixes (by label `bug` in issue) :beetle:
|
||||||
|
- Enhancements (by label `enhancement` in issue) :star2:
|
||||||
|
- Issues (closed issues `w/o any labels`) :non-potable_water:
|
||||||
|
|
||||||
|
- You can manually set which labels should be included/excluded. :wrench:
|
||||||
|
- Apply a lot of other customisations, to fit changelog for your personal style :tophat:
|
||||||
|
(*look `github_changelog_generator --help` for details)*
|
||||||
|
|
||||||
|
|
||||||
|
###Alternatives
|
||||||
|
Here is a [wikipage list of alternatives](https://github.com/skywinder/Github-Changelog-Generator/wiki/Alternatives), that I found. But none satisfied my requirements.
|
||||||
|
|
||||||
|
*If you know other projects - feel free to edit this Wiki page!*
|
||||||
|
|
||||||
|
|
||||||
|
### Projects using this library
|
||||||
|
[Wikipage with list of projects](https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator)
|
||||||
|
|
||||||
If you've used this project in a live app, please let me know! Nothing makes me happier than seeing someone else take my work and go wild with it.
|
If you've used this project in a live app, please let me know! Nothing makes me happier than seeing someone else take my work and go wild with it.
|
||||||
|
|
||||||
*If you are using `github_changelog_generator` for generation change log in your project or know another project that uses it, please add it to [this] (https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator) list.*
|
*If you are using `github_changelog_generator` for generation change log in your project or know another project that uses it, please add it to [this] (https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator) list.*
|
||||||
|
|
||||||
## Am I missing some essential feature?
|
## Am I missing some essential feature?
|
||||||
|
|
||||||
- **Nothing is impossible!**
|
- **Nothing is impossible!**
|
||||||
|
|
||||||
- Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/new) and let's make generator better together!
|
- Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/new) and let's make generator better together!
|
||||||
|
|
||||||
- *Bug reports, feature requests, patches, well-wishes are always welcome* :heavy_exclamation_mark:
|
- *Bug reports, feature requests, patches, well-wishes are always welcome* :heavy_exclamation_mark:
|
||||||
|
|
||||||
## FAQ
|
## FAQ
|
||||||
|
|
||||||
- ***I already use GitHub Releases. Why do I need this?***
|
- ***I already use GitHub Releases. Why do I need this?***
|
||||||
|
|
||||||
GitHub Releases is a very good thing. And it's very good practice to maintain it (not so much people using it yet)! :congratulations:
|
GitHub Releases is a very good thing. And it's very good practice to maintain it (not so much people using it yet)! :congratulations:
|
||||||
|
|
||||||
*BDW: I would like to support GitHub Releases in [next releases](https://github.com/skywinder/github-changelog-generator/issues/56) ;)*
|
*BDW: I would like to support GitHub Releases in [next releases](https://github.com/skywinder/github-changelog-generator/issues/56) ;)*
|
||||||
|
|
||||||
I'm not try to compare quality of auto-generated and manually generated logs.. but:
|
I'm not try to compare quality of auto-generated and manually generated logs.. but:
|
||||||
|
|
||||||
The auto generated Changelog really helps even if you manually fill Releases notes!
|
The auto generated Changelog really helps even if you manually fill Releases notes!
|
||||||
|
|
||||||
For example:
|
For example:
|
||||||
|
|
||||||
When I found a closed bug - it's very useful to understand, in which release it was fixed. In that case you can easily find this issue by \# in `CHANGELOG.md`.
|
When I found a closed bug - it's very useful to understand, in which release it was fixed. In that case you can easily find this issue by \# in `CHANGELOG.md`.
|
||||||
|
|
||||||
- it's not so quite easy to find it in manually filled Releases notes.
|
- it's not so quite easy to find it in manually filled Releases notes.
|
||||||
- this file can also help you to build your Release note and not miss features in manually-filled list.
|
- this file can also help you to build your Release note and not miss features in manually-filled list.
|
||||||
|
|
||||||
In the end:
|
In the end:
|
||||||
|
|
||||||
I think, that GitHub Releases is more for end-users.
|
I think, that GitHub Releases is more for end-users.
|
||||||
But `CHANGELOG.md` could stay in the repo for developers with detailed list of changes.
|
But `CHANGELOG.md` could stay in the repo for developers with detailed list of changes.
|
||||||
And it's nothing bad to combine GitHub Releases and `CHANGELOG.md` file together in that manner.
|
And it's nothing bad to combine GitHub Releases and `CHANGELOG.md` file together in that manner.
|
||||||
|
|
||||||
- ***I received a warning: GitHub API rate limit exceed, what does this mean?***
|
- ***I received a warning: GitHub API rate limit exceed, what does this mean?***
|
||||||
|
|
||||||
GitHub [limits the number of API requests](https://developer.github.com/v3/#rate-limiting) you can make in an hour. You can make up to 5,000 requests per hour. For unauthenticated requests, the rate limit allows you to make up to 60 requests per hour. Unauthenticated requests are associated with your IP address, and not the user making requests.
|
GitHub [limits the number of API requests](https://developer.github.com/v3/#rate-limiting) you can make in an hour. You can make up to 5,000 requests per hour. For unauthenticated requests, the rate limit allows you to make up to 60 requests per hour. Unauthenticated requests are associated with your IP address, and not the user making requests.
|
||||||
|
|
||||||
If you're seeing this warning:
|
If you're seeing this warning:
|
||||||
|
|
||||||
1. Make sure you're providing an OAuth token so you're not anonymously making requests. This will increase the number of requests from 60 to 5000 per hour.
|
1. Make sure you're providing an OAuth token so you're not anonymously making requests. This will increase the number of requests from 60 to 5000 per hour.
|
||||||
2. You probably have a large repo with lots of issues/PRs. You can use the `--max-issues NUM` argument to limit the number of issues that are pulled back. For example: `--max-issues 1000`
|
2. You probably have a large repo with lots of issues/PRs. You can use the `--max-issues NUM` argument to limit the number of issues that are pulled back. For example: `--max-issues 1000`
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
1. Create an issue to discuss about your idea
|
1. Create an issue to discuss about your idea
|
||||||
2. [Fork it] (https://github.com/skywinder/Github-Changelog-Generator/fork)
|
2. [Fork it] (https://github.com/skywinder/Github-Changelog-Generator/fork)
|
||||||
3. Create your feature branch (`git checkout -b my-new-feature`)
|
3. Create your feature branch (`git checkout -b my-new-feature`)
|
||||||
4. Commit your changes (`git commit -am 'Add some feature'`)
|
4. Commit your changes (`git commit -am 'Add some feature'`)
|
||||||
5. Push to the branch (`git push origin my-new-feature`)
|
5. Push to the branch (`git push origin my-new-feature`)
|
||||||
6. Create a new Pull Request
|
6. Create a new Pull Request
|
||||||
7. Profit! :white_check_mark:
|
7. Profit! :white_check_mark:
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
Github Changelog Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT).
|
Github Changelog Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT).
|
||||||
|
|
|
||||||
|
|
@ -16,6 +16,8 @@ module GitHubChangelogGenerator
|
||||||
log += generate_log_for_all_tags
|
log += generate_log_for_all_tags
|
||||||
end
|
end
|
||||||
|
|
||||||
|
log += File.read(@options[:base]) if File.file?(@options[:base])
|
||||||
|
|
||||||
log += "\n\n\\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*"
|
log += "\n\n\\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*"
|
||||||
@log = log
|
@log = log
|
||||||
end
|
end
|
||||||
|
|
@ -76,10 +78,15 @@ module GitHubChangelogGenerator
|
||||||
time_string = newer_tag_time.strftime @options[:date_format]
|
time_string = newer_tag_time.strftime @options[:date_format]
|
||||||
|
|
||||||
# Generate tag name and link
|
# Generate tag name and link
|
||||||
if newer_tag_name.equal? @options[:unreleased_label]
|
if @options[:release_url]
|
||||||
log += "## [#{newer_tag_name}](#{project_url}/tree/#{newer_tag_link})\n\n"
|
release_url = format(@options[:release_url], newer_tag_link)
|
||||||
else
|
else
|
||||||
log += "## [#{newer_tag_name}](#{project_url}/tree/#{newer_tag_link}) (#{time_string})\n"
|
release_url = "#{project_url}/tree/#{newer_tag_link}"
|
||||||
|
end
|
||||||
|
if newer_tag_name.equal? @options[:unreleased_label]
|
||||||
|
log += "## [#{newer_tag_name}](#{release_url})\n\n"
|
||||||
|
else
|
||||||
|
log += "## [#{newer_tag_name}](#{release_url}) (#{time_string})\n"
|
||||||
end
|
end
|
||||||
|
|
||||||
if @options[:compare_link] && older_tag_link
|
if @options[:compare_link] && older_tag_link
|
||||||
|
|
|
||||||
|
|
@ -52,14 +52,42 @@ module GitHubChangelogGenerator
|
||||||
[newer_tag_link, newer_tag_name, newer_tag_time]
|
[newer_tag_link, newer_tag_name, newer_tag_time]
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def detect_since_tag
|
||||||
|
if @options[:base] && File.file?(@options[:base])
|
||||||
|
reader = GitHubChangelogGenerator::Reader.new
|
||||||
|
content = reader.read(@options[:base])
|
||||||
|
return content[0]["version"] if content
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
# Return tags after filtering tags in lists provided by option: --between-tags & --exclude-tags
|
# Return tags after filtering tags in lists provided by option: --between-tags & --exclude-tags
|
||||||
#
|
#
|
||||||
# @return [Array]
|
# @return [Array]
|
||||||
def get_filtered_tags(all_tags)
|
def get_filtered_tags(all_tags)
|
||||||
filtered_tags = filter_between_tags(all_tags)
|
filtered_tags = filter_since_tag(all_tags)
|
||||||
|
filtered_tags = filter_between_tags(filtered_tags)
|
||||||
filter_excluded_tags(filtered_tags)
|
filter_excluded_tags(filtered_tags)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def filter_since_tag(all_tags)
|
||||||
|
filtered_tags = all_tags
|
||||||
|
tag = @options[:since_tag]
|
||||||
|
tag ||= detect_since_tag
|
||||||
|
if tag
|
||||||
|
if all_tags.map(&:name).include? tag
|
||||||
|
idx = all_tags.index { |t| t.name == tag }
|
||||||
|
if idx > 0
|
||||||
|
filtered_tags = all_tags[0..idx - 1]
|
||||||
|
else
|
||||||
|
filtered_tags = []
|
||||||
|
end
|
||||||
|
else
|
||||||
|
Helper.log.warn "Warning: can't find tag #{tag}, specified with --since-tag option."
|
||||||
|
end
|
||||||
|
end
|
||||||
|
filtered_tags
|
||||||
|
end
|
||||||
|
|
||||||
def filter_between_tags(all_tags)
|
def filter_between_tags(all_tags)
|
||||||
filtered_tags = all_tags
|
filtered_tags = all_tags
|
||||||
if @options[:between_tags]
|
if @options[:between_tags]
|
||||||
|
|
|
||||||
|
|
@ -14,7 +14,7 @@ module GitHubChangelogGenerator
|
||||||
parser.parse!
|
parser.parse!
|
||||||
|
|
||||||
if options[:user].nil? || options[:project].nil?
|
if options[:user].nil? || options[:project].nil?
|
||||||
detect_user_and_project(options)
|
detect_user_and_project(options, ARGV[0], ARGV[1])
|
||||||
end
|
end
|
||||||
|
|
||||||
if !options[:user] || !options[:project]
|
if !options[:user] || !options[:project]
|
||||||
|
|
@ -50,6 +50,9 @@ module GitHubChangelogGenerator
|
||||||
opts.on("-o", "--output [NAME]", "Output file. Default is CHANGELOG.md") do |last|
|
opts.on("-o", "--output [NAME]", "Output file. Default is CHANGELOG.md") do |last|
|
||||||
options[:output] = last
|
options[:output] = last
|
||||||
end
|
end
|
||||||
|
opts.on("-b", "--base [NAME]", "Optional base file to append generated changes to.") do |last|
|
||||||
|
options[:base] = last
|
||||||
|
end
|
||||||
opts.on("--bugs-label [LABEL]", "Setup custom label for bug-fixes section. Default is \"**Fixed bugs:**""") do |v|
|
opts.on("--bugs-label [LABEL]", "Setup custom label for bug-fixes section. Default is \"**Fixed bugs:**""") do |v|
|
||||||
options[:bug_prefix] = v
|
options[:bug_prefix] = v
|
||||||
end
|
end
|
||||||
|
|
@ -110,12 +113,18 @@ module GitHubChangelogGenerator
|
||||||
opts.on("--between-tags x,y,z", Array, "Change log will be filled only between specified tags") do |list|
|
opts.on("--between-tags x,y,z", Array, "Change log will be filled only between specified tags") do |list|
|
||||||
options[:between_tags] = list
|
options[:between_tags] = list
|
||||||
end
|
end
|
||||||
opts.on("--exclude-tags x,y,z", Array, "Change log will be exclude specified tags") do |list|
|
opts.on("--exclude-tags x,y,z", Array, "Change log will exclude specified tags") do |list|
|
||||||
options[:exclude_tags] = list
|
options[:exclude_tags] = list
|
||||||
end
|
end
|
||||||
|
opts.on("--since-tag x", "Change log will start after specified tag") do |v|
|
||||||
|
options[:since_tag] = v
|
||||||
|
end
|
||||||
opts.on("--max-issues [NUMBER]", Integer, "Max number of issues to fetch from GitHub. Default is unlimited") do |max|
|
opts.on("--max-issues [NUMBER]", Integer, "Max number of issues to fetch from GitHub. Default is unlimited") do |max|
|
||||||
options[:max_issues] = max
|
options[:max_issues] = max
|
||||||
end
|
end
|
||||||
|
opts.on("--release-url [URL]", "The URL to point to for release links, in printf format (with the tag as variable).") do |url|
|
||||||
|
options[:release_url] = url
|
||||||
|
end
|
||||||
opts.on("--github-site [URL]", "The Enterprise Github site on which your project is hosted.") do |last|
|
opts.on("--github-site [URL]", "The Enterprise Github site on which your project is hosted.") do |last|
|
||||||
options[:github_site] = last
|
options[:github_site] = last
|
||||||
end
|
end
|
||||||
|
|
@ -150,6 +159,7 @@ module GitHubChangelogGenerator
|
||||||
tag2: nil,
|
tag2: nil,
|
||||||
date_format: "%Y-%m-%d",
|
date_format: "%Y-%m-%d",
|
||||||
output: "CHANGELOG.md",
|
output: "CHANGELOG.md",
|
||||||
|
base: "HISTORY.md",
|
||||||
issues: true,
|
issues: true,
|
||||||
add_issues_wo_labels: true,
|
add_issues_wo_labels: true,
|
||||||
add_pr_wo_labels: true,
|
add_pr_wo_labels: true,
|
||||||
|
|
@ -177,8 +187,8 @@ module GitHubChangelogGenerator
|
||||||
end
|
end
|
||||||
|
|
||||||
# Detects user and project from git
|
# Detects user and project from git
|
||||||
def self.detect_user_and_project(options)
|
def self.detect_user_and_project(options, arg0 = nil, arg1 = nil)
|
||||||
options[:user], options[:project] = user_project_from_option(ARGV[0], ARGV[1], options[:github_site])
|
options[:user], options[:project] = user_project_from_option(arg0, arg1, options[:github_site])
|
||||||
if !options[:user] || !options[:project]
|
if !options[:user] || !options[:project]
|
||||||
if ENV["RUBYLIB"] =~ /ruby-debug-ide/
|
if ENV["RUBYLIB"] =~ /ruby-debug-ide/
|
||||||
options[:user] = "skywinder"
|
options[:user] = "skywinder"
|
||||||
|
|
|
||||||
68
lib/github_changelog_generator/task.rb
Normal file
68
lib/github_changelog_generator/task.rb
Normal file
|
|
@ -0,0 +1,68 @@
|
||||||
|
require "rake"
|
||||||
|
require "rake/tasklib"
|
||||||
|
require "github_changelog_generator"
|
||||||
|
|
||||||
|
module GitHubChangelogGenerator
|
||||||
|
class RakeTask < ::Rake::TaskLib
|
||||||
|
include ::Rake::DSL if defined?(::Rake::DSL)
|
||||||
|
|
||||||
|
OPTIONS = %w( user project token date_format output
|
||||||
|
bug_prefix enhancement_prefix issue_prefix
|
||||||
|
header merge_prefix issues
|
||||||
|
add_issues_wo_labels add_pr_wo_labels
|
||||||
|
pulls filter_issues_by_milestone author
|
||||||
|
unreleased_only unreleased unreleased_label
|
||||||
|
compare_link include_labels exclude_labels
|
||||||
|
bug_labels enhancement_labels
|
||||||
|
between_tags exclude_tags since_tag max_issues
|
||||||
|
github_site github_endpoint simple_list
|
||||||
|
future_release verbose )
|
||||||
|
|
||||||
|
OPTIONS.each do |o|
|
||||||
|
attr_accessor o.to_sym
|
||||||
|
end
|
||||||
|
|
||||||
|
# Public: Initialise a new GitHubChangelogGenerator::RakeTask.
|
||||||
|
#
|
||||||
|
# Example
|
||||||
|
#
|
||||||
|
# GitHubChangelogGenerator::RakeTask.new
|
||||||
|
def initialize(*args, &task_block)
|
||||||
|
@name = args.shift || :changelog
|
||||||
|
|
||||||
|
define(args, &task_block)
|
||||||
|
end
|
||||||
|
|
||||||
|
def define(args, &task_block)
|
||||||
|
desc "Generate a Change log from GitHub"
|
||||||
|
|
||||||
|
task_block.call(*[self, args].slice(0, task_block.arity)) if task_block
|
||||||
|
|
||||||
|
# clear any (auto-)pre-existing task
|
||||||
|
Rake::Task[@name].clear if Rake::Task.task_defined?(@name)
|
||||||
|
|
||||||
|
task @name do
|
||||||
|
# mimick parse_options
|
||||||
|
options = Parser.get_default_options
|
||||||
|
|
||||||
|
if options[:user].nil? || options[:project].nil?
|
||||||
|
Parser.detect_user_and_project(options)
|
||||||
|
end
|
||||||
|
|
||||||
|
OPTIONS.each do |o|
|
||||||
|
v = instance_variable_get("@#{o}")
|
||||||
|
options[o.to_sym] = v if v
|
||||||
|
end
|
||||||
|
|
||||||
|
generator = Generator.new options
|
||||||
|
|
||||||
|
log = generator.compound_changelog
|
||||||
|
|
||||||
|
output_filename = "#{options[:output]}"
|
||||||
|
File.open(output_filename, "w") { |file| file.write(log) }
|
||||||
|
puts "Done!"
|
||||||
|
puts "Generated log placed in #{Dir.pwd}/#{output_filename}"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
@ -89,6 +89,22 @@ describe GitHubChangelogGenerator::Generator do
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
describe "#filter_since_tag" do
|
||||||
|
subject { generator.filter_since_tag(tags_mash_from_strings(%w(1 2 3))) }
|
||||||
|
|
||||||
|
context "with valid since tag" do
|
||||||
|
let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "2") }
|
||||||
|
it { is_expected.to be_a Array }
|
||||||
|
it { is_expected.to match_array(tags_mash_from_strings(%w(1))) }
|
||||||
|
end
|
||||||
|
|
||||||
|
context "with invalid since tag" do
|
||||||
|
let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: %w(invalid tags)) }
|
||||||
|
it { is_expected.to be_a Array }
|
||||||
|
it { is_expected.to match_array(tags_mash_from_strings(%w(1 2 3))) }
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
describe "#get_time_of_tag" do
|
describe "#get_time_of_tag" do
|
||||||
current_time = Time.now
|
current_time = Time.now
|
||||||
before(:all) { @generator = GitHubChangelogGenerator::Generator.new }
|
before(:all) { @generator = GitHubChangelogGenerator::Generator.new }
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue
Block a user