Compare commits

..

1 Commits

Author SHA1 Message Date
Olle Jonsson
d3da434e4a Use ruby-2.4.1 in CI 2017-03-23 00:00:03 +01:00
45 changed files with 1197 additions and 6029 deletions

View File

@ -1,2 +0,0 @@
project=github-changelog-generator
user=skywinder

View File

@ -1,7 +1,6 @@
inherit_from: .rubocop_todo.yml inherit_from: .rubocop_todo.yml
AllCops: AllCops:
TargetRubyVersion: 2.2
DisplayCopNames: true DisplayCopNames: true
DisplayStyleGuide: true DisplayStyleGuide: true
Exclude: Exclude:
@ -26,7 +25,7 @@ Metrics/ClassLength:
Metrics/MethodLength: Metrics/MethodLength:
Enabled: false Enabled: false
Naming/FileName: Style/FileName:
Exclude: Exclude:
- 'bin/git-generate-changelog' - 'bin/git-generate-changelog'
@ -36,7 +35,7 @@ Metrics/AbcSize:
Enabled: false Enabled: false
# Offense count: 1 # Offense count: 1
Naming/AccessorMethodName: Style/AccessorMethodName:
Enabled: false Enabled: false
# Offense count: 10 # Offense count: 10
@ -75,15 +74,3 @@ Style/SafeNavigation:
Metrics/BlockLength: Metrics/BlockLength:
Exclude: Exclude:
- 'spec/**/*' - 'spec/**/*'
# Re-enable when merged; https://github.com/bbatsov/rubocop/pull/4756
Lint/InterpolationCheck:
Enabled: false
Style/FormatStringToken:
Exclude:
- lib/github_changelog_generator/parser.rb
Style/MixinUsage:
Exclude:
- lib/github_changelog_generator/task.rb

View File

@ -1,26 +1,32 @@
language: ruby language: ruby
cache: cache:
bundler: true - bundler
before_install: before_install:
- gem update --system
- gem install bundler - gem install bundler
matrix: matrix:
fast_finish: true
include: include:
- rvm: 2.2.7 - rvm: 2.2.6
install: true # This skips 'bundle install' install: true # This skips 'bundle install'
script: gem build github_changelog_generator && gem install *.gem script: gem build github_changelog_generator && gem install *.gem
after_success: true # This skips 'codeclimate-test-reporter' - rvm: 2.2.6
- rvm: 2.2.7
install: true # This skips 'bundle install' install: true # This skips 'bundle install'
script: gem build github_changelog_generator && bundle install script: gem build github_changelog_generator && bundle install
gemfile: spec/install-gem-in-bundler.gemfile gemfile: spec/install-gem-in-bundler.gemfile
after_success: true # This skips 'codeclimate-test-reporter' - rvm: 2.1
- rvm: 2.3.4 - rvm: 2.3.3
- rvm: 2.4.1 - rvm: 2.4.1
- rvm: jruby-9.1.15.0 - rvm: jruby-9.1.8.0
jdk: oraclejdk8 jdk: oraclejdk8
env: env:
- JRUBY_OPTS=--debug - JRUBY_OPTS=--debug
- rvm: jruby-head
jdk: oraclejdk8
env:
- JRUBY_OPTS=--debug
- DEBUG=1
allow_failures:
- rvm: jruby-head
addons: addons:
code_climate: code_climate:

View File

