Compare commits

..

104 Commits

Author SHA1 Message Date
Petr Korolev
6a51c0b435 Merge branch 'release/1.12.0' 2016-04-01 13:32:34 +03:00
Petr Korolev
7b78c3f8d0 Update gemspec to version 1.12.0 2016-04-01 13:32:32 +03:00
Petr Korolev
519ca91cd7 Merge pull request #320 from ITV/filter-tags
Added tag exclusion with a filter (string or regex)
2016-03-28 13:04:06 +03:00
Petr Korolev
2e2cc16fe3 Merge branch 'develop' 2016-03-28 13:00:18 +03:00
Petr Korolev
5c9c05ca19 fix rubocop warrnings 2016-03-28 12:59:58 +03:00
Adam
507ffdb910 put filter_excluded_tags_regex after filter_excluded_tags tests 2016-03-24 13:00:53 +00:00
Adam
21d41756b8 regex test include regex identifier 2016-03-24 13:00:02 +00:00
Adam
17ceccdd70 clean up test description 2016-03-24 12:54:19 +00:00
Adam
61ec650801 refactor 2016-03-24 12:40:42 +00:00
Adam
6a0ade1194 refactor 2016-03-24 12:22:33 +00:00
Adam
e5a619b167 add test for #filter_excluded_tags_regex with non-matching regex in exclude_tags 2016-03-24 12:06:39 +00:00
Adam
dd149d7ad9 implement #filter_excluded_tags_regex with regex exclude_tags 2016-03-24 11:59:20 +00:00
Petr Korolev
1c37268c3d Merge branch 'hotfix/update-changelog' into develop 2016-03-22 14:38:51 +02:00
Petr Korolev
92a2e47436 Merge branch 'hotfix/update-changelog' 2016-03-22 14:38:50 +02:00
Petr Korolev
cdc971e86f Update changelog for version 1.11.8 2016-03-22 14:38:49 +02:00
Petr Korolev
84d81a6456 Merge branch 'release/1.11.8' into develop 2016-03-22 14:38:02 +02:00
Petr Korolev
61bfba69c5 Merge branch 'release/1.11.8' 2016-03-22 14:38:02 +02:00
Petr Korolev
11d85bff41 Update gemspec to version 1.11.8 2016-03-22 14:37:59 +02:00
Petr Korolev
944ad69092 Merge pull request #360 from olleolleolle/feature/avoid-git-in-gemspec
Replace shelling-out-to-Git w/ Dir call
2016-03-22 14:27:32 +02:00
Petr Korolev
c798266695 Merge pull request #356 from olleolleolle/feature/drop-extension-building-on-gem-install
On gem install, do not try to copy manpage files in the "extensions" step
2016-03-22 14:27:25 +02:00
Olle Jonsson
170eb40f33 Replace shelling-out-to-Git w/ Dir call 2016-03-21 22:43:19 +01:00
Petr Korolev
6d9fcf202e Merge pull request #358 from olleolleolle/feature/parserfile-allow-comments
ParserFile: Allow comments in settings file
2016-03-21 13:50:07 +02:00
Olle Jonsson
0fccc4396f ParserFile: Config format allows empty lines
- defined as: lines that consist only of whitespace
2016-03-19 17:12:30 +01:00
Olle Jonsson
068af037f5 Spec: use RSpec contexts 2016-03-19 16:54:13 +01:00
Olle Jonsson
4569fad479 ParserFile: Allow comments in settings file
- Ruby-style or semi-colon-style accepted
2016-03-19 16:50:39 +01:00
Olle Jonsson
c5a92b71b2 Merge pull request #357 from olleolleolle/feature/spec-allow-file-object-for-parsefile
ParserFile: fail parsing with config file line number; use a File instead of a filename
2016-03-19 16:32:24 +01:00
Olle Jonsson
7c2b95d24b ParserFile: shorter error message due to context 2016-03-19 16:17:10 +01:00
Olle Jonsson
1a289c872d ParserFile: rename private method 2016-03-19 16:09:34 +01:00
Olle Jonsson
6b64d4e4a2 Docs 2016-03-19 15:50:05 +01:00
Olle Jonsson
0b32484184 Spec: rename local to noun 2016-03-19 15:22:45 +01:00
Olle Jonsson
a997d2417d Spec: Config parse fail message tested 2016-03-19 15:20:48 +01:00
Olle Jonsson
29b5ef3d53 ParserFile: config failure line number 2016-03-19 15:18:20 +01:00
Olle Jonsson
2e8e2a62e1 ParserFile: removed public method 2016-03-19 15:13:12 +01:00
Olle Jonsson
15d92cea45 ParserFile: Drop unused public method 2016-03-19 15:09:08 +01:00
Olle Jonsson
93df2d5646 ParserFile: use a File instead of a filename
- spec: can use StringIOs instead of loose files
2016-03-19 13:59:58 +01:00
Olle Jonsson
deba7efa49 On install, do not try to copy manpage files 2016-03-19 10:30:33 +01:00
Olle Jonsson
f9ad19285e Merge pull request #355 from olleolleolle/refactor/name-constant-irregular-options
Refactor: call it option_name, instead of key_sym
2016-03-19 09:46:09 +01:00
Olle Jonsson
5071b596d2 Refactor: call it option_name
- also, add a IRREGULAR_OPTIONS hash
2016-03-19 09:40:42 +01:00
Olle Jonsson
9150cdc09e Merge pull request #354 from olleolleolle/bugfix/351-exclude_tags
Parse options file options into arrays, integers, flags, and other
2016-03-18 08:59:15 +01:00
Olle Jonsson
669ac73466 Merge pull request #353 from jkeiser/jk/maybe-failure
Add a `bundle install` test
2016-03-18 07:27:32 +01:00
Olle Jonsson
c6b12454d9 Merge pull request #345 from skywinder/docs/readme-add-github-token-scope-to-readme
README: Document GitHub token URI scope
2016-03-17 21:53:33 +01:00
Olle Jonsson
1519d16cef README: only document how to use &scopes=repo 2016-03-17 21:50:14 +01:00
Olle Jonsson
655aa965a7 Spec: option name translation tested 2016-03-17 21:38:28 +01:00
Olle Jonsson
d0bd44e0c8 Translate option names 2016-03-17 21:08:17 +01:00
Olle Jonsson
44bbd9ca01 Parse options file options
- this proof-of-concept code duplicates OptionParser information to
   get something going
 - take care to respect the type of each option from the OptionParser
