Skip to content

Commit

Permalink
standardize on breaking first
Browse files Browse the repository at this point in the history
  • Loading branch information
Jenny Knuth committed Apr 1, 2018
1 parent 7193354 commit 829da33
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 23 deletions.
5 changes: 3 additions & 2 deletions lib/github_changelog_generator/parser_file.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,9 @@ def extract_pair(line)
[key.tr("-", "_").to_sym, value.gsub(/[\n\r]+/, "")]
end

KNOWN_ARRAY_KEYS = %i[exclude_labels include_labels enhancement_labels bug_labels
breaking_labels deprecated_labels removed_labels security_labels
KNOWN_ARRAY_KEYS = %i[exclude_labels include_labels
breaking_labels enhancement_labels bug_labels
deprecated_labels removed_labels security_labels
issue_line_labels between_tags exclude_tags]
KNOWN_INTEGER_KEYS = [:max_issues]

Expand Down
42 changes: 21 additions & 21 deletions spec/unit/generator/entry_spec.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ def titles_for(issues)
end

def default_sections
%w[enhancements bugs breaking deprecated removed security issues]
%w[breaking enhancements bugs deprecated removed security issues]
end

# Default to no issues or PRs.
Expand Down Expand Up @@ -79,14 +79,14 @@ def default_sections
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("breaking", ["breaking"], "8", "login" => "user5"),
issue("deprecated", ["deprecated"], "13", "login" => "user5"),
issue("removed", ["removed"], "14", "login" => "user2"),
issue("security", ["security"], "15", "login" => "user5"),
issue("all the labels", %w[enhancement bug breaking deprecated removed security], "9", "login" => "user9"),
issue("all the labels different order", %w[breaking enhancement bug security removed deprecated], "10", "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")
]
Expand All @@ -95,14 +95,14 @@ def default_sections
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("breaking", ["breaking"], "23", "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[enhancement bug breaking deprecated removed security], "24", "login" => "user5"),
pr("all the labels different order", %w[breaking enhancement bug security remove deprecated], "25", "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")
]
Expand All @@ -114,9 +114,9 @@ def default_sections
Parser.default_options.merge(
user: "owner",
project: "repo",
breaking_labels: ["breaking"],
enhancement_labels: ["enhancement"],
bug_labels: ["bug"],
breaking_labels: ["breaking"],
deprecated_labels: ["deprecated"],
removed_labels: ["removed"],
security_labels: ["security"],
Expand Down Expand Up @@ -186,9 +186,9 @@ def default_sections
Parser.default_options.merge(
user: "owner",
project: "repo",
breaking_labels: ["breaking"],
enhancement_labels: ["enhancement"],
bug_labels: ["bug"],
breaking_labels: ["breaking"],
deprecated_labels: ["deprecated"],
removed_labels: ["removed"],
security_labels: ["security"],
Expand Down Expand Up @@ -292,6 +292,10 @@ def default_sections
context "hash" do
let(:sections_hash) do
{
breaking: {
prefix: "**Breaking**",
labels: ["breaking"]
},
enhancements: {
prefix: "**Enhancements**",
labels: %w[feature enhancement]
Expand All @@ -300,10 +304,6 @@ def default_sections
prefix: "**Bugs**",
labels: ["bug"]
},
breaking: {
prefix: "**Breaking**",
labels: ["breaking"]
},
deprecated: {
prefix: "**Deprecated**",
labels: ["deprecated"]
Expand All @@ -321,9 +321,9 @@ def default_sections

let(:sections_array) do
[
Section.new(name: "breaking", prefix: "**Breaking**", labels: ["breaking"]),
Section.new(name: "enhancements", prefix: "**Enhancements**", labels: %w[feature enhancement]),
Section.new(name: "bugs", prefix: "**Bugs**", labels: ["bug"]),
Section.new(name: "breaking", prefix: "**Breaking**", labels: ["breaking"]),
Section.new(name: "deprecated", prefix: "**Deprecated**", labels: ["deprecated"]),
Section.new(name: "removed", prefix: "**Removed**", labels: ["removed"]),
Section.new(name: "security", prefix: "**Security**", labels: ["security"])
Expand Down Expand Up @@ -354,9 +354,9 @@ def default_sections
context "default sections" do
let(:options) do
Parser.default_options.merge(
breaking_labels: ["breaking"],
enhancement_labels: ["enhancement"],
bug_labels: ["bug"],
breaking_labels: ["breaking"],
deprecated_labels: ["deprecated"],
removed_labels: ["removed"],
security_labels: ["security"],
Expand All @@ -366,14 +366,14 @@ def default_sections

let(:issues) do
[
issue("breaking", ["breaking"]),
issue("no labels", []),
issue("enhancement", ["enhancement"]),
issue("bug", ["bug"]),
issue("breaking", ["breaking"]),
issue("deprecated", ["deprecated"]),
issue("removed", ["removed"]),
issue("security", ["security"]),
issue("all the labels", %w[enhancement bug breaking deprecated removed security]),
issue("all the labels", %w[breaking enhancement bug deprecated removed security]),
issue("some unmapped labels", %w[tests-fail bug]),
issue("no mapped labels", %w[docs maintenance]),
issue("excluded label", %w[wontfix]),
Expand All @@ -384,13 +384,13 @@ def default_sections
let(:pull_requests) do
[
pr("no labels", []),
pr("breaking", ["breaking"]),
pr("enhancement", ["enhancement"]),
pr("bug", ["bug"]),
pr("breaking", ["breaking"]),
pr("deprecated", ["deprecated"]),
pr("removed", ["removed"]),
pr("security", ["security"]),
pr("all the labels", %w[enhancement bug breaking deprecated removed security]),
pr("all the labels", %w[breaking enhancement bug deprecated removed security]),
pr("some unmapped labels", %w[tests-fail bug], "15", "login" => "user5"),
pr("no mapped labels", %w[docs maintenance], "16", "login" => "user5"),
pr("excluded label", %w[wontfix]),
Expand All @@ -409,9 +409,9 @@ def default_sections
end

it "assigns issues to the correct sections" do
breaking_section = entry_sections.select { |section| section.name == "breaking" }[0]
enhancement_section = entry_sections.select { |section| section.name == "enhancements" }[0]
bug_section = entry_sections.select { |section| section.name == "bugs" }[0]
breaking_section = entry_sections.select { |section| section.name == "breaking" }[0]
deprecated_section = entry_sections.select { |section| section.name == "deprecated" }[0]
removed_section = entry_sections.select { |section| section.name == "removed" }[0]
security_section = entry_sections.select { |section| section.name == "security" }[0]
Expand Down Expand Up @@ -547,9 +547,9 @@ def default_sections
context "add sections" do
let(:options) do
Parser.default_options.merge(
breaking_labels: ["breaking"],
enhancement_labels: ["enhancement"],
bug_labels: ["bug"],
breaking_labels: ["breaking"],
deprecated_labels: ["deprecated"],
removed_labels: ["removed"],
security_labels: ["security"],
Expand Down

0 comments on commit 829da33

Please sign in to comment.