Skip to content

Navigation Menu

Sign in

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Optionally Print Issue and Pull Requests Body #616

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 27, 2018
Merged

Optionally Print Issue and Pull Requests Body #616

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5b2cae1
Make issues first line bold when issue and pr body is added to the ch…
ArtieReus Feb 27, 2018
882ee0c
Leave default behavior as is, without a body by default. Added extra …
ArtieReus Apr 16, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 18 additions & 1 deletion 19 lib/github_changelog_generator/generator/section.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,24 @@ def get_string_for_issue(issue)
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)
line = issue_line_with_user(title_with_number, issue)
issue_line_with_body(line, issue)
end

def issue_line_with_body(line, issue)
return line if !@options[:issue_line_body] || issue["body"].blank?
# get issue body till first line break
body_paragraph = body_till_first_break(issue["body"])
# remove spaces from begining and end of the string
body_paragraph.rstrip!
# encapsulate to md
encapsulated_body = "\s\s\n" + encapsulate_string(body_paragraph)

"**#{line}** #{encapsulated_body}"
end

def body_till_first_break(body)
body.split(/\n/).first
end

def issue_line_with_user(line, issue)
Expand Down
1 change: 1 addition & 0 deletions 1 lib/github_changelog_generator/options.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ class Options < SimpleDelegator
include_labels
issue_prefix
issue_line_labels
issue_line_body
issues
max_issues
merge_prefix
Expand Down
157 changes: 131 additions & 26 deletions 157 spec/unit/generator/entry_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,27 +7,29 @@ def label(name)
{ "name" => name }
end

def issue(title, labels, number = "1", user = { "login" => "user" })
def issue(title, labels, body = "", 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,
"body" => body,
"events" => [{
"event" => "closed"
}]
}
end

