Skip to content

add option --[no-]issues-of-open-milestones #801

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
Aug 14, 2020
Merged

add option --[no-]issues-of-open-milestones #801

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
7c10174
add option --[no-]issues-of-open-milestones
Mairu Apr 17, 2020
7bb6abb
Merge branch 'master' into issues-of-open-milestones_option
dlanileonardo Aug 14, 2020
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
3 changes: 3 additions & 0 deletions lib/github_changelog_generator/generator/generator_processor.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,9 @@ def remove_issues_in_milestones(filtered_issues)
# leave issues without milestones
if issue["milestone"].nil?
true
# remove issues of open milestones if option is set
elsif issue["milestone"]["state"] == "open"
@options[:issues_of_open_milestones]
else
# check, that this milestone in tag list:
@filtered_tags.find { |tag| tag["name"] == issue["milestone"]["title"] }.nil?
Expand Down
1 change: 1 addition & 0 deletions lib/github_changelog_generator/options.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ class Options < SimpleDelegator
exclude_tags
exclude_tags_regex
filter_issues_by_milestone
issues_of_open_milestones
frontmatter
future_release
github_endpoint
Expand Down
4 changes: 4 additions & 0 deletions lib/github_changelog_generator/parser.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,9 @@ def self.setup_parser(options)
opts.on("--[no-]filter-by-milestone", "Use milestone to detect when issue was resolved. Default is true.") do |last|
options[:filter_issues_by_milestone] = last
end
opts.on("--[no-]issues-of-open-milestones", "Include issues of open milestones. Default is true.") do |v|
options[:issues_of_open_milestones] = v
end
opts.on("--[no-]author", "Add author of pull request at the end. Default is true.") do |author|
options[:author] = author
end
Expand Down Expand Up @@ -233,6 +236,7 @@ def self.default_options
add_pr_wo_labels: true,
pulls: true,
filter_issues_by_milestone: true,
issues_of_open_milestones: true,
author: true,
unreleased: true,
unreleased_label: "Unreleased",
Expand Down
6 changes: 6 additions & 0 deletions man/git-generate-changelog.1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,12 @@ Include pull\-requests in changelog\. Default is true\.
Use milestone to detect when issue was resolved\. Default is true\.
.
.P
\-\-[no\-]issues\-of\-open\-milestones
.
.P
Include issues of open milestones\. Default is true\.
.
.P
\-\-[no\-]author
.
.P
Expand Down
4 changes: 4 additions & 0 deletions man/git-generate-changelog.1.html
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions man/git-generate-changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,10 @@ Automatically generate changelog from your tags, issues, labels and pull request

Use milestone to detect when issue was resolved. Default is true.

--[no-]issues-of-open-milestones

Include issues of open milestones. Default is true.

--[no-]author

Add author of pull request at the end. Default is true.
Expand Down