@ -1,114 +1,4 @@
# Changelog # Change Log
## [v1.15.0-rc](https://github.com/skywinder/github-changelog-generator/tree/v1.15.0-rc) (2017-10-29)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/v1.15.0.pre.beta...v1.15.0-rc)
**Implemented enhancements:**
- Add option --require to load custom Ruby code before starting [\#574](https://github.com/skywinder/github-changelog-generator/pull/574) ([olleolleolle](https://github.com/olleolleolle))
**Fixed bugs:**
- issue\_line\_labels and breaking\_labels fail as rake file config params [\#583](https://github.com/skywinder/github-changelog-generator/issues/583)
**Merged pull requests:**
- Add Rake options reported missing [\#584](https://github.com/skywinder/github-changelog-generator/pull/584) ([olleolleolle](https://github.com/olleolleolle))
- Aborting on missing --user and --project prints all of usage [\#578](https://github.com/skywinder/github-changelog-generator/pull/578) ([olleolleolle](https://github.com/olleolleolle))
- Options\#print\_options + API docs for Options, Parser [\#576](https://github.com/skywinder/github-changelog-generator/pull/576) ([olleolleolle](https://github.com/olleolleolle))
- \[docs\] Contributing file [\#575](https://github.com/skywinder/github-changelog-generator/pull/575) ([olleolleolle](https://github.com/olleolleolle))
## [v1.15.0.pre.beta](https://github.com/skywinder/github-changelog-generator/tree/v1.15.0.pre.beta) (2017-10-13)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/v1.15.0.pre.alpha...v1.15.0.pre.beta)
**Implemented enhancements:**
- add breaking-changes section to changelog [\#530](https://github.com/skywinder/github-changelog-generator/pull/530) ([bastelfreak](https://github.com/bastelfreak))
- Drop Project-and-Username-finding code [\#451](https://github.com/skywinder/github-changelog-generator/pull/451) ([olleolleolle](https://github.com/olleolleolle))
**Fixed bugs:**
- since\_tag doesn't work when tag specified is the latest tag [\#555](https://github.com/skywinder/github-changelog-generator/issues/555)
- since\_tag seems to not be working [\#304](https://github.com/skywinder/github-changelog-generator/issues/304)
- filter tags correctly when `since\_tag` is set to most recent tag [\#566](https://github.com/skywinder/github-changelog-generator/pull/566) ([Crunch09](https://github.com/Crunch09))
**Closed issues:**
- SSL Cert issue on Windows [\#475](https://github.com/skywinder/github-changelog-generator/issues/475)
**Merged pull requests:**
- Fix regression w/ enhancements in issues\_to\_log [\#573](https://github.com/skywinder/github-changelog-generator/pull/573) ([ekohl](https://github.com/ekohl))
- OctoFetcher: Use defaults for request\_options [\#571](https://github.com/skywinder/github-changelog-generator/pull/571) ([olleolleolle](https://github.com/olleolleolle))
- OctoFetcher: extract methods [\#570](https://github.com/skywinder/github-changelog-generator/pull/570) ([olleolleolle](https://github.com/olleolleolle))
- OctoFetcher: extract method fail\_with\_message [\#569](https://github.com/skywinder/github-changelog-generator/pull/569) ([olleolleolle](https://github.com/olleolleolle))
- OctoFetcher: drop unused number\_of\_pages feature [\#568](https://github.com/skywinder/github-changelog-generator/pull/568) ([olleolleolle](https://github.com/olleolleolle))
- Travis: Do not test on jruby-head [\#567](https://github.com/skywinder/github-changelog-generator/pull/567) ([olleolleolle](https://github.com/olleolleolle))
- Drop unused Rake task [\#564](https://github.com/skywinder/github-changelog-generator/pull/564) ([olleolleolle](https://github.com/olleolleolle))
- Update license date [\#553](https://github.com/skywinder/github-changelog-generator/pull/553) ([benhc123](https://github.com/benhc123))
## [v1.15.0.pre.alpha](https://github.com/skywinder/github-changelog-generator/tree/v1.15.0.pre.alpha) (2017-10-01)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/v1.14.3...v1.15.0.pre.alpha)
**Implemented enhancements:**
- Add newline after version name and Full Changelog link [\#548](https://github.com/skywinder/github-changelog-generator/pull/548) ([ianroberts131](https://github.com/ianroberts131))
- Update the token failure example to OctoKit 404 failure [\#525](https://github.com/skywinder/github-changelog-generator/pull/525) ([00xcoffee](https://github.com/00xcoffee))
- Rescue invalid commands and present the valid options list [\#498](https://github.com/skywinder/github-changelog-generator/pull/498) ([Lucashuang0802](https://github.com/Lucashuang0802))
- bundled cacert.pem with --ssl-ca-file PATH option [\#480](https://github.com/skywinder/github-changelog-generator/pull/480) ([olleolleolle](https://github.com/olleolleolle))
- Option parsing: Remove tag1, tag2 cruft [\#479](https://github.com/skywinder/github-changelog-generator/pull/479) ([olleolleolle](https://github.com/olleolleolle))
**Fixed bugs:**
- Credit line bug [\#541](https://github.com/skywinder/github-changelog-generator/issues/541)
- Bug: Credit line about this project added more than once [\#507](https://github.com/skywinder/github-changelog-generator/issues/507)
- v1.14.0 Fails with missing /tmp/ path on Windows [\#458](https://github.com/skywinder/github-changelog-generator/issues/458)
- failure when creating changelog from a repo in an orginazation: can't convert Github::ResponseWrapper to Array [\#253](https://github.com/skywinder/github-changelog-generator/issues/253)
- warn\_if\_nonmatching\_regex should display proper help message when used with exclude-tags-regex [\#551](https://github.com/skywinder/github-changelog-generator/pull/551) ([lacostej](https://github.com/lacostej))
- Bugfix: require ActiveSupport core\_ext/blank [\#520](https://github.com/skywinder/github-changelog-generator/pull/520) ([olleolleolle](https://github.com/olleolleolle))
- Create temporary cache files in Dir.tmpdir [\#459](https://github.com/skywinder/github-changelog-generator/pull/459) ([olleolleolle](https://github.com/olleolleolle))
**Closed issues:**
- error \(Windows: Command exited with code 1\) [\#536](https://github.com/skywinder/github-changelog-generator/issues/536)
- Error in generating changelog on Windows [\#521](https://github.com/skywinder/github-changelog-generator/issues/521)
- Crash on start [\#512](https://github.com/skywinder/github-changelog-generator/issues/512)
- Error On Running Generation Command [\#511](https://github.com/skywinder/github-changelog-generator/issues/511)
- Not working [\#510](https://github.com/skywinder/github-changelog-generator/issues/510)
- PR cited in the wrong TAG [\#503](https://github.com/skywinder/github-changelog-generator/issues/503)
- 404 Not Found Error [\#484](https://github.com/skywinder/github-changelog-generator/issues/484)
**Merged pull requests:**
- Travis: Configure cache: bundler: true [\#563](https://github.com/skywinder/github-changelog-generator/pull/563) ([olleolleolle](https://github.com/olleolleolle))
- Travis: use JRuby 9.1.13.0; don't redo rvm's job [\#562](https://github.com/skywinder/github-changelog-generator/pull/562) ([olleolleolle](https://github.com/olleolleolle))
- Travis: update CI matrix [\#561](https://github.com/skywinder/github-changelog-generator/pull/561) ([olleolleolle](https://github.com/olleolleolle))
- Fix section mapping, hiding untagged PRs, and hiding untagged issues [\#550](https://github.com/skywinder/github-changelog-generator/pull/550) ([hunner](https://github.com/hunner))
- Update generator\_generation.rb [\#542](https://github.com/skywinder/github-changelog-generator/pull/542) ([Lucashuang0802](https://github.com/Lucashuang0802))
- AppVeyor: drop init build hook, add .gitattributes instead [\#539](https://github.com/skywinder/github-changelog-generator/pull/539) ([olleolleolle](https://github.com/olleolleolle))
- AppVeyor: Windows configuration to pass RuboCop [\#538](https://github.com/skywinder/github-changelog-generator/pull/538) ([olleolleolle](https://github.com/olleolleolle))
- Fix the syntax ambiguity on credit-line-bug [\#537](https://github.com/skywinder/github-changelog-generator/pull/537) ([Lucashuang0802](https://github.com/Lucashuang0802))
- Credit line bug [\#535](https://github.com/skywinder/github-changelog-generator/pull/535) ([Lucashuang0802](https://github.com/Lucashuang0802))
- Update README.md [\#534](https://github.com/skywinder/github-changelog-generator/pull/534) ([Lucashuang0802](https://github.com/Lucashuang0802))
- Delete circle.yml [\#532](https://github.com/skywinder/github-changelog-generator/pull/532) ([Lucashuang0802](https://github.com/Lucashuang0802))
- Update README.md [\#531](https://github.com/skywinder/github-changelog-generator/pull/531) ([Lucashuang0802](https://github.com/Lucashuang0802))
- Remove all old credit lines in the output then add a new one [\#526](https://github.com/skywinder/github-changelog-generator/pull/526) ([Enether](https://github.com/Enether))
- Travis: jruby-9.1.10.0 [\#523](https://github.com/skywinder/github-changelog-generator/pull/523) ([olleolleolle](https://github.com/olleolleolle))
- Travis CI: Drop 2.1 [\#517](https://github.com/skywinder/github-changelog-generator/pull/517) ([olleolleolle](https://github.com/olleolleolle))
- Chore: Rubocop 0.49.0 [\#516](https://github.com/skywinder/github-changelog-generator/pull/516) ([olleolleolle](https://github.com/olleolleolle))
- Travis: use jruby-9.1.9.0 [\#506](https://github.com/skywinder/github-changelog-generator/pull/506) ([olleolleolle](https://github.com/olleolleolle))
- Use closed\_at and merged\_at when filtering issues/prs [\#504](https://github.com/skywinder/github-changelog-generator/pull/504) ([unicolet](https://github.com/unicolet))
- Remove --between-tags option [\#501](https://github.com/skywinder/github-changelog-generator/pull/501) ([Lucashuang0802](https://github.com/Lucashuang0802))
- Fixed headline in README.md [\#496](https://github.com/skywinder/github-changelog-generator/pull/496) ([Dreckiger-Dan](https://github.com/Dreckiger-Dan))
- Update README.md [\#490](https://github.com/skywinder/github-changelog-generator/pull/490) ([fatData](https://github.com/fatData))
- Travis: use latest rubies [\#488](https://github.com/skywinder/github-changelog-generator/pull/488) ([olleolleolle](https://github.com/olleolleolle))
- Use ruby-2.4.1 in CI [\#487](https://github.com/skywinder/github-changelog-generator/pull/487) ([olleolleolle](https://github.com/olleolleolle))
- Travis: jruby-9.1.8.0 [\#485](https://github.com/skywinder/github-changelog-generator/pull/485) ([olleolleolle](https://github.com/olleolleolle))
- Update to latest CodeClimate [\#478](https://github.com/skywinder/github-changelog-generator/pull/478) ([olleolleolle](https://github.com/olleolleolle))
- Gemspec: update retriable to 3.0 [\#477](https://github.com/skywinder/github-changelog-generator/pull/477) ([olleolleolle](https://github.com/olleolleolle))
- Travis: new JRuby, develop on 2.4.0 [\#476](https://github.com/skywinder/github-changelog-generator/pull/476) ([olleolleolle](https://github.com/olleolleolle))
- Fix readme typos [\#467](https://github.com/skywinder/github-changelog-generator/pull/467) ([dguo](https://github.com/dguo))
- Gemspec: demand rainbow 2.2.1+ [\#466](https://github.com/skywinder/github-changelog-generator/pull/466) ([olleolleolle](https://github.com/olleolleolle))
## [v1.14.3](https://github.com/skywinder/github-changelog-generator/tree/v1.14.3) (2016-12-31) ## [v1.14.3](https://github.com/skywinder/github-changelog-generator/tree/v1.14.3) (2016-12-31)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/v1.14.2...v1.14.3) [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/v1.14.2...v1.14.3)
@ -591,7 +481,7 @@
**Implemented enhancements:** **Implemented enhancements:**
- Parsing of existing Changelog file [\#212](https://github.com/skywinder/github-changelog-generator/issues/212) - Parsing of existing Change Log file [\#212](https://github.com/skywinder/github-changelog-generator/issues/212)
- Warn users about 0 tags in repo. [\#208](https://github.com/skywinder/github-changelog-generator/issues/208) - Warn users about 0 tags in repo. [\#208](https://github.com/skywinder/github-changelog-generator/issues/208)
- Cleanup [\#220](https://github.com/skywinder/github-changelog-generator/pull/220) ([tuexss](https://github.com/tuexss)) - Cleanup [\#220](https://github.com/skywinder/github-changelog-generator/pull/220) ([tuexss](https://github.com/tuexss))
@ -855,4 +745,4 @@
## [0.0.1](https://github.com/skywinder/github-changelog-generator/tree/0.0.1) (2014-11-06) ## [0.0.1](https://github.com/skywinder/github-changelog-generator/tree/0.0.1) (2014-11-06)
\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)* \* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

View File

@ -1,60 +0,0 @@
# How to contribute
Bug reports and pull requests from users are what keep this project working.
## Basics
1. Create an issue and describe your idea
2. [Fork it](https://github.com/skywinder/github-changelog-generator/fork)
3. Create your feature branch (`git checkout -b my-new-feature`)
4. Commit your changes (`git commit -am 'Add some feature'`)
5. Publish the branch (`git push origin my-new-feature`)
6. Create a new Pull Request
## Checking your work
You can test your workflow with changelog generator with
[the skywinder/changelog_test repo].
You can run the test suite.
You can run [RuboCop] to check code style.
The default Rake task, runnable using `rake`, calls `rubocop`, then `spec`.
[the skywinder/changelog_test repo]: https://github.com/skywinder/changelog_test/
[RuboCop]: http://rubocop.readthedocs.io/en/latest/
## Write documentation
This project has documentation in a few places:
### Introduction and usage
A friendly `README.md` written for many audiences.
### Examples and advanced usage
The [wiki].
### API documentation
API documentation is written as [YARD] docblocks in the Ruby code.
This is rendered as Web pages on [Rubydoc.info][github-changelog-generator on Rubydoc.info].
The completeness of the API documentation is measured on [our page on the Inch CI website][github-changelog-generator on Inch CI].
### man page
`man/git-generate-changelog.md`
The man page is for the `git generate-changelog` Git sub-command, which is a wrapper for `github_changelog_generator`. That file is a Markdown file.
Use the [ronn] gem to generate `.1` and `.html` artifacts like this: `cd man; ronn git-generate-changelog.md`
[wiki]: https://github.com/skywinder/github-changelog-generator/wiki
[YARD]: https://yardoc.org/
[github-changelog-generator on Rubydoc.info]: http://www.rubydoc.info/gems/github_changelog_generator
[ronn]: https://github.com/rtomayko/ronn
[github-changelog-generator on Inch CI]: https://inch-ci.org/github/skywinder/github-changelog-generator

View File

@ -1,16 +0,0 @@
FROM ruby:2.4-alpine3.6
LABEL maintainer "ferrari.marco@gmail.com"
ENV GITHUB_CHANGELOG_GENERATOR_VERSION "1.14.3"
RUN gem install github_changelog_generator --version $GITHUB_CHANGELOG_GENERATOR_VERSION
ENV SRC_PATH /usr/local/src/your-app
RUN mkdir -p $SRC_PATH
VOLUME [ "$SRC_PATH" ]
WORKDIR $SRC_PATH
CMD ["--help"]
ENTRYPOINT ["github_changelog_generator"]

View File

@ -1,5 +1,4 @@
# frozen_string_literal: true # frozen_string_literal: true
source "https://rubygems.org" source "https://rubygems.org"
ruby RUBY_VERSION ruby RUBY_VERSION
@ -10,7 +9,7 @@ group :development, :test do
gem "bundler" gem "bundler"
gem "overcommit", ">= 0.31" gem "overcommit", ">= 0.31"
gem "rake" gem "rake"
gem "rubocop", ">= 0.50" gem "rubocop", ">= 0.43"
end end
group :development do group :development do

View File

@ -1,5 +1,5 @@
The MIT License (MIT) The MIT License (MIT)
Copyright (c) 2016-2018 Petr Korolev Copyright (c) 2016 Petr Korolev
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

View File

@ -1,7 +1,6 @@
[![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)
[![Build status](https://ci.appveyor.com/api/projects/status/xdfnfmdjfo0upm7m?svg=true)](https://ci.appveyor.com/project/olleolleolle/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)
[![Test Coverage](https://codeclimate.com/github/skywinder/github-changelog-generator/badges/coverage.svg)](https://codeclimate.com/github/skywinder/github-changelog-generator) [![Test Coverage](https://codeclimate.com/github/skywinder/github-changelog-generator/badges/coverage.svg)](https://codeclimate.com/github/skywinder/github-changelog-generator)
@ -27,36 +26,27 @@ GitHub Changelog Generator ![GitHub Logo](../master/images/logo.jpg)
**Fully automated changelog generation** - This gem generates a change log file based on **tags**, **issues** and merged **pull requests** (and splits them into separate lists according to labels) from :octocat: GitHub Issue Tracker. **Fully automated changelog generation** - This gem generates a change log file based on **tags**, **issues** and merged **pull requests** (and splits them into separate lists according to labels) from :octocat: GitHub Issue Tracker.
Since you don't have to fill your `CHANGELOG.md` manually now: just run the script, relax and take a cup of :coffee: before your next release! :tada: Since now you don't have to fill your `CHANGELOG.md` manually: just run the script, relax and take a cup of :coffee: before your next release! :tada:
### *Whats the point of a changelog?*
>### *Whats the point of a change log?*
To make it easier for users and contributors to see precisely what notable changes have been made between each release (or version) of the project. To make it easier for users and contributors to see precisely what notable changes have been made between each release (or version) of the project.
### *Why should I care?* ### *Why should I care?*
Because software tools are for people. If you 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_. "Changelogs make it easier for users and > :arrow_right: *[http://keepachangelog.com](http://keepachangelog.com)*
contributors to see precisely what notable changes have been made between each
release (or version) of the project."
:arrow_right: *[http://keepachangelog.com](http://keepachangelog.com)*
## Installation ## Installation
$ [sudo] gem install github_changelog_generator gem install github_changelog_generator
See also Troubleshooting. See also Troubleshooting.
## Running with Docker
$ docker run -it --rm -v "$(pwd)":/usr/local/src/your-app skywinder/github-changelog-generator
## Output example ## Output example
- Look at **[CHANGELOG.md](https://github.com/skywinder/Github-Changelog-Generator/blob/master/CHANGELOG.md)** for this project - Look at **[CHANGELOG.md](https://github.com/skywinder/Github-Changelog-Generator/blob/master/CHANGELOG.md)** for this project
- [ActionSheetPicker-3.0/CHANGELOG.md](https://github.com/skywinder/ActionSheetPicker-3.0/blob/master/CHANGELOG.md) was generated by command: - [ActionSheetPicker-3.0/CHANGELOG.md](https://github.com/skywinder/ActionSheetPicker-3.0/blob/master/CHANGELOG.md) was generated by command:
$ github_changelog_generator -u skywinder -p ActionSheetPicker-3.0 github_changelog_generator -u skywinder -p ActionSheetPicker-3.0
- In general, it looks like this: - In general, it looks like this:
@ -80,37 +70,32 @@ See also Troubleshooting.
## Usage ## Usage
**It's really simple!**
- Run this: - If your **`git remote`** `origin` refers to your GitHub repo, just go to your project folder and run:
$ github_changelog_generator -u github_username -p github_project github_changelog_generator
or, on the 1.14.x (current stable release) - Or, run this from anywhere:
- `github_changelog_generator -u github_username -p github_project`
- `github_changelog_generator github_username/github_project`
$ github_changelog_generator github_username/github_project - If you are running it against a repository on a Github Enterprise install, you must specify *both* `--github-site` and `--github-api` command line options:
github_changelog_generator --github-site="https://github.yoursite.com" \
- For Github Enterprise repos, specify *both* `--github-site` and `--github-api` options:
$ github_changelog_generator --github-site="https://github.yoursite.com" \
--github-api="https://github.yoursite.com/api/v3/" --github-api="https://github.yoursite.com/api/v3/"
This generates a `CHANGELOG.md`, with pretty Markdown formatting. This generates a changelog to the `CHANGELOG.md` file, with pretty markdown formatting.
### Params ### Params
Type `github_changelog_generator --help` for details.
Print help for all command-line options to learn more details:
$ github_changelog_generator --help
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) 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)
### Params File ### Params File
In your project root, you can put a params file named `.github_changelog_generator` to override default params: In your project root, you can put a params file named `.github_changelog_generator` to override default params:
Example: Example:
``` ```
unreleased=false unreleased=false
future-release=5.0.0 future-release=5.0.0
@ -119,8 +104,7 @@ since-tag=1.0.0
### GitHub token ### GitHub token
GitHub only allows 50 unauthenticated requests per hour. GitHub only allows only 50 unauthenticated requests per hour.
Therefore, it's recommended to run this script with authentication by using a **token**. Therefore, it's recommended to run this script with authentication by using a **token**.
Here's how: Here's how:
@ -134,12 +118,8 @@ You can set an environment variable by running the following command at the prom
export CHANGELOG_GITHUB_TOKEN="«your-40-digit-github-token»" export CHANGELOG_GITHUB_TOKEN="«your-40-digit-github-token»"
So, if you get a message like this: So, if you got an 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'
``` markdown
API rate limit exceeded for github_username.
See: https://developer.github.com/v3/#rate-limiting
```
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 an hour for GitHub to reset your unauthenticated request limit.)
@ -158,7 +138,7 @@ If you have a `HISTORY.md` file in your project, it will automatically be picked
You love `rake`? We do, too! So, we've made it even easier for you: You love `rake`? We do, too! So, we've made it even easier for you:
we've provided a `rake` task library for your changelog generation. we've provided a `rake` task library for your changelog generation.
Configure the task in your `Rakefile`: Just put something like this in your `Rakefile`:
```ruby ```ruby
require 'github_changelog_generator/task' require 'github_changelog_generator/task'
@ -169,14 +149,11 @@ GitHubChangelogGenerator::RakeTask.new :changelog do |config|
end end
``` ```
All command-line options can be passed to the `rake` task as `config` 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.
parameters. And since you're naming the `rake` task yourself, you can create
as many as you want.
You can look for params names from the [parser source code (#setup_parser)](https://github.com/skywinder/github-changelog-generator/blob/master/lib/github_changelog_generator/parser.rb). For example, to translate the bugs label to Portuguese, instead of setting `config.bugs_label`, you have to set `config.bug_prefix`, and so on. You can look for params names from the [parser source code (#setup_parser)](https://github.com/skywinder/github-changelog-generator/blob/master/lib/github_changelog_generator/parser.rb). For example, to translate the bugs label to Portuguese, instead of setting `config.bugs_label`, you have to set `config.bug_prefix`, and so on.
## 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: - Optionally 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:
@ -197,19 +174,17 @@ You can look for params names from the [parser source code (#setup_parser)](http
###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). Here's a [wikipage 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` 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).*
## Am I missing some essential feature? ## Am I missing some essential feature?
@ -233,18 +208,18 @@ An auto-generated changelog really helps, even if you manually fill in the relea
For example: For example:
When you find a closed bug, it is very useful to know which release fixed it. When I found a closed bug, it's very useful know which release fixed it.
So that you can easily find the 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 quite as easy to find this in handwritten releases notes
- A generated file saves you the trouble of remembering everything; - a generated file saves you the trouble of remembering everything;
sometimes people forget to add things to a handwritten file. sometimes people forget to add things to a handwritten file
Ultimately, I think GitHub Releases are ideal for end-users. Ultimately, I think GitHub Releases is ideal for end-users.
Meanwhile, `CHANGELOG.md` lives right in the repository, with its detailed list of changes, which is handy for developers. 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. Finally, there's nothing wrong with using GitHub Releases alongside `CHANGELOG.md` in this combination.
- ***I got an "API rate limit exceeded" error message. What does this mean?*** - ***I received a warning: "GitHub API rate limit exceed" What does this mean?***
GitHub [limits the number of API requests](https://developer.github.com/v3/#rate-limiting) you can make in an hour. You can make up to 5,000 requests per hour. For unauthenticated requests, the rate limit is only up to 60 requests per hour. Unauthenticated requests are associated with your IP address (not the user making requests). GitHub [limits the number of API requests](https://developer.github.com/v3/#rate-limiting) you can make in an hour. You can make up to 5,000 requests per hour. For unauthenticated requests, the rate limit is only up to 60 requests per hour. Unauthenticated requests are associated with your IP address (not the user making requests).
@ -280,9 +255,15 @@ can't get the latest version of Ruby installed.
## Contributing ## Contributing
We have collected notes on how to contribute to this project in [CONTRIBUTING.md]. 1. Create an issue and describe your idea
2. [Fork it] (https://github.com/skywinder/Github-Changelog-Generator/fork)
3. Create your feature branch (`git checkout -b my-new-feature`)
4. Commit your changes (`git commit -am 'Add some feature'`)
5. Publish the branch (`git push origin my-new-feature`)
6. Create a new Pull Request
7. Profit! :white_check_mark:
[CONTRIBUTING.md]: CONTRIBUTING.md *To test your workflow with changelog generator, you can use [test repo](https://github.com/skywinder/changelog_test/)*
## License ## License

View File

@ -1,5 +1,4 @@
# frozen_string_literal: true # frozen_string_literal: true
require "bundler" require "bundler"
require "bundler/gem_tasks" require "bundler/gem_tasks"
require "rubocop/rake_task" require "rubocop/rake_task"
@ -9,11 +8,33 @@ require "fileutils"
require "overcommit" require "overcommit"
RuboCop::RakeTask.new RuboCop::RakeTask.new
RSpec::Core::RakeTask.new RSpec::Core::RakeTask.new(:rspec)
desc "When releasing the gem, re-fetch latest cacert.pem from curl.haxx.se. Developer task." task :copy_man_page_to_manpath do |_t|
task :update_ssl_ca_file do known_manpath_paths = %w(/etc/manpath.config /etc/manpaths)
`pushd lib/github_changelog_generator/ssl_certs && curl --remote-name --time-cond cacert.pem https://curl.haxx.se/ca/cacert.pem && popd` manpath = known_manpath_paths.find do |f|
path = Pathname(f)
path.file? && path.readable?
end end
task default: %i[rubocop spec] 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: [:rubocop, :rspec]

View File

@ -17,9 +17,6 @@ environment:
- ruby_version: "21" # Older version, but matches Travis-CI - ruby_version: "21" # Older version, but matches Travis-CI
- ruby_version: "21-x64" - ruby_version: "21-x64"
init:
- git config --global core.autocrlf true
install: install:
- SET PATH=C:\Ruby%ruby_version%\bin;%PATH% - SET PATH=C:\Ruby%ruby_version%\bin;%PATH%
@ -39,7 +36,7 @@ install:
build_script: build_script:
# Install ruby dependencies # Install ruby dependencies
- bundle install --retry 3 - bundle install --retry 3
- bundle exec rake - bundle exec rake checks
test_script: test_script:
- gem build github_changelog_generator - gem build github_changelog_generator
@ -51,8 +48,3 @@ notifications:
- sky4winder+githubchangeloggenerator@gmail.com - sky4winder+githubchangeloggenerator@gmail.com
on_build_success: false on_build_success: false
on_build_status_changed: true on_build_status_changed: true
- provider: GitHubPullRequest
on_build_success: true
on_build_failure: true
on_build_status_changed: true

11
circle.yml Normal file
View File

@ -0,0 +1,11 @@
dependencies:
pre:
- gem update --system
notify:
webhooks:
# A list of hook hashes, containing the url field
# gitter hook
- url: https://webhooks.gitter.im/e/2d81eb1ae7695fdc82c4
- url: https://webhooks.gitter.im/e/3ec6a35fad7e9991058e

View File

@ -1,5 +1,5 @@
# coding: utf-8
# frozen_string_literal: true # frozen_string_literal: true
lib = File.expand_path("../lib", __FILE__) lib = File.expand_path("../lib", __FILE__)
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib) $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
require "github_changelog_generator/version" require "github_changelog_generator/version"
@ -9,7 +9,7 @@ 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 = ">= 2.2.2" spec.required_ruby_version = ">= 1.9.3"
spec.authors = ["Petr Korolev", "Olle Jonsson"] spec.authors = ["Petr Korolev", "Olle Jonsson"]
spec.email = "sky4winder+github_changelog_generator@gmail.com" spec.email = "sky4winder+github_changelog_generator@gmail.com"
@ -18,17 +18,17 @@ Gem::Specification.new do |spec|
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.files = Dir["{bin,lib,man,spec}/**/*"] + %w[LICENSE Rakefile README.md] spec.files = Dir["{bin,lib,man,spec}/**/*"] + %w(LICENSE Rakefile README.md)
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("activesupport")
spec.add_runtime_dependency("faraday-http-cache")
spec.add_runtime_dependency("multi_json")
spec.add_runtime_dependency("octokit", ["~> 4.6"])
spec.add_runtime_dependency "rainbow", ">= 2.2.1"
spec.add_runtime_dependency "rake", ">= 10.0" spec.add_runtime_dependency "rake", ">= 10.0"
spec.add_runtime_dependency "rainbow", ">= 2.2.1"
spec.add_runtime_dependency("octokit", ["~> 4.6"])
spec.add_runtime_dependency("faraday-http-cache")
spec.add_runtime_dependency("activesupport")
spec.add_runtime_dependency("retriable", ["~> 3.0"]) spec.add_runtime_dependency("retriable", ["~> 3.0"])
spec.add_runtime_dependency("multi_json")
end end

View File

@ -5,18 +5,17 @@ require "octokit"
require "faraday-http-cache" require "faraday-http-cache"
require "logger" require "logger"
require "active_support" require "active_support"
require "active_support/core_ext/object/blank"
require "json" require "json"
require "multi_json" require "multi_json"
require "benchmark" require "benchmark"
require "github_changelog_generator/helper" require_relative "github_changelog_generator/helper"
require "github_changelog_generator/options" require_relative "github_changelog_generator/options"
require "github_changelog_generator/parser" require_relative "github_changelog_generator/parser"
require "github_changelog_generator/parser_file" require_relative "github_changelog_generator/parser_file"
require "github_changelog_generator/generator/generator" require_relative "github_changelog_generator/generator/generator"
require "github_changelog_generator/version" require_relative "github_changelog_generator/version"
require "github_changelog_generator/reader" require_relative "github_changelog_generator/reader"
# The main module, where placed all classes (now, at least) # The main module, where placed all classes (now, at least)
module GitHubChangelogGenerator module GitHubChangelogGenerator
@ -34,10 +33,14 @@ module GitHubChangelogGenerator
def run def run
log = @generator.compound_changelog log = @generator.compound_changelog
output_filename = @options[:output].to_s output_filename = (@options[:output]).to_s
File.open(output_filename, "wb") { |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}"
end end
end end
if __FILE__ == $PROGRAM_NAME
GitHubChangelogGenerator::ChangelogGenerator.new.run
end
end end

View File

@ -1,237 +0,0 @@
require "github_changelog_generator/generator/section"
module GitHubChangelogGenerator
# This class generates the content for a single changelog entry. An entry is
# generally either for a specific tagged release or the collection of
# unreleased changes.
#
# An entry is comprised of header text followed by a series of sections
# relating to the entry.
#
# @see GitHubChangelogGenerator::Generator
# @see GitHubChangelogGenerator::Section
class Entry
attr_reader :content
def initialize(options = Options.new({}))
@content = ""
@options = Options.new(options)
end
# Generates log entry with header and body
#
# @param [Array] pull_requests List or PR's in new section
# @param [Array] issues List of issues in new section
# @param [String] newer_tag_name Name of the newer tag. Could be nil for `Unreleased` section.
# @param [String] newer_tag_link Name of the newer tag. Could be "HEAD" for `Unreleased` section.
# @param [Time] newer_tag_time Time of the newer tag
# @param [Hash, nil] older_tag Older tag, used for the links. Could be nil for last tag.
# @return [String] Ready and parsed section
def create_entry_for_tag(pull_requests, issues, newer_tag_name, newer_tag_link, newer_tag_time, older_tag_name) # rubocop:disable Metrics/ParameterLists
github_site = @options[:github_site] || "https://github.com"
project_url = "#{github_site}/#{@options[:user]}/#{@options[:project]}"
set_sections_and_maps
@content = generate_header(newer_tag_name, newer_tag_link, newer_tag_time, older_tag_name, project_url)
@content += generate_body(pull_requests, issues)
@content
end
private
# Creates section objects and the label and section maps needed for
# sorting
def set_sections_and_maps
@sections = if @options.configure_sections?
parse_sections(@options[:configure_sections])
elsif @options.add_sections?
default_sections.concat parse_sections(@options[:add_sections])
else
default_sections
end
@lmap = label_map
@smap = section_map
end
# Turns a string from the commandline into an array of Section objects
#
# @param [String, Hash] either string or hash describing sections
# @return [Array] array of Section objects
def parse_sections(sections_desc)
require "json"
sections_desc = sections_desc.to_json if sections_desc.class == Hash
begin
sections_json = JSON.parse(sections_desc)
rescue JSON::ParserError => e
raise "There was a problem parsing your JSON string for sections: #{e}"
end
sections_json.collect do |name, v|
Section.new(name: name.to_s, prefix: v["prefix"], labels: v["labels"], options: @options)
end
end
# Creates a hash map of labels => section objects
#
# @return [Hash] map of labels => section objects
def label_map
@sections.each_with_object({}) do |section_obj, memo|
section_obj.labels.each do |label|
memo[label] = section_obj.name
end
end
end
# Creates a hash map of 'section name' => section object
#
# @return [Hash] map of 'section name' => section object
def section_map
@sections.each_with_object({}) do |section, memo|
memo[section.name] = section
end
end
# It generates header text for an entry with specific parameters.
#
# @param [String] newer_tag_name - name of newer tag
# @param [String] newer_tag_link - used for links. Could be same as #newer_tag_name or some specific value, like HEAD
# @param [Time] newer_tag_time - time, when newer tag created
# @param [String] older_tag_name - tag name, used for links.
# @param [String] project_url - url for current project.
# @return [String] - Header text for a changelog entry.
def generate_header(newer_tag_name, newer_tag_link, newer_tag_time, older_tag_name, project_url)
header = ""
# Generate date string:
time_string = newer_tag_time.strftime(@options[:date_format])
# Generate tag name and link
release_url = if @options[:release_url]
format(@options[:release_url], newer_tag_link)
else
"#{project_url}/tree/#{newer_tag_link}"
end
header += if newer_tag_name.equal?(@options[:unreleased_label])
"## [#{newer_tag_name}](#{release_url})\n\n"
else
"## [#{newer_tag_name}](#{release_url}) (#{time_string})\n\n"
end
if @options[:compare_link] && older_tag_name
# Generate compare link
header += "[Full Changelog](#{project_url}/compare/#{older_tag_name}...#{newer_tag_link})\n\n"
end
header
end
# Generates complete body text for a tag (without a header)
#
# @param [Array] pull_requests
# @param [Array] issues
# @returns [String] ready-to-go tag body
def generate_body(pull_requests, issues)
body = ""
body += main_sections_to_log(pull_requests, issues)
body += merged_section_to_log(pull_requests) if @options[:pulls] && @options[:add_pr_wo_labels]
body
end
# Generates main sections for a tag
#
# @param [Array] pull_requests
# @param [Array] issues
# @return [string] ready-to-go sub-sections
def main_sections_to_log(pull_requests, issues)
if @options[:issues]
sections_to_log = parse_by_sections(pull_requests, issues)
sections_to_log.map(&:generate_content).join
end
end
# Generates section for prs with no labels (for a tag)
#
# @param [Array] pull_requests
# @return [string] ready-to-go sub-section
def merged_section_to_log(pull_requests)
merged = Section.new(name: "merged", prefix: @options[:merge_prefix], labels: [], issues: pull_requests, options: @options)
@sections << merged unless @sections.find { |section| section.name == "merged" }
merged.generate_content
end
# Set of default sections for backwards-compatibility/defaults
#
# @return [Array] array of Section objects
def default_sections
[
Section.new(name: "breaking", prefix: @options[:breaking_prefix], labels: @options[:breaking_labels], options: @options),
Section.new(name: "enhancements", prefix: @options[:enhancement_prefix], labels: @options[:enhancement_labels], options: @options),
Section.new(name: "bugs", prefix: @options[:bug_prefix], labels: @options[:bug_labels], options: @options),
Section.new(name: "issues", prefix: @options[:issue_prefix], labels: @options[:issue_labels], options: @options)
]
end
# This method sorts issues by types
# (bugs, features, or just closed issues) by labels
#
# @param [Array] pull_requests
# @param [Array] issues
# @return [Hash] Mapping of filtered arrays: (Bugs, Enhancements, Breaking stuff, Issues)
def parse_by_sections(pull_requests, issues)
issues.each do |dict|
added = false
dict["labels"].each do |label|
break if @lmap[label["name"]].nil?
@smap[@lmap[label["name"]]].issues << dict
added = true
break if added
end
if @smap["issues"]
@sections.find { |sect| sect.name == "issues" }.issues << dict unless added
end
end
sort_pull_requests(pull_requests)
end
# This method iterates through PRs and sorts them into sections
#
# @param [Array] pull_requests
# @param [Hash] sections
# @return [Hash] sections
def sort_pull_requests(pull_requests)
added_pull_requests = []
pull_requests.each do |pr|
added = false
pr["labels"].each do |label|
break if @lmap[label["name"]].nil?
@smap[@lmap[label["name"]]].issues << pr
added_pull_requests << pr
added = true
break if added
end
end
added_pull_requests.each { |req| pull_requests.delete(req) }
@sections
end
def line_labels_for(issue)
labels = if @options[:issue_line_labels] == ["ALL"]
issue["labels"]
else
issue["labels"].select { |label| @options[:issue_line_labels].include?(label["name"]) }
end
labels.map { |label| " \[[#{label['name']}](#{label['url'].sub('api.github.com/repos', 'github.com')})\]" }.join("")
end
end
end

View File

@ -1,30 +1,17 @@
# frozen_string_literal: true # frozen_string_literal: true
require_relative "../octo_fetcher"
require "github_changelog_generator/octo_fetcher" require_relative "generator_generation"
require "github_changelog_generator/generator/generator_fetcher" require_relative "generator_fetcher"
require "github_changelog_generator/generator/generator_processor" require_relative "generator_processor"
require "github_changelog_generator/generator/generator_tags" require_relative "generator_tags"
require "github_changelog_generator/generator/entry"
require "github_changelog_generator/generator/section"
module GitHubChangelogGenerator module GitHubChangelogGenerator
# Default error for ChangelogGenerator # Default error for ChangelogGenerator
class ChangelogGeneratorError < StandardError class ChangelogGeneratorError < StandardError
end end
# This class is the high-level code for gathering issues and PRs for a github
# repository and generating a CHANGELOG.md file. A changelog is made up of a
# series of "entries" of all tagged releases, plus an extra entry for the
# unreleased changes. Entries are made up of various organizational
# "sections," and sections contain the github issues and PRs.
#
# So the changelog contains entries, entries contain sections, and sections
# contain issues and PRs.
#
# @see GitHubChangelogGenerator::Entry
# @see GitHubChangelogGenerator::Section
class Generator class Generator
attr_accessor :options, :filtered_tags, :tag_section_mapping, :sorted_tags attr_accessor :options, :filtered_tags, :github, :tag_section_mapping, :sorted_tags
# A Generator responsible for all logic, related with change log generation from ready-to-parse issues # A Generator responsible for all logic, related with change log generation from ready-to-parse issues
# #
@ -35,104 +22,6 @@ module GitHubChangelogGenerator
@options = options @options = options
@tag_times_hash = {} @tag_times_hash = {}
@fetcher = GitHubChangelogGenerator::OctoFetcher.new(options) @fetcher = GitHubChangelogGenerator::OctoFetcher.new(options)
@sections = []
end
# Main function to start changelog generation
#
# @return [String] Generated changelog file
def compound_changelog
options.load_custom_ruby_files
fetch_and_filter_tags
fetch_issues_and_pr
log = ""
log += options[:frontmatter] if options[:frontmatter]
log += "#{options[:header]}\n\n"
log += if options[:unreleased_only]
generate_entry_between_tags(filtered_tags[0], nil)
else
generate_entries_for_all_tags
end
log += File.read(options[:base]) if File.file?(options[:base])
credit_line = "\n\n\\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*"
log.gsub!(credit_line, "") # Remove old credit lines
log += credit_line
@log = log
end
private
# Generate log only between 2 specified tags
# @param [String] older_tag all issues before this tag date will be excluded. May be nil, if it's first tag
# @param [String] newer_tag all issue after this tag will be excluded. May be nil for unreleased section
def generate_entry_between_tags(older_tag, newer_tag)
filtered_issues, filtered_pull_requests = filter_issues_for_tags(newer_tag, older_tag)
if newer_tag.nil? && filtered_issues.empty? && filtered_pull_requests.empty?
# do not generate empty unreleased section
return ""
end
newer_tag_link, newer_tag_name, newer_tag_time = detect_link_tag_time(newer_tag)
# If the older tag is nil, go back in time from the latest tag and find
# the SHA for the first commit.
older_tag_name =
if older_tag.nil?
@fetcher.commits_before(newer_tag_time).last["sha"]
else
older_tag["name"]
end
Entry.new(options).create_entry_for_tag(filtered_pull_requests, filtered_issues, newer_tag_name, newer_tag_link, newer_tag_time, older_tag_name)
end
# Filters issues and pull requests based on, respectively, `closed_at` and `merged_at`
# timestamp fields.
#
# @return [Array] filtered issues and pull requests
def filter_issues_for_tags(newer_tag, older_tag)
filtered_pull_requests = delete_by_time(@pull_requests, "merged_at", older_tag, newer_tag)
filtered_issues = delete_by_time(@issues, "closed_at", older_tag, newer_tag)
newer_tag_name = newer_tag.nil? ? nil : newer_tag["name"]
if options[:filter_issues_by_milestone]
# delete excess irrelevant issues (according milestones). Issue #22.
filtered_issues = filter_by_milestone(filtered_issues, newer_tag_name, @issues)
filtered_pull_requests = filter_by_milestone(filtered_pull_requests, newer_tag_name, @pull_requests)
end
[filtered_issues, filtered_pull_requests]
end
# The full cycle of generation for whole project
# @return [String] All entries in the changelog
def generate_entries_for_all_tags
puts "Generating entry..." if options[:verbose]
entries = generate_unreleased_entry
@tag_section_mapping.each_pair do |_tag_section, left_right_tags|
older_tag, newer_tag = left_right_tags
entries += generate_entry_between_tags(older_tag, newer_tag)
end
entries
end
def generate_unreleased_entry
entry = ""
if options[:unreleased]
start_tag = filtered_tags[0] || sorted_tags.last
unreleased_entry = generate_entry_between_tags(start_tag, nil)
entry += unreleased_entry if unreleased_entry
end
entry
end end
def fetch_issues_and_pr def fetch_issues_and_pr
@ -145,5 +34,111 @@ module GitHubChangelogGenerator
fetch_events_for_issues_and_pr fetch_events_for_issues_and_pr
detect_actual_closed_dates(@issues + @pull_requests) detect_actual_closed_dates(@issues + @pull_requests)
end end
# Encapsulate characters to make markdown look as expected.
#
# @param [String] string
# @return [String] encapsulated input string
def encapsulate_string(string)
string.gsub! '\\', '\\\\'
encpas_chars = %w(< > * _ \( \) [ ] #)
encpas_chars.each do |char|
string.gsub! char, "\\#{char}"
end
string
end
# Generates log for section with header and body
#
# @param [Array] pull_requests List or PR's in new section
# @param [Array] issues List of issues in new section
# @param [String] newer_tag Name of the newer tag. Could be nil for `Unreleased` section
# @param [String] older_tag_name Older tag, used for the links. Could be nil for last tag.
# @return [String] Ready and parsed section
def create_log_for_tag(pull_requests, issues, newer_tag, older_tag_name = nil)
newer_tag_link, newer_tag_name, newer_tag_time = detect_link_tag_time(newer_tag)
github_site = options[:github_site] || "https://github.com"
project_url = "#{github_site}/#{options[:user]}/#{options[:project]}"
log = generate_header(newer_tag_name, newer_tag_link, newer_tag_time, older_tag_name, project_url)
if options[:issues]
# Generate issues:
log += issues_to_log(issues, pull_requests)
end
if options[:pulls]
# Generate pull requests:
log += generate_sub_section(pull_requests, options[:merge_prefix])
end
log
end
# Generate ready-to-paste log from list of issues and pull requests.
#
# @param [Array] issues
# @param [Array] pull_requests
# @return [String] generated log for issues
def issues_to_log(issues, pull_requests)
log = ""
bugs_a, enhancement_a, issues_a = parse_by_sections(issues, pull_requests)
log += generate_sub_section(enhancement_a, options[:enhancement_prefix])
log += generate_sub_section(bugs_a, options[:bug_prefix])
log += generate_sub_section(issues_a, options[:issue_prefix])
log
end
# This method sort issues by types
# (bugs, features, or just closed issues) by labels
#
# @param [Array] issues
# @param [Array] pull_requests
# @return [Array] tuple of filtered arrays: (Bugs, Enhancements Issues)
def parse_by_sections(issues, pull_requests)
issues_a = []
enhancement_a = []
bugs_a = []
issues.each do |dict|
added = false
dict["labels"].each do |label|
if options[:bug_labels].include?(label["name"])
bugs_a.push(dict)
added = true
next
end
if options[:enhancement_labels].include?(label["name"])
enhancement_a.push(dict)
added = true
next
end
end
issues_a.push(dict) unless added
end
added_pull_requests = []
pull_requests.each do |pr|
pr["labels"].each do |label|
if options[:bug_labels].include?(label["name"])
bugs_a.push(pr)
added_pull_requests.push(pr)
next
end
if options[:enhancement_labels].include?(label["name"])
enhancement_a.push(pr)
added_pull_requests.push(pr)
next
end
end
end
added_pull_requests.each { |p| pull_requests.delete(p) }
[bugs_a, enhancement_a, issues_a]
end
end end
end end

View File

@ -1,5 +1,4 @@
# frozen_string_literal: true # frozen_string_literal: true
module GitHubChangelogGenerator module GitHubChangelogGenerator
class Generator class Generator
MAX_THREAD_NUMBER = 25 MAX_THREAD_NUMBER = 25
@ -78,7 +77,7 @@ module GitHubChangelogGenerator
issue["actual_date"] = commit["commit"]["author"]["date"] issue["actual_date"] = commit["commit"]["author"]["date"]
# issue['actual_date'] = commit['author']['date'] # issue['actual_date'] = commit['author']['date']
rescue StandardError rescue
puts "Warning: Can't fetch commit #{event['commit_id']}. It is probably referenced from another repo." puts "Warning: Can't fetch commit #{event['commit_id']}. It is probably referenced from another repo."
issue["actual_date"] = issue["closed_at"] issue["actual_date"] = issue["closed_at"]
end end

View File

@ -0,0 +1,177 @@
# frozen_string_literal: true
module GitHubChangelogGenerator
class Generator
# Main function to start change log generation
#
# @return [String] Generated change log file
def compound_changelog
fetch_and_filter_tags
fetch_issues_and_pr
log = ""
log += options[:frontmatter] if options[:frontmatter]
log += "#{options[:header]}\n\n"
log += if options[:unreleased_only]
generate_log_between_tags(filtered_tags[0], nil)
else
generate_log_for_all_tags
end
log += File.read(options[:base]) if File.file?(options[:base])
log += "\n\n\\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*"
@log = log
end
# @param [Array] issues List of issues on sub-section
# @param [String] prefix Name of sub-section
# @return [String] Generate ready-to-go sub-section
def generate_sub_section(issues, prefix)
log = ""
if issues.any?
log += "#{prefix}\n\n" unless options[:simple_list]
issues.each do |issue|
merge_string = get_string_for_issue(issue)
log += "- #{merge_string}\n"
end
log += "\n"
end
log
end
# It generate one header for section with specific parameters.
#
# @param [String] newer_tag_name - name of newer tag
# @param [String] newer_tag_link - used for links. Could be same as #newer_tag_name or some specific value, like HEAD
# @param [Time] newer_tag_time - time, when newer tag created
# @param [String] older_tag_link - tag name, used for links.
# @param [String] project_url - url for current project.
# @return [String] - Generate one ready-to-add section.
def generate_header(newer_tag_name, newer_tag_link, newer_tag_time, older_tag_link, project_url)
log = ""
# Generate date string:
time_string = newer_tag_time.strftime(options[:date_format])
# Generate tag name and link
release_url = if options[:release_url]
format(options[:release_url], newer_tag_link)
else
"#{project_url}/tree/#{newer_tag_link}"
end
log += if newer_tag_name.equal?(options[:unreleased_label])
"## [#{newer_tag_name}](#{release_url})\n\n"
else
"## [#{newer_tag_name}](#{release_url}) (#{time_string})\n"
end
if options[:compare_link] && older_tag_link
# Generate compare link
log += "[Full Changelog](#{project_url}/compare/#{older_tag_link}...#{newer_tag_link})\n\n"
end
log
end
# Generate log only between 2 specified tags
# @param [String] older_tag all issues before this tag date will be excluded. May be nil, if it's first tag
# @param [String] newer_tag all issue after this tag will be excluded. May be nil for unreleased section
def generate_log_between_tags(older_tag, newer_tag)
filtered_issues, filtered_pull_requests = filter_issues_for_tags(newer_tag, older_tag)
older_tag_name = older_tag.nil? ? detect_since_tag : older_tag["name"]
if newer_tag.nil? && filtered_issues.empty? && filtered_pull_requests.empty?
# do not generate empty unreleased section
return ""
end
create_log_for_tag(filtered_pull_requests, filtered_issues, newer_tag, older_tag_name)
end
# Apply all filters to issues and pull requests
#
# @return [Array] filtered issues and pull requests
def filter_issues_for_tags(newer_tag, older_tag)
filtered_pull_requests = delete_by_time(@pull_requests, "actual_date", older_tag, newer_tag)
filtered_issues = delete_by_time(@issues, "actual_date", older_tag, newer_tag)
newer_tag_name = newer_tag.nil? ? nil : newer_tag["name"]
if options[:filter_issues_by_milestone]
# delete excess irrelevant issues (according milestones). Issue #22.
filtered_issues = filter_by_milestone(filtered_issues, newer_tag_name, @issues)
filtered_pull_requests = filter_by_milestone(filtered_pull_requests, newer_tag_name, @pull_requests)
end
[filtered_issues, filtered_pull_requests]
end
# The full cycle of generation for whole project
# @return [String] The complete change log
def generate_log_for_all_tags
puts "Generating log..." if options[:verbose]
log = generate_unreleased_section
@tag_section_mapping.each_pair do |_tag_section, left_right_tags|
older_tag, newer_tag = left_right_tags
log += generate_log_between_tags(older_tag, newer_tag)
end
log
end
def generate_unreleased_section
log = ""
if options[:unreleased]
start_tag = filtered_tags[0] || sorted_tags.last
unreleased_log = generate_log_between_tags(start_tag, nil)
log += unreleased_log if unreleased_log
end
log
end
# Parse issue and generate single line formatted issue line.
#
# Example output:
# - Add coveralls integration [\#223](https://github.com/skywinder/github-changelog-generator/pull/223) (@skywinder)
#
# @param [Hash] issue Fetched issue from GitHub
# @return [String] Markdown-formatted single issue
def get_string_for_issue(issue)
encapsulated_title = encapsulate_string issue["title"]
title_with_number = "#{encapsulated_title} [\\##{issue['number']}](#{issue['html_url']})"
if options[:issue_line_labels].present?
title_with_number = "#{title_with_number}#{line_labels_for(issue)}"
end
issue_line_with_user(title_with_number, issue)
end
private
def line_labels_for(issue)
labels = if options[:issue_line_labels] == ["ALL"]
issue["labels"]
else
issue["labels"].select { |label| options[:issue_line_labels].include?(label["name"]) }
end
labels.map { |label| " \[[#{label['name']}](#{label['url'].sub('api.github.com/repos', 'github.com')})\]" }.join("")
end
def issue_line_with_user(line, issue)
return line if !options[:author] || issue["pull_request"].nil?
user = issue["user"]
return "#{line} ({Null user})" unless user
if options[:usernames_as_github_logins]
"#{line} (@#{user['login']})"
else
"#{line} ([#{user['login']}](#{user['html_url']}))"
end
end
end
end

View File

@ -1,5 +1,4 @@
# frozen_string_literal: true # frozen_string_literal: true
module GitHubChangelogGenerator module GitHubChangelogGenerator
class Generator class Generator
# delete all labels with labels from options[:exclude_labels] array # delete all labels with labels from options[:exclude_labels] array
@ -126,17 +125,19 @@ module GitHubChangelogGenerator
# @return [Array] filtered array of issues # @return [Array] filtered array of issues
def include_issues_by_labels(issues) def include_issues_by_labels(issues)
filtered_issues = filter_by_include_labels(issues) filtered_issues = filter_by_include_labels(issues)
filtered_issues = filter_wo_labels(filtered_issues) filtered_issues |= filter_wo_labels(issues)
filtered_issues filtered_issues
end end
# @return [Array] issues without labels or empty array if add_issues_wo_labels is false # @return [Array] issues without labels or empty array if add_issues_wo_labels is false
def filter_wo_labels(issues) def filter_wo_labels(issues)
if options[:add_issues_wo_labels] if options[:add_issues_wo_labels]
issues issues_wo_labels = issues.select do |issue|
else !issue["labels"].map { |l| l["name"] }.any?
issues.select { |issue| issue["labels"].map { |l| l["name"] }.any? }
end end
return issues_wo_labels
end
[]
end end
def filter_by_include_labels(issues) def filter_by_include_labels(issues)
@ -196,8 +197,8 @@ module GitHubChangelogGenerator
end end
end end
pull_requests.reject! do |pr| pull_requests.select! do |pr|
pr["merged_at"].nil? !pr["merged_at"].nil?
end end
pull_requests pull_requests

View File

@ -1,5 +1,4 @@
# frozen_string_literal: true # frozen_string_literal: true
module GitHubChangelogGenerator module GitHubChangelogGenerator
class Generator class Generator
# fetch, filter tags, fetch dates and sort them in time order # fetch, filter tags, fetch dates and sort them in time order
@ -8,47 +7,30 @@ module GitHubChangelogGenerator
detect_due_tag detect_due_tag
all_tags = @fetcher.get_all_tags all_tags = @fetcher.get_all_tags
included_tags = filter_excluded_tags(all_tags)
fetch_tags_dates(all_tags) # Creates a Hash @tag_times_hash fetch_tags_dates(all_tags) # Creates a Hash @tag_times_hash
all_sorted_tags = sort_tags_by_date(all_tags) @sorted_tags = sort_tags_by_date(included_tags)
@filtered_tags = get_filtered_tags(included_tags)
@sorted_tags = filter_excluded_tags(all_sorted_tags) @tag_section_mapping = build_tag_section_mapping(@filtered_tags, sorted_tags)
@filtered_tags = get_filtered_tags(@sorted_tags)
# Because we need to properly create compare links, we need a sorted list
# of all filtered tags (including the excluded ones). We'll exclude those
# tags from section headers inside the mapping function.
section_tags = get_filtered_tags(all_sorted_tags)
@tag_section_mapping = build_tag_section_mapping(section_tags, @filtered_tags)
@filtered_tags @filtered_tags
end end
# @param [Array] section_tags are the tags that need a subsection output # @param [Array] filtered_tags are the tags that need a subsection output
# @param [Array] filtered_tags is the list of filtered tags ordered from newest -> oldest # @param [Array] all_tags is the list of all tags ordered from newest -> oldest
# @return [Hash] key is the tag to output, value is an array of [Left Tag, Right Tag] # @return [Hash] key is the tag to output, value is an array of [Left Tag, Right Tag]
# PRs to include in this section will be >= [Left Tag Date] and <= [Right Tag Date] # PRs to include in this section will be >= [Left Tag Date] and <= [Right Tag Date]
# rubocop:disable Style/For - for allows us to be more concise def build_tag_section_mapping(filtered_tags, all_tags)
def build_tag_section_mapping(section_tags, filtered_tags)
tag_mapping = {} tag_mapping = {}
for i in 0..(section_tags.length - 1) filtered_tags.each do |tag|
tag = section_tags[i] older_tag_idx = all_tags.index(tag) + 1
older_tag = all_tags[older_tag_idx]
# Don't create section header for the "since" tag
next if @since_tag && tag["name"] == @since_tag
# Don't create a section header for the first tag in between_tags
next if options[:between_tags] && tag == section_tags.last
# Don't create a section header for excluded tags
next unless filtered_tags.include?(tag)
older_tag = section_tags[i + 1]
tag_mapping[tag] = [older_tag, tag] tag_mapping[tag] = [older_tag, tag]
end end
tag_mapping tag_mapping
end end
# rubocop:enable Style/For
# Sort all tags by date, newest to oldest # Sort all tags by date, newest to oldest
def sort_tags_by_date(tags) def sort_tags_by_date(tags)
@ -113,12 +95,13 @@ module GitHubChangelogGenerator
sections.first["version"] if sections && sections.any? sections.first["version"] if sections && sections.any?
end end
# Return tags after filtering tags in lists provided by option: --exclude-tags # Return tags after filtering tags in lists provided by option: --between-tags & --exclude-tags
# #
# @return [Array] # @return [Array]
def get_filtered_tags(all_tags) def get_filtered_tags(all_tags)
filtered_tags = filter_since_tag(all_tags) filtered_tags = filter_since_tag(all_tags)
filter_due_tag(filtered_tags) filtered_tags = filter_due_tag(filtered_tags)
filter_between_tags(filtered_tags)
end end
# @param [Array] all_tags all tags # @param [Array] all_tags all tags
@ -129,8 +112,8 @@ module GitHubChangelogGenerator
if tag if tag
if all_tags.map { |t| t["name"] }.include? tag if all_tags.map { |t| t["name"] }.include? tag
idx = all_tags.index { |t| t["name"] == tag } idx = all_tags.index { |t| t["name"] == tag }
filtered_tags = if idx filtered_tags = if idx > 0
all_tags[0..idx] all_tags[0..idx - 1]
else else
[] []
end end
@ -161,6 +144,23 @@ module GitHubChangelogGenerator
filtered_tags filtered_tags
end end
# @param [Array] all_tags all tags
# @return [Array] filtered tags according :between_tags option
def filter_between_tags(all_tags)
filtered_tags = all_tags
tag_names = filtered_tags.map { |ft| ft["name"] }
if options[:between_tags]
options[:between_tags].each do |tag|
unless tag_names.include?(tag)
Helper.log.warn "Warning: can't find tag #{tag}, specified with --between-tags option."
end
end
filtered_tags = all_tags.select { |tag| options[:between_tags].include?(tag["name"]) }
end
filtered_tags
end
# @param [Array] all_tags all tags # @param [Array] all_tags all tags
# @return [Array] filtered tags according :exclude_tags or :exclude_tags_regex option # @return [Array] filtered tags according :exclude_tags or :exclude_tags_regex option
def filter_excluded_tags(all_tags) def filter_excluded_tags(all_tags)
@ -177,19 +177,18 @@ module GitHubChangelogGenerator
def apply_exclude_tags(all_tags) def apply_exclude_tags(all_tags)
if options[:exclude_tags].is_a?(Regexp) if options[:exclude_tags].is_a?(Regexp)
filter_tags_with_regex(all_tags, options[:exclude_tags], "--exclude-tags") filter_tags_with_regex(all_tags, options[:exclude_tags])
else else
filter_exact_tags(all_tags) filter_exact_tags(all_tags)
end end
end end
def apply_exclude_tags_regex(all_tags) def apply_exclude_tags_regex(all_tags)
regex = Regexp.new(options[:exclude_tags_regex]) filter_tags_with_regex(all_tags, Regexp.new(options[:exclude_tags_regex]))
filter_tags_with_regex(all_tags, regex, "--exclude-tags-regex")
end end
def filter_tags_with_regex(all_tags, regex, regex_option_name) def filter_tags_with_regex(all_tags, regex)
warn_if_nonmatching_regex(all_tags, regex, regex_option_name) warn_if_nonmatching_regex(all_tags)
all_tags.reject { |tag| regex =~ tag["name"] } all_tags.reject { |tag| regex =~ tag["name"] }
end end
@ -200,10 +199,11 @@ module GitHubChangelogGenerator
all_tags.reject { |tag| options[:exclude_tags].include?(tag["name"]) } all_tags.reject { |tag| options[:exclude_tags].include?(tag["name"]) }
end end
def warn_if_nonmatching_regex(all_tags, regex, regex_option_name) def warn_if_nonmatching_regex(all_tags)
unless all_tags.map { |t| t["name"] }.any? { |t| regex =~ t } unless all_tags.map { |t| t["name"] }.any? { |t| options[:exclude_tags] =~ t }
Helper.log.warn "Warning: unable to reject any tag, using regex "\ Helper.log.warn "Warning: unable to reject any tag, using regex "\
"#{regex.inspect} in #{regex_option_name} option." "#{options[:exclude_tags].inspect} in --exclude-tags "\
"option."
end end
end end

View File

@ -1,83 +0,0 @@
module GitHubChangelogGenerator
# This class generates the content for a single section of a changelog entry.
# It turns the tagged issues and PRs into a well-formatted list of changes to
# be later incorporated into a changelog entry.
#
# @see GitHubChangelogGenerator::Entry
class Section
attr_accessor :name, :prefix, :issues, :labels
def initialize(opts = {})
@name = opts[:name]
@prefix = opts[:prefix]
@labels = opts[:labels] || []
@issues = opts[:issues] || []
@options = opts[:options] || Options.new({})
end
# @param [Array] issues List of issues on sub-section
# @param [String] prefix Name of sub-section
# @return [String] Generate section content
def generate_content
content = ""
if @issues.any?
content += "#{@prefix}\n\n" unless @options[:simple_list]
@issues.each do |issue|
merge_string = get_string_for_issue(issue)
content += "- #{merge_string}\n"
end
content += "\n"
end
content
end
private
# Parse issue and generate single line formatted issue line.
#
# Example output:
# - Add coveralls integration [\#223](https://github.com/skywinder/github-changelog-generator/pull/223) (@skywinder)
#
# @param [Hash] issue Fetched issue from GitHub
# @return [String] Markdown-formatted single issue
def get_string_for_issue(issue)
encapsulated_title = encapsulate_string issue["title"]
title_with_number = "#{encapsulated_title} [\\##{issue['number']}](#{issue['html_url']})"
if @options[:issue_line_labels].present?
title_with_number = "#{title_with_number}#{line_labels_for(issue)}"
end
issue_line_with_user(title_with_number, issue)
end
def issue_line_with_user(line, issue)
return line if !@options[:author] || issue["pull_request"].nil?
user = issue["user"]
return "#{line} ({Null user})" unless user
if @options[:usernames_as_github_logins]
"#{line} (@#{user['login']})"
else
"#{line} ([#{user['login']}](#{user['html_url']}))"
end
end
ENCAPSULATED_CHARACTERS = %w(< > * _ \( \) [ ] #)
# Encapsulate characters to make Markdown look as expected.
#
# @param [String] string
# @return [String] encapsulated input string
def encapsulate_string(string)
string = string.gsub('\\', '\\\\')
ENCAPSULATED_CHARACTERS.each do |char|
string = string.gsub(char, "\\#{char}")
end
string
end
end
end

View File

@ -1,5 +1,4 @@
# frozen_string_literal: true # frozen_string_literal: true
require "logger" require "logger"
require "rainbow" require "rainbow"

View File

@ -1,5 +1,4 @@
# frozen_string_literal: true # frozen_string_literal: true
require "tmpdir" require "tmpdir"
require "retriable" require "retriable"
module GitHubChangelogGenerator module GitHubChangelogGenerator
@ -31,48 +30,37 @@ module GitHubChangelogGenerator
@project = @options[:project] @project = @options[:project]
@since = @options[:since] @since = @options[:since]
@http_cache = @options[:http_cache] @http_cache = @options[:http_cache]
@cache_file = nil if @http_cache
@cache_log = nil
prepare_cache
configure_octokit_ssl
@client = Octokit::Client.new(github_options)
end
def prepare_cache
return unless @http_cache
@cache_file = @options.fetch(:cache_file) { File.join(Dir.tmpdir, "github-changelog-http-cache") } @cache_file = @options.fetch(:cache_file) { File.join(Dir.tmpdir, "github-changelog-http-cache") }
@cache_log = @options.fetch(:cache_log) { File.join(Dir.tmpdir, "github-changelog-logger.log") } @cache_log = @options.fetch(:cache_log) { File.join(Dir.tmpdir, "github-changelog-logger.log") }
init_cache init_cache
end end
@github_token = fetch_github_token
def github_options @request_options = { per_page: PER_PAGE_NUMBER }
result = {} @github_options = {}
github_token = fetch_github_token @github_options[:access_token] = @github_token unless @github_token.nil?
result[:access_token] = github_token if github_token @github_options[:api_endpoint] = @options[:github_endpoint] unless @options[:github_endpoint].nil?
endpoint = @options[:github_endpoint]
result[:api_endpoint] = endpoint if endpoint
result
end
def configure_octokit_ssl @client = Octokit::Client.new(@github_options)
ca_file = @options[:ssl_ca_file] || ENV["SSL_CA_FILE"] || File.expand_path("../ssl_certs/cacert.pem", __FILE__)
Octokit.connection_options = { ssl: { ca_file: ca_file } }
end end
def init_cache def init_cache
Octokit.middleware = Faraday::RackBuilder.new do |builder| middleware_opts = {
builder.use(Faraday::HttpCache, serializer: Marshal, serializer: Marshal,
store: ActiveSupport::Cache::FileStore.new(@cache_file), store: ActiveSupport::Cache::FileStore.new(@cache_file),
logger: Logger.new(@cache_log), logger: Logger.new(@cache_log),
shared_cache: false) shared_cache: false
}
stack = Faraday::RackBuilder.new do |builder|
builder.use Faraday::HttpCache, middleware_opts
builder.use Octokit::Response::RaiseError builder.use Octokit::Response::RaiseError
builder.adapter Faraday.default_adapter builder.adapter Faraday.default_adapter
# builder.response :logger # builder.response :logger
end end
Octokit.middleware = stack
end end
DEFAULT_REQUEST_OPTIONS = { per_page: PER_PAGE_NUMBER }
# Fetch all tags from repo # Fetch all tags from repo
# #
# @return [Array <Hash>] array of tags # @return [Array <Hash>] array of tags
@ -88,7 +76,7 @@ module GitHubChangelogGenerator
def calculate_pages(client, method, request_options) def calculate_pages(client, method, request_options)
# Makes the first API call so that we can call last_response # Makes the first API call so that we can call last_response
check_github_response do check_github_response do
client.send(method, user_project, DEFAULT_REQUEST_OPTIONS.merge(request_options)) client.send(method, user_project, @request_options.merge(request_options))
end end
last_response = client.last_response last_response = client.last_response
@ -108,7 +96,7 @@ module GitHubChangelogGenerator
page_i = 0 page_i = 0
count_pages = calculate_pages(@client, "tags", {}) count_pages = calculate_pages(@client, "tags", {})
iterate_pages(@client, "tags") do |new_tags| iterate_pages(@client, "tags", {}) do |new_tags|
page_i += PER_PAGE_NUMBER page_i += PER_PAGE_NUMBER
print_in_same_line("Fetching tags... #{page_i}/#{count_pages * PER_PAGE_NUMBER}") print_in_same_line("Fetching tags... #{page_i}/#{count_pages * PER_PAGE_NUMBER}")
tags.concat(new_tags) tags.concat(new_tags)
@ -122,13 +110,8 @@ Make sure, that you push tags to remote repo via 'git push --tags'"
Helper.log.info "Found #{tags.count} tags" Helper.log.info "Found #{tags.count} tags"
end end
# tags are a Sawyer::Resource. Convert to hash # tags are a Sawyer::Resource. Convert to hash
tags.map { |resource| stringify_keys_deep(resource.to_hash) } tags = tags.map { |h| stringify_keys_deep(h.to_hash) }
end tags
def closed_pr_options
@closed_pr_options ||= {
filter: "all", labels: nil, state: "closed"
}.tap { |options| options[:since] = @since if @since }
end end
# This method fetch all closed issues and separate them to pull requests and pure issues # This method fetch all closed issues and separate them to pull requests and pure issues
@ -138,10 +121,17 @@ Make sure, that you push tags to remote repo via 'git push --tags'"
def fetch_closed_issues_and_pr def fetch_closed_issues_and_pr
print "Fetching closed issues...\r" if @options[:verbose] print "Fetching closed issues...\r" if @options[:verbose]
issues = [] issues = []
page_i = 0 options = {
count_pages = calculate_pages(@client, "issues", closed_pr_options) state: "closed",
filter: "all",
labels: nil
}
options[:since] = @since unless @since.nil?
iterate_pages(@client, "issues", closed_pr_options) do |new_issues| page_i = 0
count_pages = calculate_pages(@client, "issues", options)
iterate_pages(@client, "issues", options) do |new_issues|
page_i += PER_PAGE_NUMBER page_i += PER_PAGE_NUMBER
print_in_same_line("Fetching issues... #{page_i}/#{count_pages * PER_PAGE_NUMBER}") print_in_same_line("Fetching issues... #{page_i}/#{count_pages * PER_PAGE_NUMBER}")
issues.concat(new_issues) issues.concat(new_issues)
@ -150,9 +140,12 @@ Make sure, that you push tags to remote repo via 'git push --tags'"
print_empty_line print_empty_line
Helper.log.info "Received issues: #{issues.count}" Helper.log.info "Received issues: #{issues.count}"
issues = issues.map { |h| stringify_keys_deep(h.to_hash) }
# separate arrays of issues and pull requests: # separate arrays of issues and pull requests:
issues.map { |issue| stringify_keys_deep(issue.to_hash) } issues.partition do |x|
.partition { |issue_or_pr| issue_or_pr["pull_request"].nil? } x["pull_request"].nil?
end
end end
# Fetch all pull requests. We need them to detect :merged_at parameter # Fetch all pull requests. We need them to detect :merged_at parameter
@ -178,7 +171,8 @@ Make sure, that you push tags to remote repo via 'git push --tags'"
print_empty_line print_empty_line
Helper.log.info "Pull Request count: #{pull_requests.count}" Helper.log.info "Pull Request count: #{pull_requests.count}"
pull_requests.map { |pull_request| stringify_keys_deep(pull_request.to_hash) } pull_requests = pull_requests.map { |h| stringify_keys_deep(h.to_hash) }
pull_requests
end end
# Fetch event for all issues and add them to 'events' # Fetch event for all issues and add them to 'events'
@ -193,10 +187,10 @@ Make sure, that you push tags to remote repo via 'git push --tags'"
issues_slice.each do |issue| issues_slice.each do |issue|
threads << Thread.new do threads << Thread.new do
issue["events"] = [] issue["events"] = []
iterate_pages(@client, "issue_events", issue["number"]) do |new_event| iterate_pages(@client, "issue_events", issue["number"], {}) do |new_event|
issue["events"].concat(new_event) issue["events"].concat(new_event)
end end
issue["events"] = issue["events"].map { |event| stringify_keys_deep(event.to_hash) } issue["events"] = issue["events"].map { |h| stringify_keys_deep(h.to_hash) }
print_in_same_line("Fetching events for issues and PR: #{i + 1}/#{issues.count}") print_in_same_line("Fetching events for issues and PR: #{i + 1}/#{issues.count}")
i += 1 i += 1
end end
@ -234,17 +228,6 @@ Make sure, that you push tags to remote repo via 'git push --tags'"
end end
end end
# Fetch all commits before certain point
#
# @return [String]
def commits_before(start_time)
commits = []
iterate_pages(@client, "commits_before", start_time.to_datetime.to_s) do |new_commits|
commits.concat(new_commits)
end
commits
end
private private
def stringify_keys_deep(indata) def stringify_keys_deep(indata)
@ -254,15 +237,14 @@ Make sure, that you push tags to remote repo via 'git push --tags'"
stringify_keys_deep(value) stringify_keys_deep(value)
end end
when Hash when Hash
indata.each_with_object({}) do |(key, value), output| indata.each_with_object({}) do |(k, v), output|
output[key.to_s] = stringify_keys_deep(value) output[k.to_s] = stringify_keys_deep(v)
end end
else else
indata indata
end end
end end
# Exception raised to warn about moved repositories.
MovedPermanentlyError = Class.new(RuntimeError) MovedPermanentlyError = Class.new(RuntimeError)
# Iterates through all pages until there are no more :next pages to follow # Iterates through all pages until there are no more :next pages to follow
@ -273,21 +255,29 @@ Make sure, that you push tags to remote repo via 'git push --tags'"
# #
# @yield [Sawyer::Resource] An OctoKit-provided response (which can be empty) # @yield [Sawyer::Resource] An OctoKit-provided response (which can be empty)
# #
# @return [void] # @return [Integer] total number of pages
def iterate_pages(client, method, *args) def iterate_pages(client, method, *args)
args << DEFAULT_REQUEST_OPTIONS.merge(extract_request_args(args)) request_opts = extract_request_args(args)
args.push(@request_options.merge(request_opts))
number_of_pages = 1
check_github_response { client.send(method, user_project, *args) } check_github_response { client.send(method, user_project, *args) }
last_response = client.last_response.tap do |response| last_response = client.last_response
raise(MovedPermanentlyError, response.data[:url]) if response.status == 301 if last_response.status == 301
raise MovedPermanentlyError, last_response.data[:url]
end end
yield(last_response.data) yield(last_response.data)
until (next_one = last_response.rels[:next]).nil? until (next_one = last_response.rels[:next]).nil?
number_of_pages += 1
last_response = check_github_response { next_one.get } last_response = check_github_response { next_one.get }
yield(last_response.data) yield(last_response.data)
end end
number_of_pages
end end
def extract_request_args(args) def extract_request_args(args)
@ -308,17 +298,14 @@ Make sure, that you push tags to remote repo via 'git push --tags'"
yield yield
end end
rescue MovedPermanentlyError => e rescue MovedPermanentlyError => e
fail_with_message(e, "The repository has moved, update your configuration")
rescue Octokit::Forbidden => e
fail_with_message(e, "Exceeded retry limit")
rescue Octokit::Unauthorized => e
fail_with_message(e, "Error: wrong GitHub token")
end
# Presents the exception, and the aborts with the message.
def fail_with_message(e, message)
Helper.log.error("#{e.class}: #{e.message}") Helper.log.error("#{e.class}: #{e.message}")
sys_abort(message) sys_abort("The repository has moved, please update your configuration")
rescue Octokit::Forbidden => e
Helper.log.error("#{e.class}: #{e.message}")
sys_abort("Exceeded retry limit")
rescue Octokit::Unauthorized => e
Helper.log.error("#{e.class}: #{e.message}")
sys_abort("Error: wrong GitHub token")
end end
# Exponential backoff # Exponential backoff
@ -367,7 +354,7 @@ Make sure, that you push tags to remote repo via 'git push --tags'"
# #
# @return [String] # @return [String]
def fetch_github_token def fetch_github_token
env_var = @options[:token].presence || ENV["CHANGELOG_GITHUB_TOKEN"] env_var = @options[:token] ? @options[:token] : (ENV.fetch CHANGELOG_GITHUB_TOKEN, nil)
Helper.log.warn NO_TOKEN_PROVIDED unless env_var Helper.log.warn NO_TOKEN_PROVIDED unless env_var

View File

@ -1,130 +1,77 @@
# frozen_string_literal: true # frozen_string_literal: true
require "delegate" require "delegate"
require "github_changelog_generator/helper"
module GitHubChangelogGenerator module GitHubChangelogGenerator
# This class wraps Options, and knows a list of known options. Others options
# will raise exceptions.
class Options < SimpleDelegator class Options < SimpleDelegator
# Raised on intializing with unknown keys in the values hash,
# and when trying to store a value on an unknown key.
UnsupportedOptionError = Class.new(ArgumentError) UnsupportedOptionError = Class.new(ArgumentError)
# List of valid option names KNOWN_OPTIONS = [
KNOWN_OPTIONS = %i[ :add_issues_wo_labels,
add_issues_wo_labels :add_pr_wo_labels,
add_pr_wo_labels :author,
add_sections :base,
author :between_tags,
base :bug_labels,
between_tags :bug_prefix,
bug_labels :cache_file,
bug_prefix :cache_log,
cache_file :compare_link,
cache_log :date_format,
compare_link :due_tag,
date_format :enhancement_labels,
due_tag :enhancement_prefix,
enhancement_labels :exclude_labels,
enhancement_prefix :exclude_tags,
breaking_labels :exclude_tags_regex,
breaking_prefix :filter_issues_by_milestone,
configure_sections :frontmatter,
exclude_labels :future_release,
exclude_tags :git_remote,
exclude_tags_regex :github_endpoint,
filter_issues_by_milestone :github_site,
frontmatter :header,
future_release :http_cache,
github_endpoint :include_labels,
github_site :issue_prefix,
header :issue_line_labels,
http_cache :issues,
include_labels :max_issues,
issue_prefix :merge_prefix,
issue_line_labels :output,
issues :project,
max_issues :pulls,
merge_prefix :release_branch,
output :release_url,
project :simple_list,
pulls :since_tag,
release_branch :token,
release_url :unreleased,
require :unreleased_label,
simple_list :unreleased_only,
since_tag :user,
ssl_ca_file :usernames_as_github_logins,
token :verbose
unreleased
unreleased_label
unreleased_only
user
usernames_as_github_logins
verbose
] ]
# @param values [Hash]
#
# @raise [UnsupportedOptionError] if given values contain unknown options
def initialize(values) def initialize(values)
super(values) super(values)
unsupported_options.any? && raise(UnsupportedOptionError, unsupported_options.inspect) unsupported_options.any? && raise(UnsupportedOptionError, unsupported_options.inspect)
end end
# Set option key to val.
#
# @param key [Symbol]
# @param val [Object]
#
# @raise [UnsupportedOptionError] when trying to set an unknown option
def []=(key, val) def []=(key, val)
supported_option?(key) || raise(UnsupportedOptionError, key.inspect) supported_option?(key) || raise(UnsupportedOptionError, key.inspect)
values[key] = val values[key] = val
end end
# @return [Hash]
def to_hash def to_hash
values values
end end
# Loads the configured Ruby files from the --require option.
def load_custom_ruby_files
self[:require].each { |f| require f }
end
# Pretty-prints a censored options hash, if :verbose.
def print_options
return unless self[:verbose]
Helper.log.info "Using these options:"
pp(censored_values)
puts ""
end
# Boolean method for whether the user is using configure_sections
def configure_sections?
!self[:configure_sections].nil? && !self[:configure_sections].empty?
end
# Boolean method for whether the user is using add_sections
def add_sections?
!self[:add_sections].nil? && !self[:add_sections].empty?
end
private private
def values def values
__getobj__ __getobj__
end end
# Returns a censored options hash.
#
# @return [Hash] The GitHub `:token` key is censored in the output.
def censored_values
values.clone.tap { |opts| opts[:token] = opts[:token].nil? ? "No token used" : "hidden value" }
end
def unsupported_options def unsupported_options
values.keys - KNOWN_OPTIONS values.keys - KNOWN_OPTIONS
end end

View File

@ -1,11 +1,9 @@
#!/usr/bin/env ruby #!/usr/bin/env ruby
# frozen_string_literal: true # frozen_string_literal: true
require "optparse" require "optparse"
require "pp" require "pp"
require "github_changelog_generator/version" require_relative "version"
require "github_changelog_generator/helper" require_relative "helper"
module GitHubChangelogGenerator module GitHubChangelogGenerator
class Parser class Parser
# parse options with optparse # parse options with optparse
@ -15,39 +13,47 @@ module GitHubChangelogGenerator
ParserFile.new(options).parse! ParserFile.new(options).parse!
parser = setup_parser(options) parser = setup_parser(options)
begin parser.parse! parser.parse!
rescue OptionParser::InvalidOption => e
abort [e, parser].join("\n")
end
unless options[:user] && options[:project] fetch_user_and_project(options)
warn "Configure which user and project to work on."
warn "Options --user and --project, or settings to that effect. See --help for more."
abort(parser.banner)
end
options.print_options abort(parser.banner) unless options[:user] && options[:project]
print_options(options)
options options
end end
# Setup parsing options # If options set to verbose, print the parsed options.
# #
# @param options [Options] # The GitHub `:token` key is censored in the output.
# @return [OptionParser] #
# @param options [Hash] The options to display
# @option options [Boolean] :verbose If false this method does nothing
def self.print_options(options)
if options[:verbose]
Helper.log.info "Performing task with options:"
options_to_display = options.clone
options_to_display[:token] = options_to_display[:token].nil? ? nil : "hidden value"
pp options_to_display
puts ""
end
end
# setup parsing options
def self.setup_parser(options) def self.setup_parser(options)
OptionParser.new do |opts| # rubocop:disable Metrics/BlockLength parser = OptionParser.new do |opts| # rubocop:disable Metrics/BlockLength
opts.banner = "Usage: github_changelog_generator --user USER --project PROJECT [options]" opts.banner = "Usage: github_changelog_generator [options]"
opts.on("-u", "--user USER", "Username of the owner of target GitHub repo") do |last| opts.on("-u", "--user [USER]", "Username of the owner of target GitHub repo") do |last|
options[:user] = last options[:user] = last
end end
opts.on("-p", "--project PROJECT", "Name of project on GitHub") do |last| opts.on("-p", "--project [PROJECT]", "Name of project on GitHub") do |last|
options[:project] = last options[:project] = last
end end
opts.on("-t", "--token [TOKEN]", "To make more than 50 requests per hour your GitHub token is required. You can generate it at: https://github.com/settings/tokens/new") do |last| opts.on("-t", "--token [TOKEN]", "To make more than 50 requests per hour your GitHub token is required. You can generate it at: https://github.com/settings/tokens/new") do |last|
options[:token] = last options[:token] = last
end end
opts.on("-f", "--date-format FORMAT", "Date format. Default is %Y-%m-%d") do |last| opts.on("-f", "--date-format [FORMAT]", "Date format. Default is %Y-%m-%d") do |last|
options[:date_format] = last options[:date_format] = last
end end
opts.on("-o", "--output [NAME]", "Output file. Default is CHANGELOG.md") do |last| opts.on("-o", "--output [NAME]", "Output file. Default is CHANGELOG.md") do |last|
@ -62,21 +68,12 @@ module GitHubChangelogGenerator
opts.on("--enhancement-label [LABEL]", "Setup custom label for enhancements section. Default is \"**Implemented enhancements:**\"") do |v| opts.on("--enhancement-label [LABEL]", "Setup custom label for enhancements section. Default is \"**Implemented enhancements:**\"") do |v|
options[:enhancement_prefix] = v options[:enhancement_prefix] = v
end end
opts.on("--breaking-label [LABEL]", "Setup custom label for the breaking changes section. Default is \"**Breaking changes:**\"") do |v|
options[:breaking_prefix] = v
end
opts.on("--issues-label [LABEL]", "Setup custom label for closed-issues section. Default is \"**Closed issues:**\"") do |v| opts.on("--issues-label [LABEL]", "Setup custom label for closed-issues section. Default is \"**Closed issues:**\"") do |v|
options[:issue_prefix] = v options[:issue_prefix] = v
end end
opts.on("--header-label [LABEL]", "Setup custom header label. Default is \"# Changelog\"") 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("--configure-sections [Hash, String]", "Define your own set of sections which overrides all default sections") do |v|
options[:configure_sections] = v
end
opts.on("--add-sections [Hash, String]", "Add new sections but keep the default sections") do |v|
options[:add_sections] = v
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| 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" options[:frontmatter] = JSON.parse(v).to_yaml + "---\n"
end end
@ -119,7 +116,7 @@ module GitHubChangelogGenerator
opts.on("--include-labels x,y,z", Array, "Only issues with the specified labels will be included in the changelog.") do |list| opts.on("--include-labels x,y,z", Array, "Only issues with the specified labels will be included in the changelog.") do |list|
options[:include_labels] = list options[:include_labels] = list
end end
opts.on("--exclude-labels x,y,z", Array, "Issues with the specified labels will be always excluded from changelog. Default is 'duplicate,question,invalid,wontfix'") do |list| opts.on("--exclude-labels x,y,z", Array, 'Issues with the specified labels will be always excluded from changelog. Default is \'duplicate,question,invalid,wontfix\'') do |list|
options[:exclude_labels] = list options[:exclude_labels] = list
end end
opts.on("--bug-labels x,y,z", Array, 'Issues with the specified labels will be always added to "Fixed bugs" section. Default is \'bug,Bug\'') do |list| opts.on("--bug-labels x,y,z", Array, 'Issues with the specified labels will be always added to "Fixed bugs" section. Default is \'bug,Bug\'') do |list|
@ -128,12 +125,12 @@ module GitHubChangelogGenerator
opts.on("--enhancement-labels x,y,z", Array, 'Issues with the specified labels will be always added to "Implemented enhancements" section. Default is \'enhancement,Enhancement\'') do |list| opts.on("--enhancement-labels x,y,z", Array, 'Issues with the specified labels will be always added to "Implemented enhancements" section. Default is \'enhancement,Enhancement\'') do |list|
options[:enhancement_labels] = list options[:enhancement_labels] = list
end end
opts.on("--breaking-labels x,y,z", Array, 'Issues with these labels will be added to a new section, called "Breaking Changes". Default is \'backwards-incompatible\'') do |list|
options[:breaking_labels] = list
end
opts.on("--issue-line-labels x,y,z", Array, 'The specified labels will be shown in brackets next to each matching issue. Use "ALL" to show all labels. Default is [].') do |list| opts.on("--issue-line-labels x,y,z", Array, 'The specified labels will be shown in brackets next to each matching issue. Use "ALL" to show all labels. Default is [].') do |list|
options[:issue_line_labels] = list options[:issue_line_labels] = list
end end
opts.on("--between-tags x,y,z", Array, "Change log will be filled only between specified tags") do |list|
options[:between_tags] = list
end
opts.on("--exclude-tags x,y,z", Array, "Change log will exclude specified tags") do |list| opts.on("--exclude-tags x,y,z", Array, "Change log will exclude specified tags") do |list|
options[:exclude_tags] = list options[:exclude_tags] = list
end end
@ -176,12 +173,6 @@ module GitHubChangelogGenerator
opts.on("--cache-log [CACHE-LOG]", "Filename to use for cache log. Default is github-changelog-logger.log in a temporary directory.") do |cache_log| opts.on("--cache-log [CACHE-LOG]", "Filename to use for cache log. Default is github-changelog-logger.log in a temporary directory.") do |cache_log|
options[:cache_log] = cache_log options[:cache_log] = cache_log
end end
opts.on("--ssl-ca-file [PATH]", "Path to cacert.pem file. Default is a bundled lib/github_changelog_generator/ssl_certs/cacert.pem. Respects SSL_CA_PATH.") do |ssl_ca_file|
options[:ssl_ca_file] = ssl_ca_file
end
opts.on("--require x,y,z", Array, "Path to Ruby file(s) to require.") do |paths|
options[:require] = paths
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
@ -194,9 +185,10 @@ module GitHubChangelogGenerator
exit exit
end end
end end
parser
end end
# @return [Options] Default options # @return [Hash] Default options
def self.default_options def self.default_options
Options.new( Options.new(
date_format: "%Y-%m-%d", date_format: "%Y-%m-%d",
@ -211,26 +203,126 @@ module GitHubChangelogGenerator
unreleased: true, unreleased: true,
unreleased_label: "Unreleased", unreleased_label: "Unreleased",
compare_link: true, compare_link: true,
enhancement_labels: ["enhancement", "Enhancement", "Type: Enhancement"], enhancement_labels: %w(enhancement Enhancement),
bug_labels: ["bug", "Bug", "Type: Bug"], bug_labels: %w(bug Bug),
exclude_labels: ["duplicate", "question", "invalid", "wontfix", "Duplicate", "Question", "Invalid", "Wontfix", "Meta: Exclude From Changelog"], exclude_labels: %w(duplicate question invalid wontfix Duplicate Question Invalid Wontfix),
breaking_labels: %w[backwards-incompatible breaking],
configure_sections: {},
add_sections: {},
issue_line_labels: [], issue_line_labels: [],
max_issues: nil, max_issues: nil,
simple_list: false, simple_list: false,
ssl_ca_file: nil,
verbose: true, verbose: true,
header: "# Changelog", header: "# Change Log",
merge_prefix: "**Merged pull requests:**", merge_prefix: "**Merged pull requests:**",
issue_prefix: "**Closed issues:**", issue_prefix: "**Closed issues:**",
bug_prefix: "**Fixed bugs:**", bug_prefix: "**Fixed bugs:**",
enhancement_prefix: "**Implemented enhancements:**", enhancement_prefix: "**Implemented enhancements:**",
breaking_prefix: "**Breaking changes:**", git_remote: "origin",
http_cache: true, http_cache: true
require: []
) )
end end
# If `:user` or `:project` not set in options, try setting them
# Valid unnamed parameters:
# 1) in 1 param: repo_name/project
# 2) in 2 params: repo name project
def self.fetch_user_and_project(options)
if options[:user].nil? || options[:project].nil?
user, project = user_and_project_from_git(options, ARGV[0], ARGV[1])
options[:user] ||= user
options[:project] ||= project
end
end
# Sets `:user` and `:project` in `options` from CLI arguments or `git remote`
# @param [String] arg0 first argument in cli
# @param [String] arg1 second argument in cli
# @return [Array<String>] user and project, or nil if unsuccessful
def self.user_and_project_from_git(options, arg0 = nil, arg1 = nil)
user, project = user_project_from_option(arg0, arg1, options[:github_site])
unless user && project
if ENV["RUBYLIB"] =~ /ruby-debug-ide/
user = "skywinder"
project = "changelog_test"
else
remote = `git config --get remote.#{options[:git_remote]}.url`
user, project = user_project_from_remote(remote)
end
end
[user, project]
end
# Returns GitHub username and project from CLI arguments
#
# @param arg0 [String] This parameter takes two forms: Either a full
# GitHub URL, or a 'username/projectname', or
# simply a GitHub username
# @param arg1 [String] If arg0 is given as a username,
# then arg1 can given as a projectname
# @param github_site [String] Domain name of GitHub site
#
# @return [Array, nil] user and project, or nil if unsuccessful
def self.user_project_from_option(arg0, arg1, github_site)
user = nil
project = nil
github_site ||= "github.com"
if arg0 && !arg1
# this match should parse strings such "https://github.com/skywinder/Github-Changelog-Generator" or
# "skywinder/Github-Changelog-Generator" to user and name
match = /(?:.+#{Regexp.escape(github_site)}\/)?(.+)\/(.+)/.match(arg0)
begin
param = match[2].nil?
rescue
puts "Can't detect user and name from first parameter: '#{arg0}' -> exit'"
return
end
if param
return
else
user = match[1]
project = match[2]
end
end
[user, project]
end
# These patterns match these formats:
#
# ```
# origin git@github.com:skywinder/Github-Changelog-Generator.git (fetch)
# git@github.com:skywinder/Github-Changelog-Generator.git
# ```
#
# and
#
# ```
# origin https://github.com/skywinder/ChangelogMerger (fetch)
# https://github.com/skywinder/ChangelogMerger
# ```
GIT_REMOTE_PATTERNS = [
/.*(?:[:\/])(?<user>(?:-|\w|\.)*)\/(?<project>(?:-|\w|\.)*)(?:\.git).*/,
/.*\/(?<user>(?:-|\w|\.)*)\/(?<project>(?:-|\w|\.)*).*/
]
# Returns GitHub username and project from git remote output
#
# @param git_remote_output [String] Output of git remote command
#
# @return [Array] user and project
def self.user_project_from_remote(git_remote_output)
user = nil
project = nil
GIT_REMOTE_PATTERNS.each do |git_remote_pattern|
git_remote_pattern =~ git_remote_output
if Regexp.last_match
user = Regexp.last_match(:user)
project = Regexp.last_match(:project)
break
end
end
[user, project]
end
end end
end end

View File

@ -1,5 +1,4 @@
# frozen_string_literal: true # frozen_string_literal: true
require "pathname" require "pathname"
module GitHubChangelogGenerator module GitHubChangelogGenerator
@ -48,7 +47,7 @@ module GitHubChangelogGenerator
return if non_configuration_line?(line) return if non_configuration_line?(line)
option_name, value = extract_pair(line) option_name, value = extract_pair(line)
@options[option_key_for(option_name)] = convert_value(value, option_name) @options[option_key_for(option_name)] = convert_value(value, option_name)
rescue StandardError rescue
raise ParserError, "Failed on line ##{line_number}: \"#{line.gsub(/[\n\r]+/, '')}\"" raise ParserError, "Failed on line ##{line_number}: \"#{line.gsub(/[\n\r]+/, '')}\""
end end
@ -66,8 +65,8 @@ module GitHubChangelogGenerator
[key.tr("-", "_").to_sym, value.gsub(/[\n\r]+/, "")] [key.tr("-", "_").to_sym, value.gsub(/[\n\r]+/, "")]
end end
KNOWN_ARRAY_KEYS = %i[exclude_labels include_labels bug_labels KNOWN_ARRAY_KEYS = [:exclude_labels, :include_labels, :bug_labels,
enhancement_labels breaking_labels issue_line_labels between_tags exclude_tags] :enhancement_labels, :issue_line_labels, :between_tags, :exclude_tags]
KNOWN_INTEGER_KEYS = [:max_issues] KNOWN_INTEGER_KEYS = [:max_issues]
def convert_value(value, option_name) def convert_value(value, option_name)
@ -91,7 +90,6 @@ module GitHubChangelogGenerator
header_label: :header, header_label: :header,
front_matter: :frontmatter, front_matter: :frontmatter,
pr_label: :merge_prefix, pr_label: :merge_prefix,
breaking_label: :breaking_prefix,
issues_wo_labels: :add_issues_wo_labels, issues_wo_labels: :add_issues_wo_labels,
pr_wo_labels: :add_pr_wo_labels, pr_wo_labels: :add_pr_wo_labels,
pull_requests: :pulls, pull_requests: :pulls,

View File

@ -1,5 +1,4 @@
# frozen_string_literal: true # frozen_string_literal: true
# #
# Author:: Enrico Stahn <mail@enricostahn.com> # Author:: Enrico Stahn <mail@enricostahn.com>
# #

File diff suppressed because it is too large Load Diff

View File

@ -1,5 +1,4 @@
# frozen_string_literal: true # frozen_string_literal: true
require "rake" require "rake"
require "rake/tasklib" require "rake/tasklib"
require "github_changelog_generator" require "github_changelog_generator"
@ -8,7 +7,7 @@ module GitHubChangelogGenerator
class RakeTask < ::Rake::TaskLib class RakeTask < ::Rake::TaskLib
include ::Rake::DSL if defined?(::Rake::DSL) include ::Rake::DSL if defined?(::Rake::DSL)
OPTIONS = %w[ user project token date_format output OPTIONS = %w( user project token date_format output
bug_prefix enhancement_prefix issue_prefix bug_prefix enhancement_prefix issue_prefix
header merge_prefix issues header merge_prefix issues
add_issues_wo_labels add_pr_wo_labels add_issues_wo_labels add_pr_wo_labels
@ -19,7 +18,7 @@ module GitHubChangelogGenerator
between_tags exclude_tags exclude_tags_regex since_tag max_issues between_tags exclude_tags exclude_tags_regex 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 release_branch verbose release_url
base configure_sections add_sections] base )
OPTIONS.each do |o| OPTIONS.each do |o|
attr_accessor o.to_sym attr_accessor o.to_sym
@ -48,11 +47,13 @@ module GitHubChangelogGenerator
# mimick parse_options # mimick parse_options
options = Parser.default_options options = Parser.default_options
Parser.fetch_user_and_project(options)
OPTIONS.each do |o| OPTIONS.each do |o|
v = instance_variable_get("@#{o}") v = instance_variable_get("@#{o}")
options[o.to_sym] = v unless v.nil? options[o.to_sym] = v unless v.nil?
end end
abort "user and project are required." unless options[:user] && options[:project]
generator = Generator.new options generator = Generator.new options
log = generator.compound_changelog log = generator.compound_changelog

View File

@ -1,5 +1,4 @@
# frozen_string_literal: true # frozen_string_literal: true
module GitHubChangelogGenerator module GitHubChangelogGenerator
VERSION = "1.15.0-rc" VERSION = "1.14.3"
end end

View File

@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3 .\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3
. .
.TH "GIT\-GENERATE\-CHANGELOG" "1" "December 2017" "" "" .TH "GIT\-GENERATE\-CHANGELOG" "1" "December 2016" "" ""
. .
.SH "NAME" .SH "NAME"
\fBgit\-generate\-changelog\fR \- Generate changelog from github \fBgit\-generate\-changelog\fR \- Generate changelog from github
@ -70,7 +70,7 @@ Setup custom label for closed\-issues section\. Default is "\fBClosed issues:\fR
\-\-header\-label [LABEL] \-\-header\-label [LABEL]
. .
.P .P
Setup custom header label\. Default is "# Changelog" Setup custom header label\. Default is "# Change Log"
. .
.P .P
\-\-front\-matter [JSON] \-\-front\-matter [JSON]
@ -175,6 +175,12 @@ Issues with the specified labels will be always added to "Fixed bugs" section\.
Issues with the specified labels will be always added to "Implemented enhancements" section\. Default is \'enhancement,Enhancement\' Issues with the specified labels will be always added to "Implemented enhancements" section\. Default is \'enhancement,Enhancement\'
. .
.P .P
\-\-between\-tags x,y,z
.
.P
Change log will be filled only between specified tags
.
.P
\-\-exclude\-tags x,y,z \-\-exclude\-tags x,y,z
. .
.P .P
@ -258,25 +264,6 @@ Filename to use for cache\. Default is github\-changelog\-http\-cache in a tempo
.P .P
Filename to use for cache log\. Default is github\-changelog\-logger\.log in a temporary directory\. Filename to use for cache log\. Default is github\-changelog\-logger\.log in a temporary directory\.
. .
.IP "" 4
.
.nf
\-\-ssl\-ca\-file [PATH]
.
.fi
.
.IP "" 0
.
.P
Path to cacert\.pem file\. Default is a bundled lib/github_changelog_generator/ssl_certs/cacert\.pem\. Respects SSL_CA_PATH\.
.
.P
\-\-require file1\.rb,file2\.rb
.
.P
Paths to Ruby file(s) to require before generating changelog\.
.
.P .P
\-\-[no\-]verbose \-\-[no\-]verbose
. .
@ -284,18 +271,6 @@ Paths to Ruby file(s) to require before generating changelog\.
Run verbosely\. Default is true Run verbosely\. Default is true
. .
.P .P
\-\-configure\-sections [HASH, STRING]
.
.P
Define your own set of sections which overrides all default sections") do |v|
.
.P
\-\-add\-sections [HASH, STRING]
.
.P
Add new sections but keep the default sections"
.
.P
\-v, \-\-version \-v, \-\-version
. .
.P .P

View File

@ -122,7 +122,7 @@
<p> --header-label [LABEL]</p> <p> --header-label [LABEL]</p>
<p> Setup custom header label. Default is "# Changelog"</p> <p> Setup custom header label. Default is "# Change Log"</p>
<p> --front-matter [JSON]</p> <p> --front-matter [JSON]</p>
@ -192,6 +192,10 @@
<p> Issues with the specified labels will be always added to "Implemented enhancements" section. Default is 'enhancement,Enhancement'</p> <p> Issues with the specified labels will be always added to "Implemented enhancements" section. Default is 'enhancement,Enhancement'</p>
<p> --between-tags x,y,z</p>
<p> Change log will be filled only between specified tags</p>
<p> --exclude-tags x,y,z</p> <p> --exclude-tags x,y,z</p>
<p> Change log will exclude specified tags</p> <p> Change log will exclude specified tags</p>
@ -248,27 +252,10 @@
<p> Filename to use for cache log. Default is github-changelog-logger.log in a temporary directory.</p> <p> Filename to use for cache log. Default is github-changelog-logger.log in a temporary directory.</p>
<pre><code>--ssl-ca-file [PATH]
</code></pre>
<p> Path to cacert.pem file. Default is a bundled lib/github_changelog_generator/ssl_certs/cacert.pem. Respects SSL_CA_PATH.</p>
<p> --require file1.rb,file2.rb</p>
<p> Paths to Ruby file(s) to require before generating changelog.</p>
<p> --[no-]verbose</p> <p> --[no-]verbose</p>
<p> Run verbosely. Default is true</p> <p> Run verbosely. Default is true</p>
<p> --configure-sections [HASH, STRING]</p>
<p> Define your own set of sections which overrides all default sections") do |v|</p>
<p> --add-sections [HASH, STRING]</p>
<p> Add new sections but keep the default sections"</p>
<p> -v, --version</p> <p> -v, --version</p>
<p> Print version number</p> <p> Print version number</p>
@ -294,7 +281,7 @@
<ol class='man-decor man-foot man foot'> <ol class='man-decor man-foot man foot'>
<li class='tl'></li> <li class='tl'></li>
<li class='tc'>December 2017</li> <li class='tc'>December 2016</li>
<li class='tr'>git-generate-changelog(1)</li> <li class='tr'>git-generate-changelog(1)</li>
</ol> </ol>

View File

@ -122,7 +122,7 @@
<p> --header-label [LABEL]</p> <p> --header-label [LABEL]</p>
<p> Setup custom header label. Default is "# Changelog"</p> <p> Setup custom header label. Default is "# Change Log"</p>
<p> --pr-label [LABEL]</p> <p> --pr-label [LABEL]</p>
@ -184,6 +184,10 @@
<p> Issues with the specified labels will be always added to "Implemented enhancements" section. Default is 'enhancement,Enhancement'</p> <p> Issues with the specified labels will be always added to "Implemented enhancements" section. Default is 'enhancement,Enhancement'</p>
<p> --between-tags x,y,z</p>
<p> Change log will be filled only between specified tags</p>
<p> --exclude-tags x,y,z</p> <p> --exclude-tags x,y,z</p>
<p> Change log will exclude specified tags</p> <p> Change log will exclude specified tags</p>
@ -220,18 +224,6 @@
<p> Put the unreleased changes in the specified release number.</p> <p> Put the unreleased changes in the specified release number.</p>
<p> --configure-sections [HASH, STRING]</p>
<p> Define your own set of sections which overrides all default sections") do |v|</p>
<p> --add-sections [HASH, STRING]</p>
<p> Add new sections but keep the default sections"</p>
<p> --include-merged</p>
<p> If configure_sections is set, use this to restore the merged pull requests sections</p>
<p> --[no-]verbose</p> <p> --[no-]verbose</p>
<p> Run verbosely. Default is true</p> <p> Run verbosely. Default is true</p>

View File

@ -1,4 +1,4 @@
git-generate-changelog(1) - Generate changelog from GitHub git-generate-changelog(1) - Generate changelog from github
================================ ================================
## SYNOPSIS ## SYNOPSIS
@ -49,7 +49,7 @@ Automatically generate changelog from your tags, issues, labels and pull request
--header-label [LABEL] --header-label [LABEL]
Setup custom header label. Default is "# Changelog" Setup custom header label. Default is "# Change Log"
--front-matter [JSON] --front-matter [JSON]
@ -119,6 +119,10 @@ Automatically generate changelog from your tags, issues, labels and pull request
Issues with the specified labels will be always added to "Implemented enhancements" section. Default is 'enhancement,Enhancement' Issues with the specified labels will be always added to "Implemented enhancements" section. Default is 'enhancement,Enhancement'
--between-tags x,y,z
Change log will be filled only between specified tags
--exclude-tags x,y,z --exclude-tags x,y,z
Change log will exclude specified tags Change log will exclude specified tags
@ -175,26 +179,10 @@ Automatically generate changelog from your tags, issues, labels and pull request
Filename to use for cache log. Default is github-changelog-logger.log in a temporary directory. Filename to use for cache log. Default is github-changelog-logger.log in a temporary directory.
--ssl-ca-file [PATH]
Path to cacert.pem file. Default is a bundled lib/github_changelog_generator/ssl_certs/cacert.pem. Respects SSL_CA_PATH.
--require file1.rb,file2.rb
Paths to Ruby file(s) to require before generating changelog.
--[no-]verbose --[no-]verbose
Run verbosely. Default is true Run verbosely. Default is true
--configure-sections [HASH, STRING]
Define your own set of sections which overrides all default sections") do |v|
--add-sections [HASH, STRING]
Add new sections but keep the default sections"
-v, --version -v, --version
Print version number Print version number

View File

@ -1,4 +1,4 @@
# Changelog # Change Log
## [1.3.10](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.10) (2015-03-18) ## [1.3.10](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.10) (2015-03-18)
@ -302,4 +302,4 @@
\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)* \* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

View File

@ -1,5 +1,4 @@
# frozen_string_literal: true # frozen_string_literal: true
# #
# Author:: Enrico Stahn <mail@enricostahn.com> # Author:: Enrico Stahn <mail@enricostahn.com>
# #

View File

@ -1,362 +0,0 @@
# frozen_string_literal: true
# rubocop:disable Metrics/ModuleLength
module GitHubChangelogGenerator
RSpec.describe Entry do
def label(name)
{ "name" => name }
end
def issue(title, labels, number = "1", user = { "login" => "user" })
{
"title" => "issue #{title}",
"labels" => labels.map { |l| label(l) },
"number" => number,
"html_url" => "https://github.com/owner/repo/issue/#{number}",
"user" => user
}
end
def pr(title, labels, number = "1", user = { "login" => "user" })
{
"pull_request" => true,
"title" => "pr #{title}",
"labels" => labels.map { |l| label(l) },
"number" => number,
"html_url" => "https://github.com/owner/repo/pull/#{number}",
"user" => user.merge("html_url" => "https://github.com/#{user['login']}")
}
end
def titles_for(issues)
issues.map { |issue| issue["title"] }
end
def default_sections
%w[enhancements bugs breaking issues]
end
describe "#create_entry_for_tag" do
let(:options) do
Parser.default_options.merge(
user: "owner",
project: "repo",
bug_labels: ["bug"],
enhancement_labels: ["enhancement"],
breaking_labels: ["breaking"]
)
end
let(:issues) do
[
issue("no labels", [], "5", "login" => "user1"),
issue("enhancement", ["enhancement"], "6", "login" => "user2"),
issue("bug", ["bug"], "7", "login" => "user1"),
issue("breaking", ["breaking"], "8", "login" => "user5"),
issue("all the labels", %w[enhancement bug breaking], "9", "login" => "user9")
]
end
let(:pull_requests) do
[
pr("no labels", [], "10", "login" => "user1"),
pr("enhancement", ["enhancement"], "11", "login" => "user5"),
pr("bug", ["bug"], "12", "login" => "user5"),
pr("breaking", ["breaking"], "13", "login" => "user5"),
pr("all the labels", %w[enhancement bug breaking], "14", "login" => "user5")
]
end
subject { described_class.new(options) }
it "generates a header and body" do
changelog = <<-CHANGELOG.gsub(/^ {8}/, "")
## [1.0.1](https://github.com/owner/repo/tree/1.0.1) (2017-12-04)
[Full Changelog](https://github.com/owner/repo/compare/1.0.0...1.0.1)
**Breaking changes:**
- issue breaking [\\#8](https://github.com/owner/repo/issue/8)
- pr breaking [\\#13](https://github.com/owner/repo/pull/13) ([user5](https://github.com/user5))
**Implemented enhancements:**
- issue enhancement [\\#6](https://github.com/owner/repo/issue/6)
- issue all the labels [\\#9](https://github.com/owner/repo/issue/9)
- pr enhancement [\\#11](https://github.com/owner/repo/pull/11) ([user5](https://github.com/user5))
- pr all the labels [\\#14](https://github.com/owner/repo/pull/14) ([user5](https://github.com/user5))
**Fixed bugs:**
- issue bug [\\#7](https://github.com/owner/repo/issue/7)
- pr bug [\\#12](https://github.com/owner/repo/pull/12) ([user5](https://github.com/user5))
**Closed issues:**
- issue no labels [\\#5](https://github.com/owner/repo/issue/5)
**Merged pull requests:**
- pr no labels [\\#10](https://github.com/owner/repo/pull/10) ([user1](https://github.com/user1))
CHANGELOG
expect(subject.create_entry_for_tag(pull_requests, issues, "1.0.1", "1.0.1", Time.new(2017, 12, 4), "1.0.0")).to eq(changelog)
end
end
describe "#parse_sections" do
before do
subject { described_class.new }
end
context "valid json" do
let(:sections_string) { "{ \"foo\": { \"prefix\": \"foofix\", \"labels\": [\"test1\", \"test2\"]}, \"bar\": { \"prefix\": \"barfix\", \"labels\": [\"test3\", \"test4\"]}}" }
let(:sections_array) do
[
Section.new(name: "foo", prefix: "foofix", labels: %w[test1 test2]),
Section.new(name: "bar", prefix: "barfix", labels: %w[test3 test4])
]
end
it "returns an array with 2 objects" do
arr = subject.send(:parse_sections, sections_string)
expect(arr.size).to eq 2
arr.each { |section| expect(section).to be_an_instance_of Section }
end
it "returns correctly constructed sections" do
require "json"
sections_json = JSON.parse(sections_string)
sections_array.each_index do |i|
aggregate_failures "checks each component" do
expect(sections_array[i].name).to eq sections_json.first[0]
expect(sections_array[i].prefix).to eq sections_json.first[1]["prefix"]
expect(sections_array[i].labels).to eq sections_json.first[1]["labels"]
expect(sections_array[i].issues).to eq []
end
sections_json.shift
end
end
end
context "hash" do
let(:sections_hash) do
{
enhancements: {
prefix: "**Enhancements**",
labels: %w[feature enhancement]
},
breaking: {
prefix: "**Breaking**",
labels: ["breaking"]
},
bugs: {
prefix: "**Bugs**",
labels: ["bug"]
}
}
end
let(:sections_array) do
[
Section.new(name: "enhancements", prefix: "**Enhancements**", labels: %w[feature enhancement]),
Section.new(name: "breaking", prefix: "**Breaking**", labels: ["breaking"]),
Section.new(name: "bugs", prefix: "**Bugs**", labels: ["bug"])
]
end
it "returns an array with 3 objects" do
arr = subject.send(:parse_sections, sections_hash)
expect(arr.size).to eq 3
arr.each { |section| expect(section).to be_an_instance_of Section }
end
it "returns correctly constructed sections" do
sections_array.each_index do |i|
aggregate_failures "checks each component" do
expect(sections_array[i].name).to eq sections_hash.first[0].to_s
expect(sections_array[i].prefix).to eq sections_hash.first[1][:prefix]
expect(sections_array[i].labels).to eq sections_hash.first[1][:labels]
expect(sections_array[i].issues).to eq []
end
sections_hash.shift
end
end
end
end
describe "#parse_by_sections" do
context "default sections" do
let(:options) do
{
bug_labels: ["bug"],
enhancement_labels: ["enhancement"],
breaking_labels: ["breaking"]
}
end
let(:issues) do
[
issue("no labels", []),
issue("enhancement", ["enhancement"]),
issue("bug", ["bug"]),
issue("breaking", ["breaking"]),
issue("all the labels", %w[enhancement bug breaking])
]
end
let(:pull_requests) do
[
pr("no labels", []),
pr("enhancement", ["enhancement"]),
pr("bug", ["bug"]),
pr("breaking", ["breaking"]),
pr("all the labels", %w[enhancement bug breaking])
]
end
subject { described_class.new(options) }
before do
subject.send(:set_sections_and_maps)
@arr = subject.send(:parse_by_sections, pull_requests, issues)
end
it "returns 4 sections" do
expect(@arr.size).to eq 4
end
it "returns default sections" do
default_sections.each { |default_section| expect(@arr.select { |section| section.name == default_section }.size).to eq 1 }
end
it "assigns issues to the correct sections" do
breaking_section = @arr.select { |section| section.name == "breaking" }[0]
enhancement_section = @arr.select { |section| section.name == "enhancements" }[0]
issue_section = @arr.select { |section| section.name == "issues" }[0]
bug_section = @arr.select { |section| section.name == "bugs" }[0]
expect(titles_for(breaking_section.issues)).to eq(["issue breaking", "pr breaking"])
expect(titles_for(enhancement_section.issues)).to eq(["issue enhancement", "issue all the labels", "pr enhancement", "pr all the labels"])
expect(titles_for(issue_section.issues)).to eq(["issue no labels"])
expect(titles_for(bug_section.issues)).to eq(["issue bug", "pr bug"])
expect(titles_for(pull_requests)).to eq(["pr no labels"])
end
end
context "configure sections" do
let(:options) do
{
configure_sections: "{ \"foo\": { \"prefix\": \"foofix\", \"labels\": [\"test1\", \"test2\"]}, \"bar\": { \"prefix\": \"barfix\", \"labels\": [\"test3\", \"test4\"]}}"
}
end
let(:issues) do
[
issue("no labels", []),
issue("test1", ["test1"]),
issue("test3", ["test3"]),
issue("test4", ["test4"]),
issue("all the labels", %w[test1 test2 test3 test4])
]
end
let(:pull_requests) do
[
pr("no labels", []),
pr("test1", ["test1"]),
pr("test3", ["test3"]),
pr("test4", ["test4"]),
pr("all the labels", %w[test1 test2 test3 test4])
]
end
subject { described_class.new(options) }
before do
subject.send(:set_sections_and_maps)
@arr = subject.send(:parse_by_sections, pull_requests, issues)
end
it "returns 2 sections" do
expect(@arr.size).to eq 2
end
it "returns only configured sections" do
expect(@arr.select { |section| section.name == "foo" }.size).to eq 1
expect(@arr.select { |section| section.name == "bar" }.size).to eq 1
end
it "assigns issues to the correct sections" do
foo_section = @arr.select { |section| section.name == "foo" }[0]
bar_section = @arr.select { |section| section.name == "bar" }[0]
aggregate_failures "checks all sections" do
expect(titles_for(foo_section.issues)).to eq(["issue test1", "issue all the labels", "pr test1", "pr all the labels"])
expect(titles_for(bar_section.issues)).to eq(["issue test3", "issue test4", "pr test3", "pr test4"])
expect(titles_for(pull_requests)).to eq(["pr no labels"])
end
end
end
context "add sections" do
let(:options) do
{
bug_labels: ["bug"],
enhancement_labels: ["enhancement"],
breaking_labels: ["breaking"],
add_sections: "{ \"foo\": { \"prefix\": \"foofix\", \"labels\": [\"test1\", \"test2\"]}}"
}
end
let(:issues) do
[
issue("no labels", []),
issue("test1", ["test1"]),
issue("bugaboo", ["bug"]),
issue("all the labels", %w[test1 test2 enhancement bug])
]
end
let(:pull_requests) do
[
pr("no labels", []),
pr("test1", ["test1"]),
pr("enhance", ["enhancement"]),
pr("all the labels", %w[test1 test2 enhancement bug])
]
end
subject { described_class.new(options) }
before do
subject.send(:set_sections_and_maps)
@arr = subject.send(:parse_by_sections, pull_requests, issues)
end
it "returns 5 sections" do
expect(@arr.size).to eq 5
end
it "returns default sections" do
default_sections.each { |default_section| expect(@arr.select { |section| section.name == default_section }.size).to eq 1 }
end
it "returns added section" do
expect(@arr.select { |section| section.name == "foo" }.size).to eq 1
end
it "assigns issues to the correct sections" do
foo_section = @arr.select { |section| section.name == "foo" }[0]
enhancement_section = @arr.select { |section| section.name == "enhancements" }[0]
bug_section = @arr.select { |section| section.name == "bugs" }[0]
aggregate_failures "checks all sections" do
expect(titles_for(foo_section.issues)).to eq(["issue test1", "issue all the labels", "pr test1", "pr all the labels"])
expect(titles_for(enhancement_section.issues)).to eq(["pr enhance"])
expect(titles_for(bug_section.issues)).to eq(["issue bugaboo"])
expect(titles_for(pull_requests)).to eq(["pr no labels"])
end
end
end
end
end
end
# rubocop:enable Metrics/ModuleLength

View File

@ -1,32 +1,19 @@
# frozen_string_literal: true # frozen_string_literal: true
module GitHubChangelogGenerator module GitHubChangelogGenerator
describe Generator do describe Generator do
let(:default_options) { GitHubChangelogGenerator::Parser.default_options } context "#exclude_issues_by_labels" do
let(:options) { {} } let(:label) { { "name" => "BAD" } }
let(:generator) { described_class.new(default_options.merge(options)) } let(:issue) { { "labels" => [label] } }
let(:bad_label) { { "name" => "BAD" } }
let(:bad_issue) { { "labels" => [bad_label] } }
let(:good_label) { { "name" => "GOOD" } } let(:good_label) { { "name" => "GOOD" } }
let(:good_issue) { { "labels" => [good_label] } } let(:good_issue) { { "labels" => [good_label] } }
let(:unlabeled_issue) { { "labels" => [] } } let(:issues) { [issue, good_issue] }
let(:issues) { [bad_issue, good_issue, unlabeled_issue] } subject(:generator) { described_class.new(exclude_labels: %w(BAD BOO)) }
describe "#exclude_issues_by_labels" do it "removes issues with labels in the exclude_label list" do
subject do result = generator.exclude_issues_by_labels(issues)
generator.exclude_issues_by_labels(issues)
end
let(:expected_issues) { issues } expect(result).to include(good_issue)
expect(result).not_to include(issue)
it { is_expected.to eq(expected_issues) }
context "when 'exclude_lables' is provided" do
let(:options) { { exclude_labels: %w[BAD BOO] } }
let(:expected_issues) { [good_issue, unlabeled_issue] }
it { is_expected.to eq(expected_issues) }
end end
context "with no option given" do context "with no option given" do
@ -38,43 +25,5 @@ module GitHubChangelogGenerator
end end
end end
end end
describe "#get_filtered_issues" do
subject do
generator.get_filtered_issues(issues)
end
let(:expected_issues) { issues }
it { is_expected.to eq(expected_issues) }
context "when 'exclude_labels' is provided" do
let(:options) { { exclude_labels: %w[BAD BOO] } }
let(:expected_issues) { [good_issue, unlabeled_issue] }
it { is_expected.to eq(expected_issues) }
end
context "when 'add_issues_wo_labels' is false" do
let(:options) { { add_issues_wo_labels: false } }
let(:expected_issues) { [bad_issue, good_issue] }
it { is_expected.to eq(expected_issues) }
context "with 'exclude_labels'" do
let(:options) { { add_issues_wo_labels: false, exclude_labels: %w[GOOD] } }
let(:expected_issues) { [bad_issue] }
it { is_expected.to eq(expected_issues) }
end
end
context "when 'include_labels' is specified" do
let(:options) { { include_labels: %w[GOOD] } }
let(:expected_issues) { [good_issue] }
it { is_expected.to eq(expected_issues) }
end
end
end end
end end

View File

@ -1,5 +1,4 @@
# frozen_string_literal: true # frozen_string_literal: true
describe GitHubChangelogGenerator::Generator do describe GitHubChangelogGenerator::Generator do
def tag_with_name(tag) def tag_with_name(tag)
{ {
@ -13,236 +12,174 @@ describe GitHubChangelogGenerator::Generator do
end end
end end
describe "#tag_section_mapping" do describe "#filter_between_tags" do
let(:all_tags) { tags_from_strings(%w[8 7 6 5 4 3 2 1]) } context "when between_tags nil" do
let(:sorted_tags) { all_tags }
let(:default_options) { GitHubChangelogGenerator::Parser.default_options }
let(:options) { {} }
let(:generator) { described_class.new(default_options.merge(options)) }
before do before do
allow_any_instance_of(GitHubChangelogGenerator::OctoFetcher).to receive(:get_all_tags).and_return(all_tags) @generator = GitHubChangelogGenerator::Generator.new(between_tags: nil)
allow(generator).to receive(:fetch_tags_dates).with(all_tags)
allow(generator).to receive(:sort_tags_by_date).with(all_tags).and_return(sorted_tags)
generator.fetch_and_filter_tags
end end
subject do subject do
generator.tag_section_mapping @generator.get_filtered_tags(tags_from_strings(%w(1 2 3)))
end
it { is_expected.to be_a(Array) }
it { is_expected.to match_array(tags_from_strings(%w(1 2 3))) }
end
context "when between_tags same as input array" do
before do
@generator = GitHubChangelogGenerator::Generator.new(between_tags: %w(1 2 3))
end
subject do
@generator.get_filtered_tags(tags_from_strings(%w(1 2 3)))
end
it { is_expected.to be_a(Array) }
it { is_expected.to match_array(tags_from_strings(%w(1 2 3))) }
end end
shared_examples_for "a section mapping" do context "when between_tags filled with correct values" do
it { is_expected.to be_a(Hash) } before do
it { is_expected.to eq(expected_mapping) } @generator = GitHubChangelogGenerator::Generator.new(between_tags: %w(1 2))
end
subject do
@generator.get_filtered_tags(tags_from_strings(%w(1 2 3)))
end
it { is_expected.to be_a(Array) }
it { is_expected.to match_array(tags_from_strings(%w(1 2))) }
end end
shared_examples_for "a full changelog" do context "when between_tags filled with invalid values" do
let(:expected_mapping) do before do
{ @generator = GitHubChangelogGenerator::Generator.new(between_tags: %w(1 q w))
tag_with_name("8") => [tag_with_name("7"), tag_with_name("8")],
tag_with_name("7") => [tag_with_name("6"), tag_with_name("7")],
tag_with_name("6") => [tag_with_name("5"), tag_with_name("6")],
tag_with_name("5") => [tag_with_name("4"), tag_with_name("5")],
tag_with_name("4") => [tag_with_name("3"), tag_with_name("4")],
tag_with_name("3") => [tag_with_name("2"), tag_with_name("3")],
tag_with_name("2") => [tag_with_name("1"), tag_with_name("2")],
tag_with_name("1") => [nil, tag_with_name("1")]
}
end end
it_behaves_like "a section mapping" subject do
@generator.get_filtered_tags(tags_from_strings(%w(1 2 3)))
end
it { is_expected.to be_a(Array) }
it { is_expected.to match_array(tags_from_strings(%w(1))) }
end
end end
shared_examples_for "a changelog with some exclusions" do describe "#get_filtered_tags" do
let(:expected_mapping) do subject do
{ generator.get_filtered_tags(tags_from_strings(%w(1 2 3 4 5)))
tag_with_name("8") => [tag_with_name("7"), tag_with_name("8")],
tag_with_name("6") => [tag_with_name("5"), tag_with_name("6")],
tag_with_name("4") => [tag_with_name("3"), tag_with_name("4")],
tag_with_name("3") => [tag_with_name("2"), tag_with_name("3")],
tag_with_name("1") => [nil, tag_with_name("1")]
}
end end
it_behaves_like "a section mapping" context "respects between tags" do
end let(:generator) { GitHubChangelogGenerator::Generator.new(between_tags: %w(1 2 3)) }
context "with no constraints" do it { is_expected.to be_a Array }
it_behaves_like "a full changelog" it { is_expected.to match_array(tags_from_strings(%w(1 2 3))) }
end
context "with since only" do
let(:options) { { since_tag: "6" } }
let(:expected_mapping) do
{
tag_with_name("8") => [tag_with_name("7"), tag_with_name("8")],
tag_with_name("7") => [tag_with_name("6"), tag_with_name("7")]
}
end
it_behaves_like "a section mapping"
end
context "with due only" do
let(:options) { { due_tag: "4" } }
let(:expected_mapping) do
{
tag_with_name("3") => [tag_with_name("2"), tag_with_name("3")],
tag_with_name("2") => [tag_with_name("1"), tag_with_name("2")],
tag_with_name("1") => [nil, tag_with_name("1")]
}
end
it_behaves_like "a section mapping"
end
context "with since and due" do
let(:options) { { since_tag: "2", due_tag: "5" } }
let(:expected_mapping) do
{
tag_with_name("4") => [tag_with_name("3"), tag_with_name("4")],
tag_with_name("3") => [tag_with_name("2"), tag_with_name("3")]
}
end
it_behaves_like "a section mapping"
end
context "with excluded tags" do
context "as a list of strings" do
let(:options) { { exclude_tags: %w[2 5 7] } }
it_behaves_like "a changelog with some exclusions"
end
context "as a regex" do
let(:options) { { exclude_tags: /[257]/ } }
it_behaves_like "a changelog with some exclusions"
end
context "as a regex string" do
let(:options) { { exclude_tags_regex: "[257]" } }
it_behaves_like "a changelog with some exclusions"
end
end end
end end
describe "#filter_excluded_tags" do describe "#filter_excluded_tags" do
subject { generator.filter_excluded_tags(tags_from_strings(%w[1 2 3])) } subject { generator.filter_excluded_tags(tags_from_strings(%w(1 2 3))) }
context "with matching string" do context "with matching string" do
let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: %w[3]) } let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: %w(3)) }
it { is_expected.to be_a Array } it { is_expected.to be_a Array }
it { is_expected.to match_array(tags_from_strings(%w[1 2])) } it { is_expected.to match_array(tags_from_strings(%w(1 2))) }
end end
context "with non-matching string" do context "with non-matching string" do
let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: %w[invalid tags]) } let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: %w(invalid tags)) }
it { is_expected.to be_a Array } it { is_expected.to be_a Array }
it { is_expected.to match_array(tags_from_strings(%w[1 2 3])) } it { is_expected.to match_array(tags_from_strings(%w(1 2 3))) }
end end
context "with matching regex" do context "with matching regex" do
let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: /[23]/) } let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: /[23]/) }
it { is_expected.to be_a Array } it { is_expected.to be_a Array }
it { is_expected.to match_array(tags_from_strings(%w[1])) } it { is_expected.to match_array(tags_from_strings(%w(1))) }
end end
context "with non-matching regex" do context "with non-matching regex" do
let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: /[abc]/) } let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: /[abc]/) }
it { is_expected.to be_a Array } it { is_expected.to be_a Array }
it { is_expected.to match_array(tags_from_strings(%w[1 2 3])) } it { is_expected.to match_array(tags_from_strings(%w(1 2 3))) }
end end
end end
describe "#filter_excluded_tags_regex" do describe "#filter_excluded_tags_regex" do
subject { generator.filter_excluded_tags(tags_from_strings(%w[1 2 3])) } subject { generator.filter_excluded_tags(tags_from_strings(%w(1 2 3))) }
context "with matching regex" do context "with matching regex" do
let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags_regex: "[23]") } let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags_regex: "[23]") }
it { is_expected.to be_a Array } it { is_expected.to be_a Array }
it { is_expected.to match_array(tags_from_strings(%w[1])) } it { is_expected.to match_array(tags_from_strings(%w(1))) }
end end
context "with non-matching regex" do context "with non-matching regex" do
let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags_regex: "[45]") } let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags_regex: "[45]") }
it { is_expected.to be_a Array } it { is_expected.to be_a Array }
it { is_expected.to match_array(tags_from_strings(%w[1 2 3])) } it { is_expected.to match_array(tags_from_strings(%w(1 2 3))) }
end end
end end
describe "#filter_since_tag" do describe "#filter_since_tag" do
context "with filled array" do context "with filled array" do
subject { generator.filter_since_tag(tags_from_strings(%w[1 2 3])) } subject { generator.filter_since_tag(tags_from_strings(%w(1 2 3))) }
context "with valid since tag" do context "with valid since tag" do
let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "2") } let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "2") }
it { is_expected.to be_a Array } it { is_expected.to be_a Array }
it { is_expected.to match_array(tags_from_strings(%w[1 2])) } it { is_expected.to match_array(tags_from_strings(%w(1))) }
context "with since tag set to the most recent tag" do
let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "1") }
it { is_expected.to match_array(tags_from_strings(%w[1])) }
end
end end
context "with invalid since tag" do context "with invalid since tag" do
let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "Invalid tag") } let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "Invalid tag") }
it { is_expected.to be_a Array } it { is_expected.to be_a Array }
it { is_expected.to match_array(tags_from_strings(%w[1 2 3])) } it { is_expected.to match_array(tags_from_strings(%w(1 2 3))) }
end end
end end
context "with empty array" do context "with empty array" do
subject { generator.filter_since_tag(tags_from_strings(%w[])) } subject { generator.filter_since_tag(tags_from_strings(%w())) }
context "with valid since tag" do context "with valid since tag" do
let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "2") } let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "2") }
it { is_expected.to be_a Array } it { is_expected.to be_a Array }
it { is_expected.to match_array(tags_from_strings(%w[])) } it { is_expected.to match_array(tags_from_strings(%w())) }
end end
context "with invalid since tag" do context "with invalid since tag" do
let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "Invalid tag") } let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "Invalid tag") }
it { is_expected.to be_a Array } it { is_expected.to be_a Array }
it { is_expected.to match_array(tags_from_strings(%w[])) } it { is_expected.to match_array(tags_from_strings(%w())) }
end end
end end
end end
describe "#filter_due_tag" do describe "#filter_due_tag" do
context "with filled array" do context "with filled array" do
subject { generator.filter_due_tag(tags_from_strings(%w[1 2 3])) } subject { generator.filter_due_tag(tags_from_strings(%w(1 2 3))) }
context "with valid due tag" do context "with valid due tag" do
let(:generator) { GitHubChangelogGenerator::Generator.new(due_tag: "2") } let(:generator) { GitHubChangelogGenerator::Generator.new(due_tag: "2") }
it { is_expected.to be_a Array } it { is_expected.to be_a Array }
it { is_expected.to match_array(tags_from_strings(%w[3])) } it { is_expected.to match_array(tags_from_strings(%w(3))) }
end end
context "with invalid due tag" do context "with invalid due tag" do
let(:generator) { GitHubChangelogGenerator::Generator.new(due_tag: "Invalid tag") } let(:generator) { GitHubChangelogGenerator::Generator.new(due_tag: "Invalid tag") }
it { is_expected.to be_a Array } it { is_expected.to be_a Array }
it { is_expected.to match_array(tags_from_strings(%w[1 2 3])) } it { is_expected.to match_array(tags_from_strings(%w(1 2 3))) }
end end
end end
context "with empty array" do context "with empty array" do
subject { generator.filter_due_tag(tags_from_strings(%w[])) } subject { generator.filter_due_tag(tags_from_strings(%w())) }
context "with valid due tag" do context "with valid due tag" do
let(:generator) { GitHubChangelogGenerator::Generator.new(due_tag: "2") } let(:generator) { GitHubChangelogGenerator::Generator.new(due_tag: "2") }
it { is_expected.to be_a Array } it { is_expected.to be_a Array }
it { is_expected.to match_array(tags_from_strings(%w[])) } it { is_expected.to match_array(tags_from_strings(%w())) }
end end
context "with invalid due tag" do context "with invalid due tag" do
let(:generator) { GitHubChangelogGenerator::Generator.new(due_tag: "Invalid tag") } let(:generator) { GitHubChangelogGenerator::Generator.new(due_tag: "Invalid tag") }
it { is_expected.to be_a Array } it { is_expected.to be_a Array }
it { is_expected.to match_array(tags_from_strings(%w[])) } it { is_expected.to match_array(tags_from_strings(%w())) }
end end
end end
end end
@ -295,13 +232,13 @@ describe GitHubChangelogGenerator::Generator do
@generator.sort_tags_by_date(tags) @generator.sort_tags_by_date(tags)
end end
context "sort unsorted tags" do context "sort unsorted tags" do
let(:tags) { tags_from_strings %w[valid_tag1 valid_tag2 valid_tag3] } let(:tags) { tags_from_strings %w(valid_tag1 valid_tag2 valid_tag3) }
it { is_expected.to be_a_kind_of(Array) } it { is_expected.to be_a_kind_of(Array) }
it { is_expected.to match_array(tags.reverse!) } it { is_expected.to match_array(tags.reverse!) }
end end
context "sort sorted tags" do context "sort sorted tags" do
let(:tags) { tags_from_strings %w[valid_tag3 valid_tag2 valid_tag1] } let(:tags) { tags_from_strings %w(valid_tag3 valid_tag2 valid_tag1) }
it { is_expected.to be_a_kind_of(Array) } it { is_expected.to be_a_kind_of(Array) }
it { is_expected.to match_array(tags) } it { is_expected.to match_array(tags) }

View File

@ -1,5 +1,4 @@
# frozen_string_literal: true # frozen_string_literal: true
VALID_TOKEN = "0123456789abcdef" VALID_TOKEN = "0123456789abcdef"
INVALID_TOKEN = "0000000000000000" INVALID_TOKEN = "0000000000000000"
@ -300,7 +299,7 @@ describe GitHubChangelogGenerator::OctoFetcher do
pull_requests = fetcher.fetch_closed_pull_requests pull_requests = fetcher.fetch_closed_pull_requests
pr = pull_requests.first pr = pull_requests.first
expect(pr.keys).to eq(%w[url id html_url diff_url patch_url issue_url number state locked title user body created_at updated_at closed_at merged_at merge_commit_sha assignee assignees milestone commits_url review_comments_url review_comment_url comments_url statuses_url head base _links]) expect(pr.keys).to eq(%w(url id html_url diff_url patch_url issue_url number state locked title user body created_at updated_at closed_at merged_at merge_commit_sha assignee assignees milestone commits_url review_comments_url review_comment_url comments_url statuses_url head base _links))
end end
end end
end end
@ -501,7 +500,7 @@ describe GitHubChangelogGenerator::OctoFetcher do
commit = fetcher.fetch_commit(event) commit = fetcher.fetch_commit(event)
expectations = [ expectations = [
%w[sha decfe840d1a1b86e0c28700de5362d3365a29555], %w(sha decfe840d1a1b86e0c28700de5362d3365a29555),
["url", ["url",
"https://api.github.com/repos/skywinder/changelog_test/commits/decfe840d1a1b86e0c28700de5362d3365a29555"], "https://api.github.com/repos/skywinder/changelog_test/commits/decfe840d1a1b86e0c28700de5362d3365a29555"],
# OLD API: "https://api.github.com/repos/skywinder/changelog_test/git/commits/decfe840d1a1b86e0c28700de5362d3365a29555"], # OLD API: "https://api.github.com/repos/skywinder/changelog_test/git/commits/decfe840d1a1b86e0c28700de5362d3365a29555"],
@ -526,18 +525,4 @@ describe GitHubChangelogGenerator::OctoFetcher do
end end
end end
end end
describe "#commits_before" do
context "when API is valid", :vcr do
let(:start_time) { Time.parse("Wed Mar 4 18:47:17 2015 +0200") }
subject do
fetcher.commits_before(start_time)
end
it "returns commits" do
expect(subject.last["sha"]).to eq("4c2d6d1ed58bdb24b870dcb5d9f2ceed0283d69d")
end
end
end
end end

View File

@ -1,5 +1,4 @@
# frozen_string_literal: true # frozen_string_literal: true
RSpec.describe GitHubChangelogGenerator::Options do RSpec.describe GitHubChangelogGenerator::Options do
describe "#initialize" do describe "#initialize" do
context "with known options" do context "with known options" do
@ -12,7 +11,7 @@ RSpec.describe GitHubChangelogGenerator::Options do
it "raises an error" do it "raises an error" do
expect do expect do
described_class.new( described_class.new(
project: "rails", git_remote: "origin",
strength: "super-strength", strength: "super-strength",
wisdom: "deep" wisdom: "deep"
) )
@ -22,13 +21,13 @@ RSpec.describe GitHubChangelogGenerator::Options do
end end
describe "#[]=(key, value)" do describe "#[]=(key, value)" do
let(:options) { described_class.new(project: "rails") } let(:options) { described_class.new(git_remote: "origin") }
context "with known options" do context "with known options" do
it "sets the option value" do it "sets the option value" do
expect do expect do
options[:project] = "trails" options[:git_remote] = "in the cloud"
end.to change { options[:project] }.to "trails" end.to change { options[:git_remote] }.to "in the cloud"
end end
end end

View File

@ -1,5 +1,4 @@
# frozen_string_literal: true # frozen_string_literal: true
describe GitHubChangelogGenerator::ParserFile do describe GitHubChangelogGenerator::ParserFile do
describe ".github_changelog_generator" do describe ".github_changelog_generator" do
let(:options) { {} } let(:options) { {} }
@ -14,7 +13,7 @@ describe GitHubChangelogGenerator::ParserFile do
let(:parser) { GitHubChangelogGenerator::ParserFile.new(options, StringIO.new("")) } let(:parser) { GitHubChangelogGenerator::ParserFile.new(options, StringIO.new("")) }
it "does not change the options" do it "does not change the options" do
expect { parser.parse! }.to_not(change { options }) expect { parser.parse! }.to_not change { options }
end end
end end
@ -52,11 +51,12 @@ describe GitHubChangelogGenerator::ParserFile do
context "turns exclude-labels into an Array", bug: "#327" do context "turns exclude-labels into an Array", bug: "#327" do
let(:file) do let(:file) do
line1 = "exclude-labels=73a91042-da6f-11e5-9335-1040f38d7f90,7adf83b4-da6f-11e5-ae18-1040f38d7f90\n" StringIO.new(<<EOF
line2 = "header_label=# My changelog\n" exclude-labels=73a91042-da6f-11e5-9335-1040f38d7f90,7adf83b4-da6f-11e5-ae18-1040f38d7f90
StringIO.new(line1 + line2) header_label=# My changelog
EOF
)
end end
it "reads exclude_labels into an Array" do it "reads exclude_labels into an Array" do
expect { parser.parse! }.to change { options[:exclude_labels] } expect { parser.parse! }.to change { options[:exclude_labels] }
.from(default_options[:exclude_labels]) .from(default_options[:exclude_labels])

View File

@ -1,4 +1,82 @@
# frozen_string_literal: true # frozen_string_literal: true
describe GitHubChangelogGenerator::Parser do describe GitHubChangelogGenerator::Parser do
describe ".user_project_from_remote" do
context "when remote is type 1" do
subject { GitHubChangelogGenerator::Parser.user_project_from_remote("origin https://github.com/skywinder/ActionSheetPicker-3.0 (fetch)") }
it { is_expected.to be_a(Array) }
it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
end
context "when remote is type 2" do
subject { GitHubChangelogGenerator::Parser.user_project_from_remote("https://github.com/skywinder/ActionSheetPicker-3.0") }
it { is_expected.to be_a(Array) }
it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
end
context "when remote is type 3" do
subject { GitHubChangelogGenerator::Parser.user_project_from_remote("https://github.com/skywinder/ActionSheetPicker-3.0") }
it { is_expected.to be_a(Array) }
it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
end
context "when remote is type 4" do
subject { GitHubChangelogGenerator::Parser.user_project_from_remote("origin git@github.com:skywinder/ActionSheetPicker-3.0.git (fetch)") }
it { is_expected.to be_a(Array) }
it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
end
context "when remote is invalid" do
subject { GitHubChangelogGenerator::Parser.user_project_from_remote("some invalid text") }
it { is_expected.to be_a(Array) }
it { is_expected.to match_array([nil, nil]) }
end
end
describe ".user_project_from_option" do
context "when option is invalid" do
it("should return nil") { expect(GitHubChangelogGenerator::Parser.user_project_from_option("blah", nil, nil)).to be_nil }
end
context "when option is valid" do
subject { GitHubChangelogGenerator::Parser.user_project_from_option("skywinder/ActionSheetPicker-3.0", nil, nil) }
it { is_expected.to be_a(Array) }
it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
end
context "when option nil" do
subject { GitHubChangelogGenerator::Parser.user_project_from_option(nil, nil, nil) }
it { is_expected.to be_a(Array) }
it { is_expected.to match_array([nil, nil]) }
end
context "when site is nil" do
subject { GitHubChangelogGenerator::Parser.user_project_from_option("skywinder/ActionSheetPicker-3.0", nil, nil) }
it { is_expected.to be_a(Array) }
it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
end
context "when site is valid" do
subject { GitHubChangelogGenerator::Parser.user_project_from_option("skywinder/ActionSheetPicker-3.0", nil, "https://codeclimate.com") }
it { is_expected.to be_a(Array) }
it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
end
context "when second arg is not nil" do
subject { GitHubChangelogGenerator::Parser.user_project_from_option("skywinder/ActionSheetPicker-3.0", "blah", nil) }
it { is_expected.to be_a(Array) }
it { is_expected.to match_array([nil, nil]) }
end
context "when all args is not nil" do
subject { GitHubChangelogGenerator::Parser.user_project_from_option("skywinder/ActionSheetPicker-3.0", "blah", "https://codeclimate.com") }
it { is_expected.to be_a(Array) }
it { is_expected.to match_array([nil, nil]) }
end
end
describe ".fetch_user_and_project" do
before do
stub_const("ARGV", ["https://github.com/skywinder/github-changelog-generator"])
end
context do
let(:valid_user) { "initialized_user" }
let(:options) { { user: valid_user } }
let(:options_before_change) { options.dup }
it "should leave user unchanged" do
expect { GitHubChangelogGenerator::Parser.fetch_user_and_project(options) }.to change { options }
.from(options_before_change)
.to(options_before_change.merge(project: "github-changelog-generator"))
end
end
end
end end

View File

@ -1,5 +1,4 @@
# frozen_string_literal: true # frozen_string_literal: true
# #
# Author:: Enrico Stahn <mail@enricostahn.com> # Author:: Enrico Stahn <mail@enricostahn.com>
# #
@ -51,7 +50,7 @@ describe GitHubChangelogGenerator::Reader do
it { is_expected.to be_empty } it { is_expected.to be_empty }
end end
context "when file has only the header" do context "when file has only the header" do
subject { @reader.parse("# Changelog") } subject { @reader.parse("# Change Log") }
it { is_expected.to be_an(Array) } it { is_expected.to be_an(Array) }
it { is_expected.to be_empty } it { is_expected.to be_empty }
end end