2016-03-17 20:39:49 +01:00
John Keiser
a7ee304f20 Add bundle install test 2016-03-09 10:37:25 -08:00
Olle Jonsson
42b3955c06 Merge pull request #350 from Arcanemagus/add-appveyor
Add an AppVeyor config
2016-03-05 00:43:49 +01:00
Landon Abney
9cb03fa745 Add an AppVeyor config 2016-03-04 15:38:23 -08:00
Petr Korolev
1391eefcd8 Merge branch 'hotfix/update-changelog' into develop 2016-03-04 12:05:35 +02:00
Petr Korolev
8e659072e8 Merge branch 'hotfix/update-changelog' 2016-03-04 12:05:34 +02:00
Petr Korolev
ce68ab3685 Update changelog for version 1.11.7 2016-03-04 12:05:33 +02:00
Petr Korolev
d53bba3939 Merge branch 'release/1.11.7' into develop 2016-03-04 12:04:50 +02:00
Petr Korolev
18aea22cd6 Merge branch 'release/1.11.7' 2016-03-04 12:04:50 +02:00
Petr Korolev
ce97e212c2 Update gemspec to version 1.11.7 2016-03-04 12:04:47 +02:00
Petr Korolev
cd53e1cd9a Merge branch 'master' into develop 2016-03-04 12:03:54 +02:00
Olle Jonsson
677b0d8c50 Merge pull request #347 from skywinder/add-authors
Add Olle Jonsson as co-author
2016-03-02 08:29:57 +01:00
Petr Korolev
8df1bbad13 Add Olle Jonsson as co-author 2016-03-02 09:12:47 +02:00
Petr Korolev
86386ff7e6 Merge pull request #346 from skywinder/fix/gemspec-default-date
Gemspec, default date
2016-03-02 09:08:14 +02:00
Olle Jonsson
197a438c09 Gemspec, default date 2016-03-02 06:27:11 +01:00
Petr Korolev
8caa577686 Merge branch 'hotfix/update-changelog' into develop 2016-03-01 16:44:17 +02:00
Petr Korolev
d188facd92 Merge branch 'hotfix/update-changelog' 2016-03-01 16:44:16 +02:00
Petr Korolev
f5bdd30d47 Update changelog for version 1.11.6 2016-03-01 16:44:15 +02:00
Petr Korolev
edb1fade20 Merge branch 'release/1.11.6' into develop 2016-03-01 16:43:30 +02:00
Petr Korolev
542a0948fc Merge branch 'release/1.11.6' 2016-03-01 16:43:30 +02:00
Petr Korolev
aaa71d1ed0 Update gemspec to version 1.11.6 2016-03-01 16:43:27 +02:00
Petr Korolev
11ea9eccb1 Merge pull request #343 from skywinder/feature/skip-date-in-gemspec
Gemspec: Calculate date using Date stdlib
2016-03-01 16:23:29 +02:00
Olle Jonsson
7ab1ee1c21 Gemspec: Use Ruby to calculate YYYY-MM-DD date 2016-03-01 14:54:59 +01:00
Petr Korolev
6fa2f2701e Merge branch 'hotfix/update-changelog' into develop 2016-03-01 11:19:55 +02:00
Petr Korolev
2bdaf31da7 Merge branch 'hotfix/update-changelog' 2016-03-01 11:19:54 +02:00
Petr Korolev
6e8a9cb6ce Update changelog for version 1.11.5 2016-03-01 11:19:52 +02:00
Petr Korolev
867337b58e Merge branch 'release/1.11.5' into develop 2016-03-01 11:19:07 +02:00
Petr Korolev
4687b0b025 Merge branch 'release/1.11.5' 2016-03-01 11:19:06 +02:00
Petr Korolev
eca1ffa418 Update gemspec to version 1.11.5 2016-03-01 11:19:03 +02:00
Olle Jonsson
7d92087f4a Merge pull request #341 from skywinder/Fix/return-not-allowed-in-block
Update Rakefile to avoid install-breaking bug
2016-02-29 17:34:52 +01:00
Olle Jonsson
f1a6a79865 Merge pull request #344 from jkeiser/jk/travis-clean-install
Test clean install in Travis
2016-02-29 17:33:49 +01:00
John Keiser
5b46a24f0b Test clean install in Travis 2016-02-29 08:27:30 -08:00
Olle Jonsson
2a1e7daa1d Skip date in gemspec 2016-02-29 15:35:17 +01:00
Olle Jonsson
c76cfd1920 Update Rakefile 2016-02-28 22:13:23 +01:00
Petr Korolev
d3ea8a1b0c Merge branch 'hotfix/update-changelog' into develop 2016-02-26 13:18:58 +02:00
Petr Korolev
7ea80547c5 Merge branch 'hotfix/update-changelog' 2016-02-26 13:18:58 +02:00
Petr Korolev
b4dcd8a0d9 Update changelog for version 1.11.4 2016-02-26 13:18:56 +02:00
Petr Korolev
3d13f9c4b3 Merge branch 'release/1.11.4' into develop 2016-02-26 13:18:14 +02:00
Petr Korolev
76df82fe0b Merge branch 'release/1.11.4' 2016-02-26 13:18:14 +02:00
Petr Korolev
12734dbbe1 Update gemspec to version 1.11.4 2016-02-26 13:18:11 +02:00
Olle Jonsson
d33dcced8f Rake task: enable the default task again 2016-02-26 13:17:54 +02:00
Olle Jonsson
4a9f6fdd43 Gemfile now with test deps, too 2016-02-26 13:17:54 +02:00
Olle Jonsson
32f14e685b Rake task: Try finding a writable manpath
- OS X, Ubuntu manpath files checked
2016-02-26 13:17:54 +02:00
Olle Jonsson
85d5352e6e Look in /etc/manpaths for writable paths 2016-02-26 13:17:54 +02:00
Olle Jonsson
637de14699 Check if man path is writable before writing 2016-02-26 13:17:54 +02:00
Olle Jonsson
925f6fd3f0 Man page copying: only copy .1
- check if possible first
2016-02-26 13:17:54 +02:00
Petr Korolev
568db9e519 Merge pull request #338 from olleolleolle/feature/neutralize-man-page-generation
Man page copying: only copy .1
2016-02-26 13:17:19 +02:00
Olle Jonsson
9b7273f009 Rake task: enable the default task again 2016-02-25 20:29:01 +01:00
Olle Jonsson
08cacdc5ec Gemfile now with test deps, too 2016-02-25 20:26:03 +01:00
Olle Jonsson
159173d86a Rake task: Try finding a writable manpath
- OS X, Ubuntu manpath files checked
2016-02-25 20:13:32 +01:00
Olle Jonsson
c111488376 Look in /etc/manpaths for writable paths 2016-02-25 19:56:25 +01:00
Olle Jonsson
5bc90a32ae Check if man path is writable before writing 2016-02-25 19:43:10 +01:00
Olle Jonsson
772e403e40 Man page copying: only copy .1
- check if possible first
2016-02-25 19:43:10 +01:00
Petr Korolev
fe2162030b Merge branch 'hotfix/update-changelog' into develop 2016-02-25 20:20:15 +02:00
Petr Korolev
ee86b35068 Merge branch 'hotfix/update-changelog' 2016-02-25 20:20:15 +02:00
Petr Korolev
93e29e8e81 Update changelog for version 1.11.3 2016-02-25 20:20:15 +02:00
Petr Korolev
5bff64de19 Merge branch 'release/1.11.3' into develop 2016-02-25 20:18:23 +02:00
soundstep
1bae4ea204 filter-tags - Rename option. 2016-01-22 15:11:12 +00:00
soundstep
a676650993 filter-tags - Remove unused index. 2016-01-22 13:34:24 +00:00
soundstep
40dec5346b filter-tags - Added capability to exclude tags with a regular expression by filtering names. 2016-01-22 13:32:31 +00:00
20 changed files with 350 additions and 81 deletions

