Compare commits

..

4 Commits

Author SHA1 Message Date
Petr Korolev
930372b572 Genrated files by command ronn ./man/git-generate-changelog.md 2015-10-02 00:07:29 +03:00
Petr Korolev
6a1b4f553f add md man file 2015-10-02 00:07:23 +03:00
Petr Korolev
23f4a79462 Merge branch 'master' of https://github.com/dlanileonardo/github-changelog-generator into dlanileonardo-master 2015-10-02 00:06:45 +03:00
Dlani Mendes
8acfcd934f Git Subcommand 2015-09-30 19:12:49 -03:00
26 changed files with 276 additions and 407 deletions

1
.gitignore vendored
View File

@@ -1 +0,0 @@
coverage/

View File

@@ -18,39 +18,3 @@ Metrics/MethodLength:
Style/FileName: Style/FileName:
Exclude: Exclude:
- 'bin/git-generate-changelog' - 'bin/git-generate-changelog'
#TODOS
# Offense count: 14
Metrics/AbcSize:
Enabled: false
# Offense count: 1
Style/AccessorMethodName:
Enabled: false
# Offense count: 10
Style/Documentation:
Enabled: false
# Offense count: 1
# Configuration parameters: MinBodyLength.
Style/GuardClause:
Enabled: false
# Offense count: 2
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, MinBodyLength, SupportedStyles.
# SupportedStyles: skip_modifier_ifs, always
Style/Next:
Enabled: false
# Offense count: 3
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, SupportedStyles, AllowInnerSlashes.
# SupportedStyles: slashes, percent_r, mixed
Style/RegexpLiteral:
Enabled: false
Style/MutableConstant:
Enabled: false

View File

@@ -1,17 +1,11 @@
# This configuration was generated by # This configuration was generated by `rubocop --auto-gen-config`
# `rubocop --auto-gen-config` # on 2015-07-16 14:46:25 +0300 using RuboCop version 0.31.0.
# on 2016-02-23 17:18:27 +0200 using RuboCop version 0.37.2.
# The point is for the user to remove these configuration records # The point is for the user to remove these configuration records
# one by one as the offenses are removed from the code base. # one by one as the offenses are removed from the code base.
# Note that changes in the inspected code, or installation of new # Note that changes in the inspected code, or installation of new
# versions of RuboCop, may require this file to be generated again. # versions of RuboCop, may require this file to be generated again.
# Offense count: 1 # Offense count: 13
Lint/ImplicitStringConcatenation:
Exclude:
- 'lib/github_changelog_generator/parser.rb'
# Offense count: 14
Metrics/AbcSize: Metrics/AbcSize:
Enabled: false Enabled: false
@@ -19,11 +13,11 @@ Metrics/AbcSize:
Metrics/CyclomaticComplexity: Metrics/CyclomaticComplexity:
Max: 7 Max: 7
# Offense count: 2 # Offense count: 1
Metrics/PerceivedComplexity: Metrics/PerceivedComplexity:
Max: 8 Max: 8
# Offense count: 1 # Offense count: 2
Style/AccessorMethodName: Style/AccessorMethodName:
Enabled: false Enabled: false
@@ -36,16 +30,13 @@ Style/Documentation:
Style/GuardClause: Style/GuardClause:
Enabled: false Enabled: false
# Offense count: 2 # Offense count: 1
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, MinBodyLength, SupportedStyles. # Configuration parameters: EnforcedStyle, MinBodyLength, SupportedStyles.
# SupportedStyles: skip_modifier_ifs, always
Style/Next: Style/Next:
Enabled: false Enabled: false
# Offense count: 3 # Offense count: 3
# Cop supports --auto-correct. # Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, SupportedStyles, AllowInnerSlashes. # Configuration parameters: EnforcedStyle, SupportedStyles, AllowInnerSlashes.
# SupportedStyles: slashes, percent_r, mixed
Style/RegexpLiteral: Style/RegexpLiteral:
Enabled: false Enabled: false

View File

@@ -1,12 +1,9 @@
sudo: false
language: ruby language: ruby
before_install: before_install: gem update --system
- gem update --system
- gem install bundler
rvm: rvm:
- 2.1.0 - 2.1.0
script: script:
- bundle exec rake checks - bundle exec rake
notifications: notifications:
email: email:
recipients: recipients:

View File

