will/github-changelog-generator
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Make 'change log' a single word (#579)

Browse Source
This commit is contained in:
Saugat Acharya 2017-12-14 02:51:00 +05:45 committed by Olle Jonsson
parent d5f82c5994
commit d9cf6ffd94
15 changed files with 48 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
CHANGELOG.md
View File

@ -1,4 +1,4 @@
# Change Log
# Changelog
## [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)
@ -503,7 +503,7 @@
**Implemented enhancements:**
- Generate change log since/due specific tag [\#254](https://github.com/skywinder/github-changelog-generator/issues/254)
- Generate changelog since/due specific tag [\#254](https://github.com/skywinder/github-changelog-generator/issues/254)
- Add --base option [\#258](https://github.com/skywinder/github-changelog-generator/pull/258) ([raphink](https://github.com/raphink))
**Merged pull requests:**
@ -560,7 +560,7 @@
- Show `Unreleased` section even when there is no tags in repo. [\#228](https://github.com/skywinder/github-changelog-generator/issues/228)
- Add option `--exclude-tags x,y,z` [\#214](https://github.com/skywinder/github-changelog-generator/issues/214)
- Generate change log between 2 specific tags [\#172](https://github.com/skywinder/github-changelog-generator/issues/172)
- Generate changelog between 2 specific tags [\#172](https://github.com/skywinder/github-changelog-generator/issues/172)
- Yanked releases support [\#53](https://github.com/skywinder/github-changelog-generator/issues/53)
**Merged pull requests:**
@ -572,7 +572,7 @@
**Implemented enhancements:**
- Trees/Archives with missing change log notes for the current tag. [\#230](https://github.com/skywinder/github-changelog-generator/issues/230)
- Trees/Archives with missing changelog notes for the current tag. [\#230](https://github.com/skywinder/github-changelog-generator/issues/230)
**Fixed bugs:**
@ -591,7 +591,7 @@
**Implemented enhancements:**
- Parsing of existing Change Log file [\#212](https://github.com/skywinder/github-changelog-generator/issues/212)
- Parsing of existing Changelog 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)
- Cleanup [\#220](https://github.com/skywinder/github-changelog-generator/pull/220) ([tuexss](https://github.com/tuexss))
@ -855,4 +855,4 @@
## [0.0.1](https://github.com/skywinder/github-changelog-generator/tree/0.0.1) (2014-11-06)
\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

8
README.md
View File

@ -25,11 +25,11 @@ GitHub Changelog Generator ![GitHub Logo](../master/images/logo.jpg)
### Changelog generation has never been so easy
**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 changelog 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:
### *What’s the point of a change log?*
### *What’s the point of a changelog?*
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.
@ -103,7 +103,7 @@ 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 changelog generation examples**](https://github.com/skywinder/github-changelog-generator/wiki/Advanced-change-log-generation-examples)
### Params File
@ -177,7 +177,7 @@ You can look for params names from the [parser source code (#setup_parser)](http
## 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 changelog file, followed by [basic changelog guidelines](http://keepachangelog.com) :gem:
- Optionally generate **Unreleased** changes (closed issues that have not released yet) :dizzy:
- **GitHub Enterprise support** via command line options! :factory:
- Flexible format **customization**:

2
github_changelog_generator.gemspec
View File

@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
spec.email = "sky4winder+github_changelog_generator@gmail.com"
spec.summary = "Script, that automatically generate changelog from your tags, issues, labels and pull requests."
spec.description = "Changelog generation has never been so easy. Fully automate changelog generation - this gem generate change log file based on tags, issues and merged pull requests from Github issue tracker."
spec.description = "Changelog generation has never been so easy. Fully automate changelog generation - this gem generate changelog file based on tags, issues and merged pull requests from Github issue tracker."
spec.homepage = "https://github.com/skywinder/Github-Changelog-Generator"
spec.license = "MIT"

4
lib/github_changelog_generator.rb
View File

@ -22,14 +22,14 @@ require "github_changelog_generator/reader"
module GitHubChangelogGenerator
# Main class and entry point for this script.
class ChangelogGenerator
# Class, responsible for whole change log generation cycle
# Class, responsible for whole changelog generation cycle
# @return initialised instance of ChangelogGenerator
def initialize
@options = Parser.parse_options
@generator = Generator.new @options
end
# The entry point of this script to generate change log
# The entry point of this script to generate changelog
# @raise (ChangelogGeneratorError) Is thrown when one of specified tags was not found in list of tags.
def run
log = @generator.compound_changelog

2
lib/github_changelog_generator/generator/generator.rb
View File

@ -14,7 +14,7 @@ module GitHubChangelogGenerator
class Generator
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 changelog generation from ready-to-parse issues
#
# Example:
# generator = GitHubChangelogGenerator::Generator.new

8
lib/github_changelog_generator/generator/generator_generation.rb
View File

@ -2,9 +2,9 @@
module GitHubChangelogGenerator
class Generator
# Main function to start change log generation
# Main function to start changelog generation
#
# @return [String] Generated change log file
# @return [String] Generated changelog file
def compound_changelog
options.load_custom_ruby_files
fetch_and_filter_tags
@ -22,7 +22,7 @@ module GitHubChangelogGenerator
log += File.read(options[:base]) if File.file?(options[:base])
credit_line = "\n\n\\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*"
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
@ -113,7 +113,7 @@ module GitHubChangelogGenerator
end
# The full cycle of generation for whole project
# @return [String] The complete change log
# @return [String] The complete changelog
def generate_log_for_all_tags
puts "Generating log..." if options[:verbose]

2
lib/github_changelog_generator/octo_fetcher.rb
View File

@ -13,7 +13,7 @@ module GitHubChangelogGenerator
MAX_THREAD_NUMBER = 25
MAX_FORBIDDEN_RETRIES = 100
CHANGELOG_GITHUB_TOKEN = "CHANGELOG_GITHUB_TOKEN"
GH_RATE_LIMIT_EXCEEDED_MSG = "Warning: Can't finish operation: GitHub API rate limit exceeded, change log may be " \
GH_RATE_LIMIT_EXCEEDED_MSG = "Warning: Can't finish operation: GitHub API rate limit exceeded, changelog may be " \
"missing some issues. You can limit the number of issues fetched using the `--max-issues NUM` argument."
NO_TOKEN_PROVIDED = "Warning: No token provided (-t option) and variable $CHANGELOG_GITHUB_TOKEN was not found. " \
"This script can make only 50 requests to GitHub API per hour without token!"

10
lib/github_changelog_generator/parser.rb
View File

@ -68,7 +68,7 @@ module GitHubChangelogGenerator
opts.on("--issues-label [LABEL]", "Setup custom label for closed-issues section. Default is \"**Closed issues:**\"") do |v|
options[:issue_prefix] = v
end
opts.on("--header-label [LABEL]", "Setup custom header label. Default is \"# Change Log\"") do |v|
opts.on("--header-label [LABEL]", "Setup custom header label. Default is \"# Changelog\"") do |v|
options[:header] = 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|
@ -128,16 +128,16 @@ module GitHubChangelogGenerator
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
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, "Changelog will exclude specified tags") do |list|
options[:exclude_tags] = list
end
opts.on("--exclude-tags-regex [REGEX]", "Apply a regular expression on tag names so that they can be excluded, for example: --exclude-tags-regex \".*\+\d{1,}\" ") do |last|
options[:exclude_tags_regex] = last
end
opts.on("--since-tag x", "Change log will start after specified tag") do |v|
opts.on("--since-tag x", "Changelog will start after specified tag") do |v|
options[:since_tag] = v
end
opts.on("--due-tag x", "Change log will end before specified tag") do |v|
opts.on("--due-tag x", "Changelog will end before specified tag") do |v|
options[:due_tag] = v
end
opts.on("--max-issues [NUMBER]", Integer, "Max number of issues to fetch from GitHub. Default is unlimited") do |max|
@ -214,7 +214,7 @@ module GitHubChangelogGenerator
simple_list: false,
ssl_ca_file: nil,
verbose: true,
header: "# Change Log",
header: "# Changelog",
merge_prefix: "**Merged pull requests:**",
issue_prefix: "**Closed issues:**",
bug_prefix: "**Fixed bugs:**",

2
lib/github_changelog_generator/task.rb
View File

@ -38,7 +38,7 @@ module GitHubChangelogGenerator
end
def define(args, &task_block)
desc "Generate a Change log from GitHub"
desc "Generate a Changelog from GitHub"
yield(*[self, args].slice(0, task_block.arity)) if task_block

10
man/git-generate-changelog.1
View File

@ -10,7 +10,7 @@
\fBgit generate\-changelog\fR [\-h|\-\-help] [\-u|\-\-user] [\-p|\-\-project]
.
.SH "DESCRIPTION"
Automatically generate change log from your tags, issues, labels and pull requests on GitHub\.
Automatically generate changelog from your tags, issues, labels and pull requests on GitHub\.
.
.SH "OPTIONS"
\-u, \-\-user [USER]
@ -70,7 +70,7 @@ Setup custom label for closed\-issues section\. Default is "\fBClosed issues:\fR
\-\-header\-label [LABEL]
.
.P
Setup custom header label\. Default is "# Change Log"
Setup custom header label\. Default is "# Changelog"
.
.P
\-\-front\-matter [JSON]
@ -178,7 +178,7 @@ Issues with the specified labels will be always added to "Implemented enhancemen
\-\-exclude\-tags x,y,z
.
.P
Change log will exclude specified tags
Changelog will exclude specified tags
.
.P
\-\-exclude\-tags\-regex [REGEX]
@ -190,13 +190,13 @@ Apply a regular expression on tag names so that they can be excluded, for exampl
\-\-since\-tag x
.
.P
Change log will start after specified tag
Changelog will start after specified tag
.
.P
\-\-due\-tag x
.
.P
Change log will end before specified tag
Changelog will end before specified tag
.
.P
\-\-max\-issues [NUMBER]

10
man/git-generate-changelog.1.html
View File

@ -80,7 +80,7 @@
<h2 id="DESCRIPTION">DESCRIPTION</h2>
<p>Automatically generate change log from your tags, issues, labels and pull requests on GitHub.</p>
<p>Automatically generate changelog from your tags, issues, labels and pull requests on GitHub.</p>
<h2 id="OPTIONS">OPTIONS</h2>
@ -122,7 +122,7 @@
<p> --header-label [LABEL]</p>
<p> Setup custom header label. Default is "# Change Log"</p>
<p> Setup custom header label. Default is "# Changelog"</p>
<p> --front-matter [JSON]</p>
@ -194,7 +194,7 @@
<p> --exclude-tags x,y,z</p>
<p> Change log will exclude specified tags</p>
<p> Changelog will exclude specified tags</p>
<p> --exclude-tags-regex [REGEX]</p>
@ -202,11 +202,11 @@
<p> --since-tag x</p>
<p> Change log will start after specified tag</p>
<p> Changelog will start after specified tag</p>
<p> --due-tag x</p>
<p> Change log will end before specified tag</p>
<p> Changelog will end before specified tag</p>
<p> --max-issues [NUMBER]</p>

10
man/git-generate-changelog.html
View File

@ -80,7 +80,7 @@
<h2 id="DESCRIPTION">DESCRIPTION</h2>
<p>Automatically generate change log from your tags, issues, labels and pull requests on GitHub.</p>
<p>Automatically generate changelog from your tags, issues, labels and pull requests on GitHub.</p>
<h2 id="OPTIONS">OPTIONS</h2>
@ -122,7 +122,7 @@
<p> --header-label [LABEL]</p>
<p> Setup custom header label. Default is "# Change Log"</p>
<p> Setup custom header label. Default is "# Changelog"</p>
<p> --pr-label [LABEL]</p>
@ -186,15 +186,15 @@
<p> --exclude-tags x,y,z</p>
<p> Change log will exclude specified tags</p>
<p> Changelog will exclude specified tags</p>
<p> --since-tag x</p>
<p> Change log will start after specified tag</p>
<p> Changelog will start after specified tag</p>
<p> --due-tag x</p>
<p> Change log will end before specified tag</p>
<p> Changelog will end before specified tag</p>
<p> --max-issues [NUMBER]</p>

10
man/git-generate-changelog.md
View File

@ -7,7 +7,7 @@ git-generate-changelog(1) - Generate changelog from github
## DESCRIPTION
Automatically generate change log from your tags, issues, labels and pull requests on GitHub.
Automatically generate changelog from your tags, issues, labels and pull requests on GitHub.
## OPTIONS
@ -49,7 +49,7 @@ Automatically generate change log from your tags, issues, labels and pull reques
--header-label [LABEL]
Setup custom header label. Default is "# Change Log"
Setup custom header label. Default is "# Changelog"
--front-matter [JSON]
@ -121,7 +121,7 @@ Automatically generate change log from your tags, issues, labels and pull reques
--exclude-tags x,y,z
Change log will exclude specified tags
Changelog will exclude specified tags
--exclude-tags-regex [REGEX]
@ -129,11 +129,11 @@ Automatically generate change log from your tags, issues, labels and pull reques
--since-tag x
Change log will start after specified tag
Changelog will start after specified tag
--due-tag x
Change log will end before specified tag
Changelog will end before specified tag
--max-issues [NUMBER]

4
spec/files/github-changelog-generator.md
View File

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

2
spec/unit/reader_spec.rb
View File

@ -51,7 +51,7 @@ describe GitHubChangelogGenerator::Reader do
it { is_expected.to be_empty }
end
context "when file has only the header" do
subject { @reader.parse("# Change Log") }
subject { @reader.parse("# Changelog") }
it { is_expected.to be_an(Array) }
it { is_expected.to be_empty }
end