6
.gitignore vendored
View File

@@ -1 +1,7 @@
bin/
!bin/git-generate-changelog
!bin/github_changelog_generator
pkg/
coverage/
.bundle
spec/*.lock

View File

@@ -1,12 +1,23 @@
sudo: false
cache:
- bundler
language: ruby
before_install:
- gem update --system
- gem install bundler
- gem update --system
- gem install bundler
rvm:
- 2.1.0
script:
- bundle exec rake checks
- 2.1
script: bundle exec rake checks
matrix:
include:
# Test install on clean system
- install: true
script:
- gem build github_changelog_generator
- gem install *.gem
- install: true
script:
- gem build github_changelog_generator
- bundle install --gemfile spec/install-gem-in-bundler.gemfile
notifications:
email:
recipients:

View File

@@ -1,5 +1,81 @@
# Change Log
## [1.11.8](https://github.com/skywinder/github-changelog-generator/tree/1.11.8) (2016-03-22)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.11.7...1.11.8)
**Implemented enhancements:**
- ParserFile: Allow comments in settings file [\#358](https://github.com/skywinder/github-changelog-generator/pull/358) ([olleolleolle](https://github.com/olleolleolle))
**Fixed bugs:**
- Error when specifying exclude\_labels [\#327](https://github.com/skywinder/github-changelog-generator/issues/327)
- Parse options file options into arrays, integers, flags, and other [\#354](https://github.com/skywinder/github-changelog-generator/pull/354) ([olleolleolle](https://github.com/olleolleolle))
**Closed issues:**
- Installation fails on Ubuntu [\#352](https://github.com/skywinder/github-changelog-generator/issues/352)
- Test installing on Windows: use AppVeyor [\#348](https://github.com/skywinder/github-changelog-generator/issues/348)
- Can't run under RubyGems 2.5.1 and Ruby 2.3.0 [\#325](https://github.com/skywinder/github-changelog-generator/issues/325)
- Ruby 2.3.0 - Deprecation warning: Github::ResponseWrapper\#respond\_to?\(:to\_ary\) is old fashion which takes only one parameter [\#323](https://github.com/skywinder/github-changelog-generator/issues/323)
- between-tags and exclude-tags do not work in .github\_changelog\_generator [\#317](https://github.com/skywinder/github-changelog-generator/issues/317)
- Add a "documentation" label [\#284](https://github.com/skywinder/github-changelog-generator/issues/284)
**Merged pull requests:**
- Replace shelling-out-to-Git w/ Dir call [\#360](https://github.com/skywinder/github-changelog-generator/pull/360) ([olleolleolle](https://github.com/olleolleolle))
- ParserFile: fail parsing with config file line number; use a File instead of a filename [\#357](https://github.com/skywinder/github-changelog-generator/pull/357) ([olleolleolle](https://github.com/olleolleolle))
- On gem install, do not try to copy manpage files in the "extensions" step [\#356](https://github.com/skywinder/github-changelog-generator/pull/356) ([olleolleolle](https://github.com/olleolleolle))
- Refactor: call it option\_name, instead of key\_sym [\#355](https://github.com/skywinder/github-changelog-generator/pull/355) ([olleolleolle](https://github.com/olleolleolle))
- Add a `bundle install` test [\#353](https://github.com/skywinder/github-changelog-generator/pull/353) ([jkeiser](https://github.com/jkeiser))
- Add an AppVeyor config [\#350](https://github.com/skywinder/github-changelog-generator/pull/350) ([Arcanemagus](https://github.com/Arcanemagus))
- README: Document GitHub token URI scope [\#345](https://github.com/skywinder/github-changelog-generator/pull/345) ([olleolleolle](https://github.com/olleolleolle))
## [1.11.7](https://github.com/skywinder/github-changelog-generator/tree/1.11.7) (2016-03-04)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.11.6...1.11.7)
**Merged pull requests:**
- Add Olle Jonsson as co-author [\#347](https://github.com/skywinder/github-changelog-generator/pull/347) ([skywinder](https://github.com/skywinder))
- Gemspec, default date [\#346](https://github.com/skywinder/github-changelog-generator/pull/346) ([olleolleolle](https://github.com/olleolleolle))
## [1.11.6](https://github.com/skywinder/github-changelog-generator/tree/1.11.6) (2016-03-01)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.11.5...1.11.6)
**Fixed bugs:**
- Can't build on Windows [\#340](https://github.com/skywinder/github-changelog-generator/issues/340)
**Closed issues:**
- install error "Not a git repository" [\#339](https://github.com/skywinder/github-changelog-generator/issues/339)
**Merged pull requests:**
- Gemspec: Calculate date using Date stdlib [\#343](https://github.com/skywinder/github-changelog-generator/pull/343) ([olleolleolle](https://github.com/olleolleolle))
## [1.11.5](https://github.com/skywinder/github-changelog-generator/tree/1.11.5) (2016-03-01)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.11.4...1.11.5)
**Merged pull requests:**
- Test clean install in Travis [\#344](https://github.com/skywinder/github-changelog-generator/pull/344) ([jkeiser](https://github.com/jkeiser))
- Update Rakefile to avoid install-breaking bug [\#341](https://github.com/skywinder/github-changelog-generator/pull/341) ([olleolleolle](https://github.com/olleolleolle))
## [1.11.4](https://github.com/skywinder/github-changelog-generator/tree/1.11.4) (2016-02-26)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.11.3...1.11.4)
**Merged pull requests:**
- Man page copying: only copy .1 [\#338](https://github.com/skywinder/github-changelog-generator/pull/338) ([olleolleolle](https://github.com/olleolleolle))
## [1.11.3](https://github.com/skywinder/github-changelog-generator/tree/1.11.3) (2016-02-25)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.11.2...1.11.3)
**Closed issues:**
- Cannot install gem [\#335](https://github.com/skywinder/github-changelog-generator/issues/335)
## [1.11.2](https://github.com/skywinder/github-changelog-generator/tree/1.11.2) (2016-02-25)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.11.1...1.11.2)

View File

@@ -3,6 +3,10 @@ source "https://rubygems.org"
gemspec
group :test do
gem "rake"
gem "bundler"
gem "rubocop"
gem "overcommit"
gem "coveralls", "~>0.8", require: false
gem "simplecov", "~>0.10", require: false
gem "codeclimate-test-reporter", "~>0.4"

View File

@@ -1,7 +1,7 @@
PATH
remote: .
specs:
github_changelog_generator (1.11.2)
github_changelog_generator (1.11.8)
bundler (>= 1.7)
colorize (~> 0.7)
github_api (~> 0.12)
@@ -17,10 +17,10 @@ GEM
ast (2.2.0)
childprocess (0.5.9)
ffi (~> 1.0, >= 1.0.11)
codeclimate-test-reporter (0.4.8)
codeclimate-test-reporter (0.5.0)
simplecov (>= 0.7.1, < 1.0.0)
colorize (0.7.7)
coveralls (0.8.11)
coveralls (0.8.13)
json (~> 1.8)
simplecov (~> 0.11.0)
term-ansicolor (~> 1.3)
@@ -61,12 +61,12 @@ GEM
powerpack (0.1.1)
rack (1.6.4)
rainbow (2.1.0)
rake (10.5.0)
rake (11.0.1)
rspec (3.4.0)
rspec-core (~> 3.4.0)
rspec-expectations (~> 3.4.0)
rspec-mocks (~> 3.4.0)
rspec-core (3.4.3)
rspec-core (3.4.4)
rspec-support (~> 3.4.0)
rspec-expectations (3.4.0)
diff-lcs (>= 1.2.0, < 2.0)
@@ -75,12 +75,12 @@ GEM
diff-lcs (>= 1.2.0, < 2.0)
rspec-support (~> 3.4.0)
rspec-support (3.4.1)
rubocop (0.37.2)
parser (>= 2.3.0.4, < 3.0)
rubocop (0.38.0)
parser (>= 2.3.0.6, < 3.0)
powerpack (~> 0.1)
rainbow (>= 1.99.1, < 3.0)
ruby-progressbar (~> 1.7)
unicode-display_width (~> 0.3)
unicode-display_width (~> 1.0, >= 1.0.1)
ruby-progressbar (1.7.5)
simplecov (0.11.2)
docile (~> 1.1.0)
@@ -92,15 +92,19 @@ GEM
thor (0.19.1)
thread_safe (0.3.5)
tins (1.6.0)
unicode-display_width (0.3.1)
unicode-display_width (1.0.1)
PLATFORMS
ruby
DEPENDENCIES
bundler
codeclimate-test-reporter (~> 0.4)
coveralls (~> 0.8)
github_changelog_generator!
overcommit
rake
rubocop
simplecov (~> 0.10)
BUNDLED WITH

View File

@@ -101,7 +101,7 @@ Therefore, it's recommended to run this script with authentication by using a **
Here's how:
- [Generate a token 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) - you only need "repo" scope for private repositories
- Either:
- Run the script with `--token <your-40-digit-token>`; **OR**
- Set the `CHANGELOG_GITHUB_TOKEN` environment variable to your 40 digit token

View File

@@ -9,15 +9,31 @@ require "overcommit"
RuboCop::RakeTask.new
RSpec::Core::RakeTask.new(:rspec)
task :create_man do |_t|
os_prefix = "/usr/local"
man_prefix = Pathname("#{os_prefix}/share/man/man1")
man_pages = "man/git-*"
task :copy_man_page_to_manpath do |_t|
known_manpath_paths = %w(/etc/manpath.config /etc/manpaths)
manpath = known_manpath_paths.find do |f|
path = Pathname(f)
path.file? && path.readable?
end
next unless manpath
writable_man_path = Pathname(manpath).each_line.find do |line|
path = Pathname(line.chomp)
path.directory? && path.writable?
end
next unless writable_man_path
man_prefix = Pathname("#{writable_man_path.chomp}/man1")
man_pages = "man/git-*.1"
Pathname.glob(man_pages) do |path|
if path.exist? && man_prefix.exist? && man_prefix.writable?
FileUtils.cp(path, man_prefix + path.basename)
end
end
end
task checks: [:rubocop, :rspec]
task default: [:create_man]
task default: [:copy_man_page_to_manpath]

50
appveyor.yml Normal file
View File

@@ -0,0 +1,50 @@
version: "{build}"
platform: x64
branches:
only:
- master
clone_depth: 10
skip_tags: true
# See here for Ruby versions pre-installed:
# http://www.appveyor.com/docs/installed-software#ruby
environment:
matrix:
- ruby_version: "21" # Older version, but matches Travis-CI
- ruby_version: "21-x64"
install:
- SET PATH=C:\Ruby%ruby_version%\bin;%PATH%
# Print version and location for pre-installed ruby
- ruby --version
- where ruby
# Install latest version of RubyGems
- gem update --system --no-document --no-post-install-message
- gem --version
- where gem
# Print version and location for pre-installed bundler
- bundler --version
- where bundler
build_script:
# Install ruby dependencies
- bundle install --retry 3
- bundle exec rake checks
test_script:
- gem build github_changelog_generator
- gem install *.gem
notifications:
- provider: Email
to:
- sky4winder+githubchangeloggenerator@gmail.com
on_build_success: false
on_build_status_changed: true

View File

@@ -1,5 +1,4 @@
# coding: utf-8
lib = File.expand_path("../lib", __FILE__)
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
require "github_changelog_generator/version"
@@ -10,16 +9,16 @@ Gem::Specification.new do |spec|
spec.default_executable = "github_changelog_generator"
spec.required_ruby_version = ">= 1.9.3"
spec.authors = ["Petr Korolev"]
spec.authors = ["Petr Korolev", "Olle Jonsson"]
spec.email = "sky4winder+github_changelog_generator@gmail.com"
spec.date = `date +"%Y-%m-%d"`.strip!
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.homepage = "https://github.com/skywinder/Github-Changelog-Generator"
spec.license = "MIT"
#spec.extensions = ["Rakefile"]
spec.files = `git ls-files -z`.split("\x0")
spec.files = Dir["{bin,lib,man,spec}/**/*", "Rakefile", "README.md"]
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
spec.require_paths = ["lib"]

