Commit Graph

411 Commits

Author SHA1 Message Date
Eric Putnam
587557e1ac
Refactor generation code and allow custom sections
There's a lot in this PR.
- Added a Section class to more easily make the other changes and
  hopefully add flexibility for the future
- Added an option called `configure_sections` that allows you create
  your own custom sections. It blows away all other sections and uses
only the ones you give it.
- Added an option called `add_sections` that allows you to add_sections
  to the default section set
- Added an option called `include_merged` that can be used when
  configure_sections is defined. Configure sections blows away any and
all default sections so to get this one back, you have to set this
option.
- Added tests for this stuff

@HAIL9000 was a co-author. Because of a little git snafu, I accidentally
squashed all of our work into one so it looks like it was just me.

---

Refactor details:

Before this change, the code in generator.rb and generator_generation.rb was conflated and
method call flow went back and forth between the two files seemingly
randomly. They also both defined the exact same class, which is
un-ruby-ish. I tried to separate methods used for the whole changelog
generation from methods used for specific parts of the changelog and
move them into specific classes.

I reasoned that a changelog is a series of "entries" of all tagged
releases plus an extra entry for the unreleased entry. Each entry is
comprised of a header and a series of "sections" for that entry. Each
section is comprized of a list of issues and/or pull requests for that
entry. So the log contains entries, entries contain sections, and
sections contain issues & prs. I have structured the classes around this idea.

- lib/github_changelog_generator/generator/generator.rb is for code
related to generating the entire changelog.
- lib/github_changelog_generator/generator/entry.rb is for code related
to generating entries.
- lib/github_changelog_generator/generator/section.rb is for code
relating to geneating entry sections.