@@ -1,61 +1,5 @@
# Change Log # Change Log
## [1.10.3](https://github.com/skywinder/github-changelog-generator/tree/1.10.3) (2016-02-23)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.10.2...1.10.3)
**Fixed bugs:**
- Getting an error on install [\#329](https://github.com/skywinder/github-changelog-generator/issues/329)
## [1.10.2](https://github.com/skywinder/github-changelog-generator/tree/1.10.2) (2016-02-23)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/v1.11.0...1.10.2)
## [v1.11.0](https://github.com/skywinder/github-changelog-generator/tree/v1.11.0) (2016-02-23)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.10.1...v1.11.0)
**Implemented enhancements:**
- YAML front matter [\#322](https://github.com/skywinder/github-changelog-generator/pull/322) ([retorquere](https://github.com/retorquere))
- Git Subcommand [\#288](https://github.com/skywinder/github-changelog-generator/pull/288) ([dlanileonardo](https://github.com/dlanileonardo))
**Fixed bugs:**
- detect\_since\_tag undefined [\#328](https://github.com/skywinder/github-changelog-generator/issues/328)
**Merged pull requests:**
- Update README.md [\#324](https://github.com/skywinder/github-changelog-generator/pull/324) ([Zearin](https://github.com/Zearin))
## [1.10.1](https://github.com/skywinder/github-changelog-generator/tree/1.10.1) (2016-01-06)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.10.0...1.10.1)
**Fixed bugs:**
- Parser: avoid Ruby exit, to make Rake tasks work [\#315](https://github.com/skywinder/github-changelog-generator/pull/315) ([olleolleolle](https://github.com/olleolleolle))
## [1.10.0](https://github.com/skywinder/github-changelog-generator/tree/1.10.0) (2016-01-05)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.9.0...1.10.0)
**Implemented enhancements:**
- Rubocop: less complex methods in parser.rb [\#297](https://github.com/skywinder/github-changelog-generator/pull/297) ([olleolleolle](https://github.com/olleolleolle))
- Introduce ParserError exception class [\#296](https://github.com/skywinder/github-changelog-generator/pull/296) ([olleolleolle](https://github.com/olleolleolle))
- ParserFile: support values with equals signs [\#285](https://github.com/skywinder/github-changelog-generator/pull/285) ([olleolleolle](https://github.com/olleolleolle))
**Closed issues:**
- PRs not closed on master branch show up in changelog [\#280](https://github.com/skywinder/github-changelog-generator/issues/280)
**Merged pull requests:**
- Update bundler [\#306](https://github.com/skywinder/github-changelog-generator/pull/306) ([SteveGilvarry](https://github.com/SteveGilvarry))
- Fixes \#280 Add release-branch option to filter the Pull Requests [\#305](https://github.com/skywinder/github-changelog-generator/pull/305) ([SteveGilvarry](https://github.com/SteveGilvarry))
- Add options to def self.user\_and\_project\_from\_git to fix parser.rb:19… [\#303](https://github.com/skywinder/github-changelog-generator/pull/303) ([SteveGilvarry](https://github.com/SteveGilvarry))
- Git ignore coverage/ [\#300](https://github.com/skywinder/github-changelog-generator/pull/300) ([olleolleolle](https://github.com/olleolleolle))
- \[refactor\] Fix docblock datatype, use \#map [\#299](https://github.com/skywinder/github-changelog-generator/pull/299) ([olleolleolle](https://github.com/olleolleolle))
- \[refactor\] Reader: positive Boolean; unused \#map [\#298](https://github.com/skywinder/github-changelog-generator/pull/298) ([olleolleolle](https://github.com/olleolleolle))
- Add base option to RakeTask [\#287](https://github.com/skywinder/github-changelog-generator/pull/287) ([jkeiser](https://github.com/jkeiser))
## [1.9.0](https://github.com/skywinder/github-changelog-generator/tree/1.9.0) (2015-09-17) ## [1.9.0](https://github.com/skywinder/github-changelog-generator/tree/1.9.0) (2015-09-17)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.5...1.9.0) [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.5...1.9.0)

View File

@@ -1,86 +1,92 @@
PATH PATH
remote: . remote: .
specs: specs:
github_changelog_generator (1.10.4) github_changelog_generator (1.9.0)
bundler (~> 1.7)
colorize (~> 0.7) colorize (~> 0.7)
github_api (~> 0.12) github_api (~> 0.12)
overcommit (~> 0.31)
rake (~> 10.0)
GEM GEM
remote: https://rubygems.org/ remote: https://rubygems.org/
specs: specs:
addressable (2.4.0) addressable (2.3.8)
ast (2.2.0) ast (2.0.0)
childprocess (0.5.9) astrolabe (1.3.1)
ffi (~> 1.0, >= 1.0.11) parser (~> 2.2)
codeclimate-test-reporter (0.4.8) codeclimate-test-reporter (0.4.7)
simplecov (>= 0.7.1, < 1.0.0) simplecov (>= 0.7.1, < 1.0.0)
colorize (0.7.7) colorize (0.7.7)
coveralls (0.8.11) coveralls (0.8.2)
json (~> 1.8) json (~> 1.8)
simplecov (~> 0.11.0) rest-client (>= 1.6.8, < 2)
simplecov (~> 0.10.0)
term-ansicolor (~> 1.3) term-ansicolor (~> 1.3)
thor (~> 0.19.1) thor (~> 0.19.1)
tins (~> 1.6.0)
descendants_tracker (0.0.4) descendants_tracker (0.0.4)
thread_safe (~> 0.3, >= 0.3.1) thread_safe (~> 0.3, >= 0.3.1)
diff-lcs (1.2.5) diff-lcs (1.2.5)
docile (1.1.5) docile (1.1.5)
faraday (0.9.2) domain_name (0.5.24)
unf (>= 0.0.5, < 1.0.0)
faraday (0.9.1)
multipart-post (>= 1.2, < 3) multipart-post (>= 1.2, < 3)
ffi (1.9.10) github_api (0.12.4)
github_api (0.13.1) addressable (~> 2.3)
addressable (~> 2.4.0)
descendants_tracker (~> 0.0.4) descendants_tracker (~> 0.0.4)
faraday (~> 0.8, < 0.10) faraday (~> 0.8, < 0.10)
hashie (>= 3.4) hashie (>= 3.4)
multi_json (>= 1.7.5, < 2.0) multi_json (>= 1.7.5, < 2.0)
nokogiri (~> 1.6.6)
oauth2 oauth2
hashie (3.4.3) hashie (3.4.2)
iniparse (1.4.2) http-cookie (1.0.2)
domain_name (~> 0.5)
json (1.8.3) json (1.8.3)
jwt (1.5.1) jwt (1.5.1)
mime-types (2.6.1)
mini_portile (0.6.2)
multi_json (1.11.2) multi_json (1.11.2)
multi_xml (0.5.5) multi_xml (0.5.5)
multipart-post (2.0.0) multipart-post (2.0.0)
oauth2 (1.1.0) netrc (0.10.3)
nokogiri (1.6.6.2)
mini_portile (~> 0.6.0)
oauth2 (1.0.0)
faraday (>= 0.8, < 0.10) faraday (>= 0.8, < 0.10)
jwt (~> 1.0, < 1.5.2) jwt (~> 1.0)
multi_json (~> 1.3) multi_json (~> 1.3)
multi_xml (~> 0.5) multi_xml (~> 0.5)
rack (>= 1.2, < 3) rack (~> 1.2)
overcommit (0.32.0) parser (2.2.2.6)
childprocess (~> 0.5.8) ast (>= 1.1, < 3.0)
iniparse (~> 1.4)
parser (2.3.0.6)
ast (~> 2.2)
powerpack (0.1.1) powerpack (0.1.1)
rack (1.6.4) rack (1.6.4)
rainbow (2.1.0) rainbow (2.0.0)
rake (10.5.0) rake (10.4.2)
rspec (3.4.0) rest-client (1.8.0)
rspec-core (~> 3.4.0) http-cookie (>= 1.0.2, < 2.0)
rspec-expectations (~> 3.4.0) mime-types (>= 1.16, < 3.0)
rspec-mocks (~> 3.4.0) netrc (~> 0.7)
rspec-core (3.4.3) rspec (3.3.0)
rspec-support (~> 3.4.0) rspec-core (~> 3.3.0)
rspec-expectations (3.4.0) rspec-expectations (~> 3.3.0)
rspec-mocks (~> 3.3.0)
rspec-core (3.3.2)
rspec-support (~> 3.3.0)
rspec-expectations (3.3.1)
diff-lcs (>= 1.2.0, < 2.0) diff-lcs (>= 1.2.0, < 2.0)
rspec-support (~> 3.4.0) rspec-support (~> 3.3.0)
rspec-mocks (3.4.1) rspec-mocks (3.3.2)
diff-lcs (>= 1.2.0, < 2.0) diff-lcs (>= 1.2.0, < 2.0)
rspec-support (~> 3.4.0) rspec-support (~> 3.3.0)
rspec-support (3.4.1) rspec-support (3.3.0)
rubocop (0.37.2) rubocop (0.32.1)
parser (>= 2.3.0.4, < 3.0) astrolabe (~> 1.3)
parser (>= 2.2.2.5, < 3.0)
powerpack (~> 0.1) powerpack (~> 0.1)
rainbow (>= 1.99.1, < 3.0) rainbow (>= 1.99.1, < 3.0)
ruby-progressbar (~> 1.7) ruby-progressbar (~> 1.4)
unicode-display_width (~> 0.3)
ruby-progressbar (1.7.5) ruby-progressbar (1.7.5)
simplecov (0.11.2) simplecov (0.10.0)
docile (~> 1.1.0) docile (~> 1.1.0)
json (~> 1.8) json (~> 1.8)
simplecov-html (~> 0.10.0) simplecov-html (~> 0.10.0)
@@ -89,19 +95,23 @@ GEM
tins (~> 1.0) tins (~> 1.0)
thor (0.19.1) thor (0.19.1)
thread_safe (0.3.5) thread_safe (0.3.5)
tins (1.6.0) tins (1.5.4)
unicode-display_width (0.3.1) unf (0.1.4)
unf_ext
unf_ext (0.0.7.1)
PLATFORMS PLATFORMS
ruby ruby
DEPENDENCIES DEPENDENCIES
bundler (~> 1.7)
codeclimate-test-reporter (~> 0.4) codeclimate-test-reporter (~> 0.4)
coveralls (~> 0.8) coveralls (~> 0.8)
github_changelog_generator! github_changelog_generator!
rake (~> 10.0)
rspec (~> 3.2) rspec (~> 3.2)
rubocop (~> 0.31) rubocop (~> 0.31)
simplecov (~> 0.10) simplecov (~> 0.10)
BUNDLED WITH BUNDLED WITH
1.11.2 1.10.6

139
README.md
View File

@@ -1,5 +1,5 @@
[![Gem Version](https://badge.fury.io/rb/github_changelog_generator.svg)](http://badge.fury.io/rb/github_changelog_generator) [![Gem Version](https://badge.fury.io/rb/github_changelog_generator.svg)](http://badge.fury.io/rb/github_changelog_generator)
[![Dependency Status](https://gemnasium.com/skywinder/github-changelog-generator.svg)](https://gemnasium.com/skywinder/github-changelog-generator) [![Dependency Status](https://gemnasium.com/skywinder/github-changelog-generator.svg)](https://gemnasium.com/skywinder/github-changelog-generator)
[![Build Status](https://travis-ci.org/skywinder/github-changelog-generator.svg?branch=master)](https://travis-ci.org/skywinder/github-changelog-generator) [![Build Status](https://travis-ci.org/skywinder/github-changelog-generator.svg?branch=master)](https://travis-ci.org/skywinder/github-changelog-generator)
[![Inline docs](http://inch-ci.org/github/skywinder/github-changelog-generator.svg)](http://inch-ci.org/github/skywinder/github-changelog-generator) [![Inline docs](http://inch-ci.org/github/skywinder/github-changelog-generator.svg)](http://inch-ci.org/github/skywinder/github-changelog-generator)
[![Code Climate](https://codeclimate.com/github/skywinder/github-changelog-generator/badges/gpa.svg)](https://codeclimate.com/github/skywinder/github-changelog-generator) [![Code Climate](https://codeclimate.com/github/skywinder/github-changelog-generator/badges/gpa.svg)](https://codeclimate.com/github/skywinder/github-changelog-generator)
@@ -21,7 +21,7 @@ GitHub Changelog Generator ![GitHub Logo](../master/images/logo.jpg)
- [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.
@@ -32,7 +32,7 @@ To make it easier for users and contributors to see precisely what notable chang
### *Why should I care?* ### *Why should I care?*
Because software tools are for people. If you dont 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 dont 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.
> :arrow_right: *[http://keepachangelog.com](http://keepachangelog.com)* > :copyright: *[http://keepachangelog.com](http://keepachangelog.com/)*
## Installation ## Installation
@@ -45,7 +45,7 @@ Because software tools are for people. If you dont care, why are you contribu
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)
> >
@@ -67,25 +67,25 @@ Because software tools are for people. If you dont care, why are you contribu
## Usage ## Usage
**It's really simple!** **It's really simple**:
- If your **`git remote`** `origin` refers to your GitHub repo, 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, run this 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`
This generates a changelog to the `CHANGELOG.md` file, with pretty markdown formatting. 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.
For more details about params, read the 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)
### Params File ### Params File
In your project root, you can put a params file named `.github_changelog_generator` to override default params: You can put Params in a .github_changelog_generator file in Project Root to override default params:
Example: Example:
``` ```
@@ -96,41 +96,36 @@ since-tag=1.0.0
### GitHub token ### GitHub token
GitHub only allows only 50 unauthenticated requests per hour. Since GitHub allows you to make only 50 requests without authentication it's recommended to run this script with a token (`-t, --token` option)
Therefore, it's recommended to run this script with authentication by using a **token**.
Here's how: **You can easily [generate it here](https://github.com/settings/tokens/new?description=GitHub%20Changelog%20Generator%20token)**.
- [Generate a token here](https://github.com/settings/tokens/new?description=GitHub%20Changelog%20Generator%20token) And:
- Either:
- Run the script with `--token <your-40-digit-token>`; **OR**
- Set the `CHANGELOG_GITHUB_TOKEN` environment variable to your 40 digit token
You can set an environment variable by running the following command at the prompt, or by adding it to your shell profile (e.g., `~/.bash_profile` or `~/.zshrc`): - Run with key `-t [your-40-digit-token]`
- Or set environment variable `CHANGELOG_GITHUB_TOKEN` and specify there your token.
export CHANGELOG_GITHUB_TOKEN="«your-40-digit-github-token»" i.e. add to your `~/.bash_profile` or `~/.zshrc` or any other place to load ENV variables string :
So, if you got an error like this: export CHANGELOG_GITHUB_TOKEN="your-40-digit-github-token"
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 an hour for GitHub to reset your unauthenticated request limit.) It's time to create this token or wait for 1 hour before GitHub reset the counter for your IP.
## Migrating from a manual changelog ## Migrating from a manual changelog
Knowing how dedicated you are to your project, you probably haven't been waiting for `github-changelog-generator` to keep a changelog. Knowing how dedicated you are to your project, you probably haven't been waiting for github-changelog-generator to keep a changelog,
But you probably don't want your project's open issues and PRs for all past features listed in your historic changelog, either. but you most likely wouln't like to have to open issues and PRs for all past features listed in your historic changelog.
That's where `--base <your-manual-changelog.md>` comes in handy! That's where `--base` comes handy. This option lets you pass a static changelog to be appended at the end of the generated entries.
This option lets append your old manual changelog to the end of the generated entries.
If you have a `HISTORY.md` file in your project, it will automatically be picked as the static historical changelog and appended. If you have a `HISTORY.md` file in your project, it will automatically be picked as the static historical changelog and appended.
### Rake task ### Rake task
You love `rake`? We do, too! So, we've made it even easier for you: 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:
we've provided a `rake` task library for your changelog generation.
Just put something like this in your `Rakefile`:
```ruby ```ruby
GitHubChangelogGenerator::RakeTask.new :changelog do |config| GitHubChangelogGenerator::RakeTask.new :changelog do |config|
@@ -139,94 +134,94 @@ GitHubChangelogGenerator::RakeTask.new :changelog do |config|
end end
``` ```
All command line options can be passed to the `rake` task as `config` parameters. And since you're naming the `rake` task yourself, you can create as many as you want. 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.
## Features and advantages of this project ##Features and advantages of this project
- Generate canonical, neat change log file, followed by [basic change log guidelines](http://keepachangelog.com) :gem: - Generate canonical, neat change log file, followed by [basic change log guidelines](http://keepachangelog.com/) :gem:
- Optionally generate **Unreleased** changes (closed issues that have not released yet) :dizzy: - Possible to generate **Unreleased** changes (closed issues that have not released yet) :dizzy:
- **GitHub Enterprise support** via command line options! :factory: - **GitHub Enterprise support** via command line options! :factory:
- Flexible format **customization**: - Flexible format **customisation**:
- **Customize** issues that **should be added** to changelog :eight_spoked_asterisk: - **Customize** issues, that **should be added** to changelog :eight_spoked_asterisk:
- **Custom date formats** supported (but keep [ISO 8601](http://xkcd.com/1179/) in mind!) :date: - **Custom date format** supported (but get in mind [ISO 8601](http://xkcd.com/1179/) ) :date:
- Manually specify the version that fixed an issue (for cases when the issue's Closed date doesn't match) by giving the issue's `milestone` the same name as the tag of version :pushpin: - 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** that are irrelevant to your changelog (by default, any issue labeled `question`, `duplicate`, `invalid`, or `wontfix`) :scissors: - Automatically **exclude specific issues**, not-related to change log (any issue, that has label `question` `duplicate` `invalid` `wontfix`by default) :scissors:
- **Distinguish** issues **by labels**. :mag_right: - **Distinguish** issues **according labels**. :mag_right:
- Merged pull requests (all merged pull-requests) :twisted_rightwards_arrows: - Merged pull requests (all `merged` pull-requests) :twisted_rightwards_arrows:
- Bug fixes (issues labeled `bug`) :beetle: - Bug fixes (by label `bug` in issue) :beetle:
- Enhancements (issues labeled `enhancement`) :star2: - Enhancements (by label `enhancement` in issue) :star2:
- Issues (closed issues with no labels) :non-potable_water: - Issues (closed issues `w/o any labels`) :non-potable_water:
- Manually include or exclude issues by labels :wrench: - You can manually set which labels should be included/excluded. :wrench:
- Customize lots more! Tweak the changelog to fit your preferences :tophat: - Apply a lot of other customisations, to fit changelog for your personal style :tophat:
(*See `github_changelog_generator --help` for details)* (*look `github_changelog_generator --help` for details)*
###Alternatives ###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. 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!* *If you know other projects - feel free to edit this Wiki page!*
### Projects using this library ### Projects using this library
Here's a [wikipage list of projects](https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator). [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` to generate your project's changelog, or know of other projects using it, please [add it to this list] (https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator).* *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 the 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, and 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 a lot of people are 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:
*BTW: 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 trying to compare the quality of handwritten and auto-generated logs. That said.... I'm not try to compare quality of auto-generated and manually generated logs.. but:
An auto-generated changelog really helps, even if you manually fill in the release 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 know which release fixed it. 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`.
In this case, you can easily find the issue by \# in `CHANGELOG.md`.
- it's not quite as easy to find this in handwritten releases notes - it's not so quite easy to find it in manually filled Releases notes.
- a generated file saves you the trouble of remembering everything; - this file can also help you to build your Release note and not miss features in manually-filled list.
sometimes people forget to add things to a handwritten file
Ultimately, I think GitHub Releases is ideal for end-users. In the end:
Meanwhile, `CHANGELOG.md` lives right in the repository, with its detailed list of changes, which is handy for developers.
Finally, there's nothing wrong with using GitHub Releases alongside `CHANGELOG.md` in this combination.
- ***I received a warning: "GitHub API rate limit exceed" What does this mean?*** 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.
And it's nothing bad to combine GitHub Releases and `CHANGELOG.md` file together in that manner.
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 is only up to 60 requests per hour. Unauthenticated requests are associated with your IP address (not the user making requests). - ***I received a warning: GitHub API rate limit exceed, what does this mean?***
If you're seeing this warning, please do the following: 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.
1. Make sure you're providing an OAuth token, so you're not making requests anonymously. Using an OAuth token increases your hourly request maximum from 60 to 5000. If you're seeing this warning:
2. If you have a large repo with lots of issues/PRs, you can use `--max-issues NUM` to limit the number of issues that are pulled back. For example: `--max-issues 1000`
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`
## Contributing ## Contributing
1. Create an issue and describe 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. Publish 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:
*To test your workflow with changelog generator, you can use [test repo](https://github.com/skywinder/changelog_test/)* *To test change log workflow you can use [test repo](https://github.com/skywinder/changelog_test/)*
## License ## License

View File

@@ -1,23 +1,7 @@
require "bundler"
require "bundler/gem_tasks"
require "rubocop/rake_task" require "rubocop/rake_task"
require "rspec/core/rake_task" require "rspec/core/rake_task"
require "pathname"
require "fileutils"
require "overcommit"
RuboCop::RakeTask.new RuboCop::RakeTask.new
RSpec::Core::RakeTask.new(:rspec) RSpec::Core::RakeTask.new(:rspec)
task :create_man do |_t| task default: [:rubocop, :rspec]
os_prefix = "/usr/local"
man_prefix = Pathname("#{os_prefix}/share/man/man1")
man_pages = "man/git-*"
Pathname.glob(man_pages) do |path|
FileUtils.cp(path, man_prefix + path.basename)
end
end
task checks: [:rubocop, :rspec]
task default: [:checks, :create_man]

10
ext/mkrf_conf.rb Normal file
View File

@@ -0,0 +1,10 @@
PREFIX = "/usr/local"
MANPREFIX = "#{PREFIX}/share/man/man1"
MAN_PAGES = "man/git-*"
require "fileutils"
Dir.glob(MAN_PAGES).each do |f|
filename = File.basename(f)
FileUtils.cp(f, "#{MANPREFIX}/#{filename}")
end

View File

@@ -9,24 +9,25 @@ Gem::Specification.new do |spec|
spec.version = GitHubChangelogGenerator::VERSION spec.version = GitHubChangelogGenerator::VERSION
spec.default_executable = "github_changelog_generator" spec.default_executable = "github_changelog_generator"
spec.required_ruby_version = ">= 1.9.3" spec.required_ruby_version = ">= 1.9.3"
spec.authors = ["Petr Korolev"] spec.authors = ["Petr Korolev"]
spec.email = "sky4winder+github_changelog_generator@gmail.com" spec.email = "sky4winder+github_changelog_generator@gmail.com"
spec.date = `date +"%Y-%m-%d"`.strip! spec.date = `date +"%Y-%m-%d"`.strip!
spec.summary = "Script, that automatically generate changelog from your tags, issues, labels and pull requests." spec.summary = "Script, that automatically generate changelog from your tags, issues, labels and pull requests."
spec.description = "Changelog generation has never been so easy. Fully automate changelog generation - this gem generate change log file based on tags, issues and merged pull requests from Github issue tracker." spec.description = "Changelog generation has never been so easy. Fully automate changelog generation - this gem generate change log file based on tags, issues and merged pull requests from Github issue tracker."
spec.homepage = "https://github.com/skywinder/Github-Changelog-Generator" spec.homepage = "https://github.com/skywinder/Github-Changelog-Generator"
spec.license = "MIT" spec.license = "MIT"
spec.extensions = ["Rakefile"] spec.extensions = "ext/mkrf_conf.rb"
spec.files = `git ls-files -z`.split("\x0") spec.files = `git ls-files -z`.split("\x0")
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) } spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
spec.test_files = spec.files.grep(%r{^(test|spec|features)/}) spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
spec.require_paths = ["lib"] spec.require_paths = ["lib"]
spec.add_runtime_dependency "rake", "~> 10.0"
spec.add_runtime_dependency "bundler", "~> 1.7"
spec.add_runtime_dependency("github_api", ["~> 0.12"]) spec.add_runtime_dependency("github_api", ["~> 0.12"])
spec.add_runtime_dependency("colorize", ["~> 0.7"]) spec.add_runtime_dependency("colorize", ["~> 0.7"])
spec.add_runtime_dependency("overcommit", "~>0.31")
# Development only
spec.add_development_dependency "bundler", "~> 1.7"
spec.add_development_dependency "rake", "~> 10.0"
end end

View File

@@ -22,7 +22,6 @@
**Merged pull requests:** **Merged pull requests:**
- Merged br \(should appear in change log also\) [\#21](https://github.com/skywinder/changelog_test/pull/21) ([skywinder](https://github.com/skywinder))
- This a PR with a lot of comments and events [\#17](https://github.com/skywinder/changelog_test/pull/17) ([skywinder](https://github.com/skywinder)) - This a PR with a lot of comments and events [\#17](https://github.com/skywinder/changelog_test/pull/17) ([skywinder](https://github.com/skywinder))
- This PR closes 14 from commit [\#15](https://github.com/skywinder/changelog_test/pull/15) ([skywinder](https://github.com/skywinder)) - This PR closes 14 from commit [\#15](https://github.com/skywinder/changelog_test/pull/15) ([skywinder](https://github.com/skywinder))
- This PR to close \#12 from body [\#13](https://github.com/skywinder/changelog_test/pull/13) ([skywinder](https://github.com/skywinder)) - This PR to close \#12 from body [\#13](https://github.com/skywinder/changelog_test/pull/13) ([skywinder](https://github.com/skywinder))

View File

@@ -28,7 +28,7 @@ module GitHubChangelogGenerator
def run def run
log = @generator.compound_changelog log = @generator.compound_changelog
output_filename = (@options[:output]).to_s output_filename = "#{@options[:output]}"
File.open(output_filename, "w") { |file| file.write(log) } File.open(output_filename, "w") { |file| file.write(log) }
puts "Done!" puts "Done!"
puts "Generated log placed in #{Dir.pwd}/#{output_filename}" puts "Generated log placed in #{Dir.pwd}/#{output_filename}"

View File

@@ -18,12 +18,12 @@ module GitHubChangelogGenerator
@user = @options[:user] @user = @options[:user]
@project = @options[:project] @project = @options[:project]
@github_token = fetch_github_token @github_token = fetch_github_token
@github_options = { per_page: PER_PAGE_NUMBER } github_options = { per_page: PER_PAGE_NUMBER }
@github_options[:oauth_token] = @github_token unless @github_token.nil? github_options[:oauth_token] = @github_token unless @github_token.nil?
@github_options[:endpoint] = @options[:github_endpoint] unless @options[:github_endpoint].nil? github_options[:endpoint] = @options[:github_endpoint] unless @options[:github_endpoint].nil?
@github_options[:site] = @options[:github_endpoint] unless @options[:github_site].nil? github_options[:site] = @options[:github_endpoint] unless @options[:github_site].nil?
@github = check_github_response { Github.new @github_options } @github = check_github_response { Github.new github_options }
end end
# Returns GitHub token. First try to use variable, provided by --token option, # Returns GitHub token. First try to use variable, provided by --token option,
@@ -123,16 +123,7 @@ Make sure, that you push tags to remote repo via 'git push --tags'".yellow
def fetch_closed_pull_requests def fetch_closed_pull_requests
pull_requests = [] pull_requests = []
begin begin
response = if @options[:release_branch].nil? response = @github.pull_requests.list @options[:user], @options[:project], state: "closed"
@github.pull_requests.list @options[:user],
@options[:project],
state: "closed"
else
@github.pull_requests.list @options[:user],
@options[:project],
state: "closed",
base: @options[:release_branch]
end
page_i = 0 page_i = 0
count_pages = response.count_pages count_pages = response.count_pages
response.each_page do |page| response.each_page do |page|

View File

@@ -8,15 +8,13 @@ module GitHubChangelogGenerator
sort_tags_by_date(@filtered_tags) sort_tags_by_date(@filtered_tags)
fetch_issues_and_pr fetch_issues_and_pr
log = "" log = "#{@options[:header]}\n\n"
log += @options[:frontmatter] if @options[:frontmatter]
log += "#{@options[:header]}\n\n"
log += if @options[:unreleased_only] if @options[:unreleased_only]
generate_log_between_tags(filtered_tags[0], nil) log += generate_log_between_tags(filtered_tags[0], nil)
else else
generate_log_for_all_tags log += generate_log_for_all_tags
end end
log += File.read(@options[:base]) if File.file?(@options[:base]) log += File.read(@options[:base]) if File.file?(@options[:base])
@@ -39,10 +37,10 @@ module GitHubChangelogGenerator
index2 = hash[tag2] index2 = hash[tag2]
log += generate_log_between_tags(all_tags[index1], all_tags[index2]) log += generate_log_between_tags(all_tags[index1], all_tags[index2])
else else
raise ChangelogGeneratorError, "Can't find tag #{tag2} -> exit".red fail ChangelogGeneratorError, "Can't find tag #{tag2} -> exit".red
end end
else else
raise ChangelogGeneratorError, "Can't find tag #{tag1} -> exit".red fail ChangelogGeneratorError, "Can't find tag #{tag1} -> exit".red
end end
log log
end end
@@ -79,16 +77,16 @@ 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
release_url = if @options[:release_url] if @options[:release_url]
format(@options[:release_url], newer_tag_link) release_url = format(@options[:release_url], newer_tag_link)
else else
"#{project_url}/tree/#{newer_tag_link}" release_url = "#{project_url}/tree/#{newer_tag_link}"
end end
log += if newer_tag_name.equal? @options[:unreleased_label] if newer_tag_name.equal? @options[:unreleased_label]
"## [#{newer_tag_name}](#{release_url})\n\n" log += "## [#{newer_tag_name}](#{release_url})\n\n"
else else
"## [#{newer_tag_name}](#{release_url}) (#{time_string})\n" 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
# Generate compare link # Generate compare link
@@ -171,11 +169,11 @@ module GitHubChangelogGenerator
unless issue.pull_request.nil? unless issue.pull_request.nil?
if @options[:author] if @options[:author]
title_with_number += if issue.user.nil? if issue.user.nil?
" ({Null user})" title_with_number += " ({Null user})"
else else
" ([#{issue.user.login}](#{issue.user.html_url}))" title_with_number += " ([#{issue.user.login}](#{issue.user.html_url}))"
end end
end end
end end
title_with_number title_with_number

View File

@@ -7,7 +7,7 @@ module GitHubChangelogGenerator
unless @options[:exclude_labels].nil? unless @options[:exclude_labels].nil?
issues = issues.select do |issue| issues = issues.select do |issue|
var = issue.labels.map(&:name) & @options[:exclude_labels] var = issue.labels.map(&:name) & @options[:exclude_labels]
!var.any? !(var).any?
end end
end end
issues issues
@@ -83,7 +83,7 @@ module GitHubChangelogGenerator
tag_in_range_new = tag_older_new_tag?(newer_tag_time, time) tag_in_range_new = tag_older_new_tag?(newer_tag_time, time)
tag_in_range = tag_in_range_old && tag_in_range_new tag_in_range = (tag_in_range_old) && (tag_in_range_new)
tag_in_range tag_in_range
else else
@@ -93,20 +93,20 @@ module GitHubChangelogGenerator
end end
def tag_older_new_tag?(newer_tag_time, time) def tag_older_new_tag?(newer_tag_time, time)
tag_in_range_new = if newer_tag_time.nil? if newer_tag_time.nil?
true tag_in_range_new = true
else else
time <= newer_tag_time tag_in_range_new = time <= newer_tag_time
end end
tag_in_range_new tag_in_range_new
end end
def tag_newer_old_tag?(older_tag_time, t) def tag_newer_old_tag?(older_tag_time, t)
tag_in_range_old = if older_tag_time.nil? if older_tag_time.nil?
true tag_in_range_old = true
else else
t > older_tag_time tag_in_range_old = t > older_tag_time
end end
tag_in_range_old tag_in_range_old
end end
@@ -133,7 +133,7 @@ module GitHubChangelogGenerator
def filter_by_include_labels(issues) def filter_by_include_labels(issues)
filtered_issues = @options[:include_labels].nil? ? issues : issues.select do |issue| filtered_issues = @options[:include_labels].nil? ? issues : issues.select do |issue|
labels = issue.labels.map(&:name) & @options[:include_labels] labels = issue.labels.map(&:name) & @options[:include_labels]
labels.any? (labels).any?
end end
filtered_issues filtered_issues
end end
@@ -178,10 +178,8 @@ module GitHubChangelogGenerator
fetched_pr = closed_pull_requests.find do |fpr| fetched_pr = closed_pull_requests.find do |fpr|
fpr.number == pr.number fpr.number == pr.number
end end
if fetched_pr pr[:merged_at] = fetched_pr[:merged_at]
pr[:merged_at] = fetched_pr[:merged_at] closed_pull_requests.delete(fetched_pr)
closed_pull_requests.delete(fetched_pr)
end
end end
pull_requests.select! do |pr| pull_requests.select! do |pr|

View File

@@ -19,7 +19,7 @@ module GitHubChangelogGenerator
# @param [Hash] tag_name name of the tag # @param [Hash] tag_name name of the tag
# @return [Time] time of specified tag # @return [Time] time of specified tag
def get_time_of_tag(tag_name) def get_time_of_tag(tag_name)
raise ChangelogGeneratorError, "tag_name is nil".red if tag_name.nil? fail ChangelogGeneratorError, "tag_name is nil".red if tag_name.nil?
name_of_tag = tag_name["name"] name_of_tag = tag_name["name"]
time_for_name = @tag_times_hash[name_of_tag] time_for_name = @tag_times_hash[name_of_tag]
@@ -58,7 +58,7 @@ module GitHubChangelogGenerator
if @since_tag.nil? && @options[:base] && File.file?(@options[:base]) if @since_tag.nil? && @options[:base] && File.file?(@options[:base])
reader = GitHubChangelogGenerator::Reader.new reader = GitHubChangelogGenerator::Reader.new
content = reader.read(@options[:base]) content = reader.read(@options[:base])
@since_tag = content[0]["version"] if content.count && content @since_tag = content[0]["version"] if content
end end
@since_tag @since_tag
end end
@@ -80,11 +80,11 @@ module GitHubChangelogGenerator
if tag if tag
if all_tags.map(&:name).include? tag if all_tags.map(&:name).include? tag
idx = all_tags.index { |t| t.name == tag } idx = all_tags.index { |t| t.name == tag }
filtered_tags = if idx > 0 if idx > 0
all_tags[0..idx - 1] filtered_tags = all_tags[0..idx - 1]
else else
[] filtered_tags = []
end end
else else
Helper.log.warn "Warning: can't find tag #{tag}, specified with --since-tag option." Helper.log.warn "Warning: can't find tag #{tag}, specified with --since-tag option."
end end
@@ -101,11 +101,11 @@ module GitHubChangelogGenerator
if (all_tags.count > 0) && (all_tags.map(&:name).include? tag) if (all_tags.count > 0) && (all_tags.map(&:name).include? tag)
idx = all_tags.index { |t| t.name == tag } idx = all_tags.index { |t| t.name == tag }
last_index = all_tags.count - 1 last_index = all_tags.count - 1
filtered_tags = if idx > 0 && idx < last_index if idx > 0 && idx < last_index
all_tags[idx + 1..last_index] filtered_tags = all_tags[idx + 1..last_index]
else else
[] filtered_tags = []
end end
else else
Helper.log.warn "Warning: can't find tag #{tag}, specified with --due-tag option." Helper.log.warn "Warning: can't find tag #{tag}, specified with --due-tag option."
end end

View File

@@ -3,14 +3,14 @@ module GitHubChangelogGenerator
module Helper module Helper
# @return true if the currently running program is a unit test # @return true if the currently running program is a unit test
def self.test? def self.test?
defined? SpecHelper defined?SpecHelper
end end
@log ||= if test? if test?
Logger.new(nil) # don't show any logs when running tests @log ||= Logger.new(nil) # don't show any logs when running tests
else else
Logger.new(STDOUT) @log ||= Logger.new(STDOUT)
end end
@log.formatter = proc do |severity, _datetime, _progname, msg| @log.formatter = proc do |severity, _datetime, _progname, msg|
string = "#{msg}\n" string = "#{msg}\n"

View File

@@ -7,16 +7,22 @@ module GitHubChangelogGenerator
class Parser class Parser
# parse options with optparse # parse options with optparse
def self.parse_options def self.parse_options
options = default_options options = get_default_options
ParserFile.new(options).parse! parser_file = ParserFile.new options
parser_file.parse!
parser = setup_parser(options) parser = setup_parser(options)
parser.parse! parser.parse!
user_and_project_from_git(options) if options[:user].nil? || options[:project].nil?
detect_user_and_project(options, ARGV[0], ARGV[1])
end
abort(parser.banner) unless options[:user] && options[:project] if !options[:user] || !options[:project]
puts parser.banner
exit
end
print_options(options) print_options(options)
@@ -68,9 +74,6 @@ module GitHubChangelogGenerator
opts.on("--header-label [LABEL]", "Setup custom header label. Default is \"# Change Log\"") do |v| opts.on("--header-label [LABEL]", "Setup custom header label. Default is \"# Change Log\"") do |v|
options[:header] = v options[:header] = v
end end
opts.on("--front-matter [JSON]", "Add YAML front matter. Formatted as JSON because it's easier to add on the command line") do |v|
options[:frontmatter] = JSON.parse(v).to_yaml + "---\n"
end
opts.on("--pr-label [LABEL]", "Setup custom label for pull requests section. Default is \"**Merged pull requests:**\"") do |v| opts.on("--pr-label [LABEL]", "Setup custom label for pull requests section. Default is \"**Merged pull requests:**\"") do |v|
options[:merge_prefix] = v options[:merge_prefix] = v
end end
@@ -146,9 +149,6 @@ module GitHubChangelogGenerator
opts.on("--future-release [RELEASE-VERSION]", "Put the unreleased changes in the specified release number.") do |future_release| opts.on("--future-release [RELEASE-VERSION]", "Put the unreleased changes in the specified release number.") do |future_release|
options[:future_release] = future_release options[:future_release] = future_release
end end
opts.on("--release-branch [RELEASE-BRANCH]", "Limit pull requests to the release branch, such as master or release") do |release_branch|
options[:release_branch] = release_branch
end
opts.on("--[no-]verbose", "Run verbosely. Default is true") do |v| opts.on("--[no-]verbose", "Run verbosely. Default is true") do |v|
options[:verbose] = v options[:verbose] = v
end end
@@ -165,8 +165,8 @@ module GitHubChangelogGenerator
end end
# just get default options # just get default options
def self.default_options def self.get_default_options
{ options = {
tag1: nil, tag1: nil,
tag2: nil, tag2: nil,
date_format: "%Y-%m-%d", date_format: "%Y-%m-%d",
@@ -194,25 +194,21 @@ module GitHubChangelogGenerator
enhancement_prefix: "**Implemented enhancements:**", enhancement_prefix: "**Implemented enhancements:**",
git_remote: "origin" git_remote: "origin"
} }
end
def self.user_and_project_from_git(options) options
if options[:user].nil? || options[:project].nil?
detect_user_and_project(options, ARGV[0], ARGV[1])
end
end end
# Detects user and project from git # Detects user and project from git
def self.detect_user_and_project(options, arg0 = nil, arg1 = nil) def self.detect_user_and_project(options, arg0 = nil, arg1 = nil)
options[:user], options[:project] = user_project_from_option(arg0, arg1, options[:github_site]) options[:user], options[:project] = user_project_from_option(arg0, arg1, options[:github_site])
return 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" options[:project] = "changelog_test"
options[:project] = "changelog_test" else
else remote = `git config --get remote.#{options[:git_remote]}.url`
remote = `git config --get remote.#{options[:git_remote]}.url` options[:user], options[:project] = user_project_from_remote(remote)
options[:user], options[:project] = user_project_from_remote(remote) end
end end
end end
@@ -220,7 +216,7 @@ module GitHubChangelogGenerator
# #
# @param [String] output of git remote command # @param [String] output of git remote command
# @return [Array] user and project # @return [Array] user and project
def self.user_project_from_option(arg0, arg1, github_site) def self.user_project_from_option(arg0, arg1, github_site = nil)
user = nil user = nil
project = nil project = nil
github_site ||= "github.com" github_site ||= "github.com"
@@ -233,10 +229,10 @@ module GitHubChangelogGenerator
param = match[2].nil? param = match[2].nil?
rescue rescue
puts "Can't detect user and name from first parameter: '#{arg0}' -> exit'" puts "Can't detect user and name from first parameter: '#{arg0}' -> exit'"
return exit
end end
if param if param
return exit
else else
user = match[1] user = match[1]
project = match[2] project = match[2]
@@ -279,4 +275,9 @@ module GitHubChangelogGenerator
[user, project] [user, project]
end end
end end
if __FILE__ == $PROGRAM_NAME
remote = "invalid reference to project"
p user_project_from_option(ARGV[0], ARGV[1], remote)
end
end end

View File

@@ -1,6 +1,4 @@
module GitHubChangelogGenerator module GitHubChangelogGenerator
ParserError = Class.new(StandardError)
class ParserFile class ParserFile
def initialize(options) def initialize(options)
@options = options @options = options
@@ -20,11 +18,11 @@ module GitHubChangelogGenerator
def parse_line!(line) def parse_line!(line)
key_sym, value = extract_pair(line) key_sym, value = extract_pair(line)
value = true if value =~ /^(true|t|yes|y|1)$/i value = true if value =~ (/^(true|t|yes|y|1)$/i)
value = false if value =~ /^(false|f|no|n|0)$/i value = false if value =~ (/^(false|f|no|n|0)$/i)
@options[key_sym] = value @options[key_sym] = value
rescue rescue
raise ParserError, "Config file #{file} is incorrect in line \"#{line.gsub(/[\n\r]+/, '')}\"" raise "Config file #{file} is incorrect in line \"#{line.gsub(/[\n\r]+/, '')}\""
end end
# Returns a the setting as a symbol and its string value sans newlines. # Returns a the setting as a symbol and its string value sans newlines.

View File

@@ -53,28 +53,31 @@ module GitHubChangelogGenerator
@heading_structures.each do |regexp| @heading_structures.each do |regexp|
matches = Regexp.new(regexp).match(heading) matches = Regexp.new(regexp).match(heading)
if matches captures.merge!(Hash[matches.names.map.zip(matches.captures)]) unless matches.nil?
captures.merge!(Hash[matches.names.zip(matches.captures)])
break # Try Regular Expressions until you find one that delivers results
end break unless matches.nil?
end end
captures captures
end end
# Parse the given ChangeLog data into a list of Hashes # Parse the given ChangeLog data into a Hash
# #
# @param [String] data File data from the ChangeLog.md # @param [String] data File data from the ChangeLog.md
# @return [Array<Hash>] Parsed data, e.g. [{ 'version' => ..., 'url' => ..., 'date' => ..., 'content' => ...}, ...] # @return [Hash] Parsed data, e.g. [{ 'version' => ..., 'url' => ..., 'date' => ..., 'content' => ...}, ...]
def parse(data) def parse(data)
sections = data.split(/^## .+?$/) sections = data.split(/^## .+?$/)
headings = data.scan(/^## .+?$/) headings = data.scan(/^## .+?$/)
changelog = []
headings.each_with_index.map do |heading, index| headings.each_with_index do |heading, index|
section = parse_heading(heading) captures = parse_heading(heading)
section["content"] = sections.at(index + 1) captures["content"] = sections.at(index + 1)
section changelog.push captures
end end
changelog
end end
def read(file_path) def read(file_path)

View File

@@ -16,8 +16,7 @@ module GitHubChangelogGenerator
bug_labels enhancement_labels bug_labels enhancement_labels
between_tags exclude_tags since_tag max_issues between_tags exclude_tags since_tag max_issues
github_site github_endpoint simple_list github_site github_endpoint simple_list
future_release release_branch verbose release_url future_release verbose release_url base )
base )
OPTIONS.each do |o| OPTIONS.each do |o|
attr_accessor o.to_sym attr_accessor o.to_sym
@@ -37,16 +36,18 @@ module GitHubChangelogGenerator
def define(args, &task_block) def define(args, &task_block)
desc "Generate a Change log from GitHub" desc "Generate a Change log from GitHub"
yield(*[self, args].slice(0, task_block.arity)) if task_block task_block.call(*[self, args].slice(0, task_block.arity)) if task_block
# clear any (auto-)pre-existing task # clear any (auto-)pre-existing task
Rake::Task[@name].clear if Rake::Task.task_defined?(@name) Rake::Task[@name].clear if Rake::Task.task_defined?(@name)
task @name do task @name do
# mimick parse_options # mimick parse_options
options = Parser.default_options options = Parser.get_default_options
Parser.user_and_project_from_git(options) if options[:user].nil? || options[:project].nil?
Parser.detect_user_and_project(options)
end
OPTIONS.each do |o| OPTIONS.each do |o|
v = instance_variable_get("@#{o}") v = instance_variable_get("@#{o}")
@@ -57,7 +58,7 @@ module GitHubChangelogGenerator
log = generator.compound_changelog log = generator.compound_changelog
output_filename = (options[:output]).to_s output_filename = "#{options[:output]}"
File.open(output_filename, "w") { |file| file.write(log) } File.open(output_filename, "w") { |file| file.write(log) }
puts "Done!" puts "Done!"
puts "Generated log placed in #{Dir.pwd}/#{output_filename}" puts "Generated log placed in #{Dir.pwd}/#{output_filename}"

View File

@@ -1,3 +1,3 @@
module GitHubChangelogGenerator module GitHubChangelogGenerator
VERSION = "1.10.4" VERSION = "1.9.0"
end end

View File

@@ -1 +0,0 @@
exclude-labels=73a91042-da6f-11e5-9335-1040f38d7f90,7adf83b4-da6f-11e5-ae18-1040f38d7f90

View File

@@ -23,11 +23,11 @@ require "coveralls"
module SpecHelper module SpecHelper
end end
SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([ SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
Coveralls::SimpleCov::Formatter, Coveralls::SimpleCov::Formatter,
SimpleCov::Formatter::HTMLFormatter, SimpleCov::Formatter::HTMLFormatter,
CodeClimate::TestReporter::Formatter CodeClimate::TestReporter::Formatter
]) ]
SimpleCov.start SimpleCov.start
require "github_changelog_generator" require "github_changelog_generator"

View File

@@ -20,11 +20,11 @@ describe GitHubChangelogGenerator::ParserFile do
let(:options) { { params_file: "spec/files/github_changelog_params_incorrect" } } let(:options) { { params_file: "spec/files/github_changelog_params_incorrect" } }
let(:options_before_change) { options.dup } let(:options_before_change) { options.dup }
let(:parse) { GitHubChangelogGenerator::ParserFile.new(options) } let(:parse) { GitHubChangelogGenerator::ParserFile.new(options) }
it { expect { parse.parse! }.to raise_error(GitHubChangelogGenerator::ParserError) } it { expect { parse.parse! }.to raise_error }
end end
context "when override default values" do context "when override default values" do
let(:default_options) { GitHubChangelogGenerator::Parser.default_options } let(:default_options) { GitHubChangelogGenerator::Parser.get_default_options }
let(:options) { { params_file: "spec/files/github_changelog_params_override" }.merge(default_options) } let(:options) { { params_file: "spec/files/github_changelog_params_override" }.merge(default_options) }
let(:options_before_change) { options.dup } let(:options_before_change) { options.dup }
let(:parse) { GitHubChangelogGenerator::ParserFile.new(options) } let(:parse) { GitHubChangelogGenerator::ParserFile.new(options) }
@@ -36,20 +36,6 @@ describe GitHubChangelogGenerator::ParserFile do
unreleased: false, unreleased: false,
header: "=== Changelog ===")) header: "=== Changelog ==="))
end end
context "turns exclude-labels into an Array", bug: '#327' do
let(:options) do
{
params_file: "spec/files/github_changelog_params_327"
}
end
it "reads exclude_labels into an Array" do
pending("Related with Bug #327.")
expect { parse.parse! }.to change { options[:exclude_labels] }
.from(nil)
.to(["73a91042-da6f-11e5-9335-1040f38d7f90", "7adf83b4-da6f-11e5-ae18-1040f38d7f90"])
end
end
end end
end end
end end

View File

@@ -28,16 +28,16 @@ describe GitHubChangelogGenerator::Parser do
end end
describe ".user_project_from_option" do describe ".user_project_from_option" do
context "when option is invalid" do context "when option is invalid" do
it("should return nil") { expect(GitHubChangelogGenerator::Parser.user_project_from_option("blah", nil, nil)).to be_nil } it("should exit") { expect { GitHubChangelogGenerator::Parser.user_project_from_option("blah", nil) }.to raise_error(SystemExit) }
end end
context "when option is valid" do context "when option is valid" do
subject { GitHubChangelogGenerator::Parser.user_project_from_option("skywinder/ActionSheetPicker-3.0", nil, nil) } subject { GitHubChangelogGenerator::Parser.user_project_from_option("skywinder/ActionSheetPicker-3.0", nil) }
it { is_expected.to be_a(Array) } it { is_expected.to be_a(Array) }
it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) } it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
end end
context "when option nil" do context "when option nil" do
subject { GitHubChangelogGenerator::Parser.user_project_from_option(nil, nil, nil) } subject { GitHubChangelogGenerator::Parser.user_project_from_option(nil, nil) }
it { is_expected.to be_a(Array) } it { is_expected.to be_a(Array) }
it { is_expected.to match_array([nil, nil]) } it { is_expected.to match_array([nil, nil]) }
end end