View File

@@ -129,26 +129,34 @@ module GitHubChangelogGenerator
end
# @param [Array] all_tags all tags
# @return [Array] filtered tags according :exclude_tags option
# @return [Array] filtered tags according :exclude_tags or :exclude_tags_regex option
def filter_excluded_tags(all_tags)
return all_tags unless @options[:exclude_tags]
if @options[:exclude_tags]
apply_exclude_tags(all_tags)
elsif @options[:exclude_tags_regex]
apply_exclude_tags_regex(all_tags)
else
all_tags
end
end
private
def apply_exclude_tags(all_tags)
if @options[:exclude_tags].is_a?(Regexp)
filter_tags_with_regex(all_tags)
filter_tags_with_regex(all_tags, @options[:exclude_tags])
else
filter_exact_tags(all_tags)
end
end
def filter_tags_with_regex(all_tags)
def apply_exclude_tags_regex(all_tags)
filter_tags_with_regex(all_tags, Regexp.new(@options[:exclude_tags_regex]))
end
def filter_tags_with_regex(all_tags, regex)
warn_if_nonmatching_regex(all_tags)
all_tags.reject { |tag| @options[:exclude_tags] =~ tag.name }
all_tags.reject { |tag| regex =~ tag.name }
end
def filter_exact_tags(all_tags)