def pr(title, labels, number = "1", user = { "login" => "user" })
def pr(title, labels, body = "", 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']}"),
"body" => body,
"merged_at" => Time.now.utc,
"events" => [{
"event" => "merged",
Expand Down Expand Up @@ -107,33 +109,33 @@ def default_sections
describe "#generate_entry_for_tag" do
let(:issues) do
[
issue("no labels", [], "5", "login" => "user1"),
issue("breaking", ["breaking"], "8", "login" => "user5"),
issue("enhancement", ["enhancement"], "6", "login" => "user2"),
issue("bug", ["bug"], "7", "login" => "user1"),
issue("deprecated", ["deprecated"], "13", "login" => "user5"),
issue("removed", ["removed"], "14", "login" => "user2"),
issue("security", ["security"], "15", "login" => "user5"),
issue("all the labels", %w[breaking enhancement bug deprecated removed security], "9", "login" => "user9"),
issue("all the labels different order", %w[bug breaking enhancement security removed deprecated], "10", "login" => "user5"),
issue("some unmapped labels", %w[tests-fail bug], "11", "login" => "user5"),
issue("no mapped labels", %w[docs maintenance], "12", "login" => "user5")
issue("no labels", [], "", "5", "login" => "user1"),
issue("breaking", ["breaking"], "", "8", "login" => "user5"),
issue("enhancement", ["enhancement"], "", "6", "login" => "user2"),
issue("bug", ["bug"], "", "7", "login" => "user1"),
issue("deprecated", ["deprecated"], "", "13", "login" => "user5"),
issue("removed", ["removed"], "", "14", "login" => "user2"),
issue("security", ["security"], "", "15", "login" => "user5"),
issue("all the labels", %w[breaking enhancement bug deprecated removed security], "", "9", "login" => "user9"),
issue("all the labels different order", %w[bug breaking enhancement security removed deprecated], "", "10", "login" => "user5"),
issue("some unmapped labels", %w[tests-fail bug], "", "11", "login" => "user5"),
issue("no mapped labels", %w[docs maintenance], "", "12", "login" => "user5")
]
end

let(:pull_requests) do
[
pr("no labels", [], "20", "login" => "user1"),
pr("breaking", ["breaking"], "23", "login" => "user5"),
pr("enhancement", ["enhancement"], "21", "login" => "user5"),
pr("bug", ["bug"], "22", "login" => "user5"),
pr("deprecated", ["deprecated"], "28", "login" => "user5"),
pr("removed", ["removed"], "29", "login" => "user2"),
pr("security", ["security"], "30", "login" => "user5"),
pr("all the labels", %w[breaking enhancement bug deprecated removed security], "24", "login" => "user5"),
pr("all the labels different order", %w[bug breaking enhancement security remove deprecated], "25", "login" => "user5"),
pr("some unmapped labels", %w[tests-fail bug], "26", "login" => "user5"),
pr("no mapped labels", %w[docs maintenance], "27", "login" => "user5")
pr("no labels", [], "", "20", "login" => "user1"),
pr("breaking", ["breaking"], "", "23", "login" => "user5"),
pr("enhancement", ["enhancement"], "", "21", "login" => "user5"),
pr("bug", ["bug"], "", "22", "login" => "user5"),
pr("deprecated", ["deprecated"], "", "28", "login" => "user5"),
pr("removed", ["removed"], "", "29", "login" => "user2"),
pr("security", ["security"], "", "30", "login" => "user5"),
pr("all the labels", %w[breaking enhancement bug deprecated removed security], "", "24", "login" => "user5"),
pr("all the labels different order", %w[bug breaking enhancement security remove deprecated], "", "25", "login" => "user5"),
pr("some unmapped labels", %w[tests-fail bug], "", "26", "login" => "user5"),
pr("no mapped labels", %w[docs maintenance], "", "27", "login" => "user5")
]
end

Expand Down Expand Up @@ -211,9 +213,112 @@ def default_sections

CHANGELOG

expect(subject.generate_entry_for_tag(pull_requests, issues, "1.0.1", "1.0.1", Time.new(2017, 12, 4).utc, "1.0.0")).to eq(changelog)
expect(subject.generate_entry_for_tag(pull_requests, issues, "1.0.1", "1.0.1", Time.new(2017, 12, 4, 12, 0, 0, "+00:00").utc, "1.0.0")).to eq(changelog)
end
end

describe "#create_entry_for_tag_with_body" do
let(:options) do
Parser.default_options.merge(
user: "owner",
project: "repo",
bug_labels: ["bug"],
enhancement_labels: ["enhancement"],
breaking_labels: ["breaking"],
issue_line_body: true
)
end

let(:issues_with_body) do
[
issue("no labels", [], "Issue body description", "5", "login" => "user1"),
issue("breaking", ["breaking"], "Issue body description very long: Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec quam felis, ultricies nec, pellentesque eu, pretium quis, sem. Nulla consequat massa quis enim. Donec pede justo, fringilla vel, aliquet nec, vulputate eget, arcu. In enim justo, rhoncus ut, imperdiet a, venenatis vitae, justo. Nullam dictum felis eu pede mollis pretium. Integer tincidunt. Cras dapibus. Vivamus elementum semper nisi. Aenean vulputate eleifend tellus. Aenean leo ligula, porttitor eu, consequat vitae, eleifend ac, enim.", "8", "login" => "user5"),
issue("enhancement", ["enhancement"], "Issue body description", "6", "login" => "user2"),
issue("bug", ["bug"], "Issue body description", "7", "login" => "user1"),
issue("deprecated", ["deprecated"], "Issue body description", "13", "login" => "user5"),
issue("removed", ["removed"], "Issue body description", "14", "login" => "user2"),
issue("security", ["security"], "Issue body description", "15", "login" => "user5"),
issue("all the labels", %w[breaking enhancement bug deprecated removed security], "Issue body description. \nThis part should not appear.", "9", "login" => "user9"),
issue("all the labels different order", %w[bug breaking enhancement security removed deprecated], "Issue body description", "10", "login" => "user5"),
issue("some unmapped labels", %w[tests-fail bug], "Issue body description", "11", "login" => "user5"),
issue("no mapped labels", %w[docs maintenance], "Issue body description", "12", "login" => "user5")
]
end

let(:pull_requests_with_body) do
[
pr("no labels", [], "PR body description", "20", "login" => "user1"),
pr("breaking", ["breaking"], "PR body description very long: Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec quam felis, ultricies nec, pellentesque eu, pretium quis, sem. Nulla consequat massa quis enim. Donec pede justo, fringilla vel, aliquet nec, vulputate eget, arcu. In enim justo, rhoncus ut, imperdiet a, venenatis vitae, justo. Nullam dictum felis eu pede mollis pretium. Integer tincidunt. Cras dapibus. Vivamus elementum semper nisi. Aenean vulputate eleifend tellus. Aenean leo ligula, porttitor eu, consequat vitae, eleifend ac, enim.", "23", "login" => "user5"),
pr("enhancement", ["enhancement"], "PR body description", "21", "login" => "user5"),
pr("bug", ["bug"], "PR body description", "22", "login" => "user5"),
pr("deprecated", ["deprecated"], "PR body description", "28", "login" => "user5"),
pr("removed", ["removed"], "PR body description", "29", "login" => "user2"),
pr("security", ["security"], "PR body description", "30", "login" => "user5"),
pr("all the labels", %w[breaking enhancement bug deprecated removed security], "PR body description. \nThis part should not appear", "24", "login" => "user5"),
pr("all the labels different order", %w[bug breaking enhancement security remove deprecated], "PR body description", "25", "login" => "user5"),
pr("some unmapped labels", %w[tests-fail bug], "PR body description", "26", "login" => "user5"),
pr("no mapped labels", %w[docs maintenance], "PR body description", "27", "login" => "user5")
]
end

subject { described_class.new(options) }
it "generates issues and pull requests with body" do
changelog = <<-CHANGELOG.gsub(/^ {10}/, "")
## [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)** \nIssue body description very long: Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec quam felis, ultricies nec, pellentesque eu, pretium quis, sem. Nulla consequat massa quis enim. Donec pede justo, fringilla vel, aliquet nec, vulputate eget, arcu. In enim justo, rhoncus ut, imperdiet a, venenatis vitae, justo. Nullam dictum felis eu pede mollis pretium. Integer tincidunt. Cras dapibus. Vivamus elementum semper nisi. Aenean vulputate eleifend tellus. Aenean leo ligula, porttitor eu, consequat vitae, eleifend ac, enim.
- **issue all the labels [\\#9](https://github.com/owner/repo/issue/9)** \nIssue body description.
- **issue all the labels different order [\\#10](https://github.com/owner/repo/issue/10)** \nIssue body description
- **pr breaking [\\#23](https://github.com/owner/repo/pull/23) ([user5](https://github.com/user5))** \nPR body description very long: Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec quam felis, ultricies nec, pellentesque eu, pretium quis, sem. Nulla consequat massa quis enim. Donec pede justo, fringilla vel, aliquet nec, vulputate eget, arcu. In enim justo, rhoncus ut, imperdiet a, venenatis vitae, justo. Nullam dictum felis eu pede mollis pretium. Integer tincidunt. Cras dapibus. Vivamus elementum semper nisi. Aenean vulputate eleifend tellus. Aenean leo ligula, porttitor eu, consequat vitae, eleifend ac, enim.
- **pr all the labels [\\#24](https://github.com/owner/repo/pull/24) ([user5](https://github.com/user5))** \nPR body description.
- **pr all the labels different order [\\#25](https://github.com/owner/repo/pull/25) ([user5](https://github.com/user5))** \nPR body description

**Implemented enhancements:**

- **issue enhancement [\\#6](https://github.com/owner/repo/issue/6)** \nIssue body description
- **pr enhancement [\\#21](https://github.com/owner/repo/pull/21) ([user5](https://github.com/user5))** \nPR body description

**Fixed bugs:**

- **issue bug [\\#7](https://github.com/owner/repo/issue/7)** \nIssue body description
- **issue some unmapped labels [\\#11](https://github.com/owner/repo/issue/11)** \nIssue body description
- **pr bug [\\#22](https://github.com/owner/repo/pull/22) ([user5](https://github.com/user5))** \nPR body description
- **pr some unmapped labels [\\#26](https://github.com/owner/repo/pull/26) ([user5](https://github.com/user5))** \nPR body description

**Deprecated:**

- **issue deprecated [\\#13](https://github.com/owner/repo/issue/13)** \nIssue body description
- **pr deprecated [\\#28](https://github.com/owner/repo/pull/28) ([user5](https://github.com/user5))** \nPR body description

**Removed:**

- **issue removed [\\#14](https://github.com/owner/repo/issue/14)** \nIssue body description
- **pr removed [\\#29](https://github.com/owner/repo/pull/29) ([user2](https://github.com/user2))** \nPR body description

**Security fixes:**

- **issue security [\\#15](https://github.com/owner/repo/issue/15)** \nIssue body description
- **pr security [\\#30](https://github.com/owner/repo/pull/30) ([user5](https://github.com/user5))** \nPR body description

**Closed issues:**

- **issue no labels [\\#5](https://github.com/owner/repo/issue/5)** \nIssue body description
- **issue no mapped labels [\\#12](https://github.com/owner/repo/issue/12)** \nIssue body description

**Merged pull requests:**

- **pr no labels [\\#20](https://github.com/owner/repo/pull/20) ([user1](https://github.com/user1))** \nPR body description
- **pr no mapped labels [\\#27](https://github.com/owner/repo/pull/27) ([user5](https://github.com/user5))** \nPR body description

CHANGELOG
expect(subject.generate_entry_for_tag(pull_requests_with_body, issues_with_body, "1.0.1", "1.0.1", Time.new(2017, 12, 4, 12, 0, 0, "+00:00").utc, "1.0.0")).to eq(changelog)
end
end

describe "exclude issues without labels" do
let(:options) do
Parser.default_options.merge(
Expand Down Expand Up @@ -283,7 +388,7 @@ def default_sections

CHANGELOG

expect(subject.generate_entry_for_tag(pull_requests, issues, "1.0.1", "1.0.1", Time.new(2017, 12, 4).utc, "1.0.0")).to eq(changelog)
expect(subject.generate_entry_for_tag(pull_requests, issues, "1.0.1", "1.0.1", Time.new(2017, 12, 4, 12, 0, 0, "+00:00").utc, "1.0.0")).to eq(changelog)
end
end
end
Expand Down
6 changes: 5 additions & 1 deletion 6 ...tHubChangelogGenerator_OctoFetcher/_commits_before/when_API_is_valid/returns_commits.json
View file
Open in desktop

Large diffs are not rendered by default.

Morty Proxy This is a proxified and sanitized view of the page, visit original site.