Issues and PRs are already special objects, so it doesn't make sense to
break those out into their own class.
2017-12-14 16:13:41 -08:00
Saugat Acharya
d9cf6ffd94 Make 'change log' a single word (#579) 2017-12-13 22:06:00 +01:00
Olle Jonsson
9377fe600a v1.15.0-rc 2017-10-29 18:59:21 +01:00
Olle Jonsson
4465adf943 Linting 2017-10-27 09:29:17 +02:00
Olle Jonsson
5834fd3766 Update parser.rb 2017-10-27 09:28:52 +02:00
Olle Jonsson
b486425af1 Parser: less wordy output 2017-10-27 09:28:52 +02:00
Olle Jonsson
91ac00c1d3 Abort with friendly message on no user or project 2017-10-27 09:28:52 +02:00
Olle Jonsson
4f640b74ac Aborting prints all of usage 2017-10-27 09:28:52 +02:00
Olle Jonsson
faf2ddd552 Linting 2017-10-27 08:49:52 +02:00
Olle Jonsson
deb902ae13 Add Rake options reported missing 2017-10-26 01:35:51 +02:00
Olle Jonsson
5bb4d51b96 Options#print_options: tell don't ask 2017-10-14 21:52:26 +02:00
Olle Jonsson
1fac4efe47 [docs] API docs for Options, Parser
- shorten implementation of print_options
2017-10-14 21:28:02 +02:00
Olle Jonsson
ad0d972ed9 Add option --require to load custom Ruby code (#574) 2017-10-14 21:00:56 +02:00
Olle Jonsson
d16bf4cfaa v1.15.0-beta 2017-10-13 21:08:09 +02:00
Ewoud Kohl van Wijngaarden
fe7c585ed1 Fix regression w/ enhancements in issues_to_log (#573)
Introduced in 21ec2db39b.
2017-10-13 06:08:59 +02:00
Olle Jonsson
3f8fb60af3 OctoFetcher: Use defaults for request_options (#571)
* OctoFetcher: rely on default args

  - in iterate_pages

* OctoFetcher: extract options method
2017-10-10 23:48:00 +02:00
Olle Jonsson
23b341f715 OctoFetcher: extract methods (#570)
* OctoFetcher: extract methods

* OctoFetcher: extract github_options smethod

* OctoFetcher: Document exception, name parameters

  - more communicative names

* OctoFetcher#fetch_github_token: simplify

  - using ActiveSupport

* OctoFetcher#init_cache: fewer statements

* OctoFetcher: inline calls, name parameters

* OctoFetcher: name parameters, inline local
2017-10-10 23:05:10 +02:00
Olle Jonsson
630b8cee88 OctoFetcher: extract method fail_with_message (#569) 2017-10-10 21:42:29 +02:00
Olle Jonsson
74fdc2026a OctoFetcher: drop unused number_of_pages feature (#568) 2017-10-10 21:22:17 +02:00
Tim Meusel
21ec2db39b Add breaking-changes section to changelog (#530)
* add breaking-changes section to changelog

* Clean up parse_by_sections

* Thank you bastelfreak and ekohl!
2017-10-10 20:27:23 +02:00
Olle Jonsson
b36d85eb53 Drop Project-and-Username-finding code (#451)
* Remove Project-and-Username finding code and usages

* Remove "github_remote" option, now unused

* Update README: Usage has changed
2017-10-10 19:53:21 +02:00
Florian Thomas
64f4cd07c9 filter tags correctly when since_tag is set to most recent tag (#566)
* filter tags correctly when `since_tag` is set to most recent tag
Before this fix [`filtered_tags`](https://github.com/skywinder/github-changelog-generator/blob/master/lib/github_changelog_generator/generator/generator_generation.rb#L132)
was empty which caused a fallback to the last tag in the sorted_tags array (which is the oldest tag).
There for no issues and PRs were filtered in that case.

fixes #555
fixes #304
2017-10-05 23:15:06 +02:00
Olle Jonsson
07a665d800 v1.15.0-alpha 2017-10-01 15:28:09 +02:00
Umberto Nicoletti
1f68ef8bad Use closed_at and merged_at when filtering issues/prs (#504)
* use closed_at and merged_at when filtering issues/prs
* document use of closed_at and merged_at
2017-09-30 20:45:31 +02:00
Olle Jonsson
9662c935c3 RuboCop 0.50.0; lints 2017-09-18 21:14:47 +02:00
Olle Jonsson
b94fb7f839 Remove all old credit lines in the output then add a new one (#526)
* Fixes #507 - Removes old credit lines in log so that there are no duplicates

* Added missing newline at end of file

* Replaced single-quoted empty string with double quotes
2017-09-10 11:56:11 +02:00
Olle Jonsson
519cd5b136 Tiny whitespace detail [ci skip] 2017-09-10 11:55:49 +02:00
Jerome Lacoste
d2a8dc3977 warn_if_nonmatching_regex should display proper help message when used with exclude-tags-regex (#551) 2017-08-09 10:06:32 +02:00
Hunter Haugen
a287bd872b
Rebase, pass rubocop, remove between-tags references
This is a rebase and resubmission of #453
2017-07-27 15:51:49 -07:00
Thom May
b1121cb1ee
Use our default labels across the board
Signed-off-by: Thom May <thom@chef.io>
2017-07-27 10:44:00 -07:00
Tom Duffield
5932cb730b
Fix parameter type in doc for generator
Signed-off-by: Tom Duffield <tom@chef.io>
2017-07-27 10:39:28 -07:00
Tom Duffield
726f8f79fb
Don't show untagged issues when desired
When `add_issues_wo_labels` is false, do not include issues that do not
have any labels in the CHANGELOG (per documentation).

Signed-off-by: Tom Duffield <tom@chef.io>
2017-07-27 10:39:22 -07:00
Tom Duffield
b91609283e
Don't show untagged PRs
As far as I can tell, `add_pr_wo_labels` wasn't actually
implemented. Implementing this per the documentation.

Signed-off-by: Tom Duffield <tom@chef.io>
2017-07-27 10:37:55 -07:00
Tom Duffield
174baec266
Use first SHA for last tag
Rather than having the last tag be an empty husk, generate a full
changelog link using the first sha from the repository.

Signed-off-by: Tom Duffield <tom@chef.io>
2017-07-27 10:37:49 -07:00
Tom Duffield
ee5a507f76
Filter excluded tags within the section map builder
Because we need might need excluded tags to build compare links, the
section map generator needs to have access to those tags. But, we don't
want excluded tags to have section headers. So instead, we'll create
another copy of the list that doesn't have tags excluded.

Signed-off-by: Tom Duffield <tom@chef.io>
2017-07-27 10:37:38 -07:00
Tom Duffield
66177c58e3
DRY up the tests and address Rubocop feedback
Signed-off-by: Tom Duffield <tom@chef.io>
2017-07-27 10:37:32 -07:00
Tom Duffield
d6c26ef4a9
Generate mapping that will match expectations
This change neccesitated changing the behavior or the
`filter_since_tag`. Since we want our compare links to include the since
tag, we need to keep that tag in the filtered list. Instead, we detect
that the tag is the since tag and filter it out. This will prevent the
since_tag header from being duplicated when pulling from a base.

The same goes for the first tag listed in between_tags. We don't want an
empty section header for this.

Signed-off-by: Tom Duffield <tom@chef.io>
2017-07-27 10:37:26 -07:00
Ian Roberts
4c26bbd7c0 Add newline after version (#548)
Add newline after version name and Full Changelog link
2017-07-19 15:26:40 +02:00
Stanislav Kozlovski
e5f0a55304 Merge branch 'master' into master 2017-06-28 21:33:28 +03:00
Lucas Huang
b21e7eaaf7 Update generator_generation.rb (#542)
Fix the syntax so `credit_line` is recognizable as a variable. #541
2017-06-28 16:55:42 +02:00
Lucas Huang
d0e7593e98 Fix the syntax ambiguity on credit-line-bug (#537)
* fix a syntax ambiguity
2017-06-27 19:45:57 +02:00
Lucas Huang
fb7e21f9f8 Credit line bug (#535)
* Fix a bug that generates multiple credit lines
2017-06-27 07:45:59 +02:00
Enether
5bbeb93869 Replaced single-quoted empty string with double quotes 2017-06-03 18:39:48 +03:00
Enether
3d27670053 Added missing newline at end of file 2017-06-03 18:26:15 +03:00
Enether
2cc15f7be0 Fixes #507 - Removes old credit lines in log so that there are no duplicates 2017-06-03 18:22:23 +03:00
Olle Jonsson
6ad5aa106d Bug: require ActiveSupport core_ext blank (#520) 2017-05-25 14:07:34 +02:00
Lucas Huang
e9ee9556ce remove --between_tags option (#501) 2017-05-25 00:29:31 +02:00
Olle Jonsson
874c23c64f Chore: Rubocop 0.49.0 (#516)
* Rubocoping
2017-05-25 00:11:02 +02:00
Olle Jonsson
26b124a67c bundled cacert.pem with --ssl-ca-file PATH option (#480)
* Add a bundled cacert.pem from curl's website
* Using the --ssl-ca-file PATH option overrides ENV var SSL_CA_PATH
* Having none of those allow you to use the default, the bundled cacert.pem
* Octokit's SSL config uses this new setting
* Rake task to update_ssl_ca_file
* Rubocop target 2.2
2017-05-24 23:43:31 +02:00
Lucas Huang
9bbfa3add5 Rescue invalid commands and present the valid options list (#498)
* rescue invalid commands

* recuse invalid command
2017-05-14 21:30:43 +02:00