View File

@@ -122,6 +122,9 @@ module GitHubChangelogGenerator
opts.on("--exclude-tags x,y,z", Array, "Change log will exclude specified tags") do |list|
options[:exclude_tags] = list
end
opts.on("--exclude-tags-regex [REGEX]", "Apply a regular expression on tag names so that they can be excluded, for example: --exclude-tags-regex \".*\+\d{1,}\" ") do |last|
options[:exclude_tags_regex] = last
end
opts.on("--since-tag x", "Change log will start after specified tag") do |v|
options[:since_tag] = v
end

View File

@@ -3,34 +3,59 @@ require "pathname"
module GitHubChangelogGenerator
ParserError = Class.new(StandardError)
# ParserFile is a configuration file reader which sets options in the
# given Hash.
#
# In your project's root, you can put a file named
# <tt>.github_changelog_generator</tt> to override defaults.
#
# Example:
# header_label=# My Super Changelog
# ; Comments are allowed
# future-release=5.0.0
# # Ruby-style comments, too
# since-tag=1.0.0
#
# The configuration format is <tt>some-key=value</tt> or <tt>some_key=value</tt>.
#
class ParserFile
FILENAME = ".github_changelog_generator"
def initialize(options)
# @param options [Hash] options to be configured from file contents
# @param file [nil,IO] configuration file handle, defaults to opening `.github_changelog_generator`
def initialize(options, file = open_settings_file)
@options = options
@file = file
end
# Destructively change @options using data in configured options file.
# Sets options using configuration file content
def parse!
file.each_line { |line| parse_line!(line) } if file.exist?
return unless @file
@file.each_with_index { |line, i| parse_line!(line, i + 1) }
@file.close
end
private
def file
@file ||= Pathname(File.expand_path(@options[:params_file] || FILENAME))
FILENAME = ".github_changelog_generator"
def open_settings_file
path = Pathname(File.expand_path(FILENAME))
File.open(path) if path.exist?
end
def parse_line!(line)
key_sym, value = extract_pair(line)
value = true if value =~ /^(true|t|yes|y|1)$/i
value = false if value =~ /^(false|f|no|n|0)$/i
@options[key_sym] = value
def parse_line!(line, line_number)
return if non_configuration_line?(line)
option_name, value = extract_pair(line)
@options[option_key_for(option_name)] = convert_value(value, option_name)
rescue
raise ParserError, "Config file #{file} is incorrect in line \"#{line.gsub(/[\n\r]+/, '')}\""
raise ParserError, "Failed on line ##{line_number}: \"#{line.gsub(/[\n\r]+/, '')}\""
end
# Returns a the setting as a symbol and its string value sans newlines.
# Returns true if the line starts with a pound sign or a semi-colon.
def non_configuration_line?(line)
line =~ /^[\#;]/ || line =~ /^[\s]+$/
end
# Returns a the option name as a symbol and its string value sans newlines.
#
# @param line [String] unparsed line from config file
# @return [Array<Symbol, String>]
@@ -38,5 +63,41 @@ module GitHubChangelogGenerator
key, value = line.split("=", 2)
[key.sub("-", "_").to_sym, value.gsub(/[\n\r]+/, "")]
end
KNOWN_ARRAY_KEYS = [:exclude_labels, :include_labels, :bug_labels,
:enhancement_labels, :between_tags, :exclude_tags]
KNOWN_INTEGER_KEYS = [:max_issues]
def convert_value(value, option_name)
if KNOWN_ARRAY_KEYS.include?(option_name)
value.split(",")
elsif KNOWN_INTEGER_KEYS.include?(option_name)
value.to_i
elsif value =~ /^(true|t|yes|y|1)$/i
true
elsif value =~ /^(false|f|no|n|0)$/i
false
else
value
end
end
IRREGULAR_OPTIONS = {
bugs_label: :bug_prefix,
enhancement_label: :enhancement_prefix,
issues_label: :issue_prefix,
header_label: :header,
front_matter: :frontmatter,
pr_label: :merge_prefix,
issues_wo_labels: :add_issues_wo_labels,
pr_wo_labels: :add_pr_wo_labels,
pull_requests: :pulls,
filter_by_milestone: :filter_issues_by_milestone,
github_api: :github_endpoint
}
def option_key_for(option_name)
IRREGULAR_OPTIONS.fetch(option_name) { option_name }
end
end
end

View File

@@ -1,3 +1,3 @@
module GitHubChangelogGenerator
VERSION = "1.11.3"
VERSION = "1.12.0"
end

View File

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

View File

@@ -1,2 +0,0 @@
unreleased_label: staging
unreleased: false

View File

@@ -1,3 +0,0 @@
unreleased_label=staging
unreleased=false
header==== Changelog ===

View File

@@ -0,0 +1,3 @@
source "https://rubygems.org"
gem "github_changelog_generator", path: Dir.glob("../pkg/github_changelog_generator-*.gem")[0]

View File

@@ -76,31 +76,47 @@ describe GitHubChangelogGenerator::Generator do
describe "#filter_excluded_tags" do
subject { generator.filter_excluded_tags(tags_mash_from_strings(%w(1 2 3))) }
context "with valid excluded tags" do
context "with matching string" do
let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: %w(3)) }
it { is_expected.to be_a Array }
it { is_expected.to match_array(tags_mash_from_strings(%w(1 2))) }
end
context "with invalid excluded tags" do
context "with non-matching string" do
let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: %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
context "with regex exclude_tags" do
context "with matching regex" do
let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: /[23]/) }
it { is_expected.to be_a Array }
it { is_expected.to match_array(tags_mash_from_strings(%w(1))) }
end
context "with non-matching regex in exclude_tags" do
context "with non-matching regex" do
let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: /[abc]/) }
it { is_expected.to be_a Array }
it { is_expected.to match_array(tags_mash_from_strings(%w(1 2 3))) }
end
end
describe "#filter_excluded_tags_regex" do
subject { generator.filter_excluded_tags(tags_mash_from_strings(%w(1 2 3))) }
context "with matching regex" do
let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags_regex: '[23]') }
it { is_expected.to be_a Array }
it { is_expected.to match_array(tags_mash_from_strings(%w(1))) }
end
context "with non-matching regex" do
let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags_regex: '[45]') }
it { is_expected.to be_a Array }
it { is_expected.to match_array(tags_mash_from_strings(%w(1 2 3))) }
end
end
describe "#filter_since_tag" do
context "with filled array" do
subject { generator.filter_since_tag(tags_mash_from_strings(%w(1 2 3))) }

View File

@@ -1,36 +1,47 @@
describe GitHubChangelogGenerator::ParserFile do
describe ".github_changelog_generator" do
context "when no has file" do
let(:options) { {} }
let(:parse) { GitHubChangelogGenerator::ParserFile.new(options) }
subject { parse.parse! }
context "when the well-known default file does not exist" do
let(:parser) { GitHubChangelogGenerator::ParserFile.new(options) }
subject { parser.parse! }
it { is_expected.to be_nil }
end
context "when file is empty" do
let(:options) { { params_file: "spec/files/github_changelog_params_empty" } }
let(:parse) { GitHubChangelogGenerator::ParserFile.new(options) }
let(:parser) { GitHubChangelogGenerator::ParserFile.new(options, StringIO.new("")) }
it "does not change the options" do
expect { parse.parse! }.to_not change { options }
expect { parser.parse! }.to_not change { options }
end
end
context "when file is incorrect" do
let(:options) { { params_file: "spec/files/github_changelog_params_incorrect" } }
let(:options_before_change) { options.dup }
let(:parse) { GitHubChangelogGenerator::ParserFile.new(options) }
it { expect { parse.parse! }.to raise_error(GitHubChangelogGenerator::ParserError) }
let(:file) { StringIO.new("unreleased_label=staging\nunreleased: false") }
let(:parser) do
GitHubChangelogGenerator::ParserFile.new(options, file)
end
it { expect { parser.parse! }.to raise_error(/line #2/) }
end
context "allows empty lines and comments with semi-colon or pound sign" do
let(:file) { StringIO.new("\n \n# Comment on first line\nunreleased_label=staging\n; Comment on third line\nunreleased=false") }
let(:parser) do
GitHubChangelogGenerator::ParserFile.new(options, file)
end
it { expect { parser.parse! }.not_to raise_error }
end
context "when override default values" do
let(:default_options) { GitHubChangelogGenerator::Parser.default_options }
let(:options) { { params_file: "spec/files/github_changelog_params_override" }.merge(default_options) }
let(:options) { {}.merge(default_options) }
let(:options_before_change) { options.dup }
let(:parse) { GitHubChangelogGenerator::ParserFile.new(options) }
let(:file) { StringIO.new("unreleased_label=staging\nunreleased=false\nheader==== Changelog ===") }
let(:parser) { GitHubChangelogGenerator::ParserFile.new(options, file) }
it "changes the options" do
expect { parse.parse! }.to change { options }
expect { parser.parse! }.to change { options }
.from(options_before_change)
.to(options_before_change.merge(unreleased_label: "staging",
unreleased: false,
@@ -38,17 +49,24 @@ describe GitHubChangelogGenerator::ParserFile do
end
context "turns exclude-labels into an Array", bug: '#327' do
let(:options) do
{
params_file: "spec/files/github_changelog_params_327"
}
let(:file) do
StringIO.new(<<EOF
exclude-labels=73a91042-da6f-11e5-9335-1040f38d7f90,7adf83b4-da6f-11e5-ae18-1040f38d7f90
header_label=# My changelog
EOF
)
end
it "reads exclude_labels into an Array" do
pending("Related with Bug #327.")
expect { parse.parse! }.to change { options[:exclude_labels] }
.from(nil)
expect { parser.parse! }.to change { options[:exclude_labels] }
.from(default_options[:exclude_labels])
.to(["73a91042-da6f-11e5-9335-1040f38d7f90", "7adf83b4-da6f-11e5-ae18-1040f38d7f90"])
end
it "translates given header_label into the :header option" do
expect { parser.parse! }.to change { options[:header] }
.from(default_options[:header])
.to("# My changelog")
end
end
end
end