Class: GitHubChangelogGenerator::ChangelogGenerator

Inherits:

Object

• Object
• GitHubChangelogGenerator::ChangelogGenerator

Defined in:

lib/github_changelog_generator.rb

Overview

Main class and entry point for this script.

Instance Method Summary

• #initialize ⇒ Object constructor

  Class, responsible for whole change log generation cycle.

• #run ⇒ Object

  The entry point of this script to generate change log.

Constructor Details

#initialize ⇒ Object

Class, responsible for whole change log generation cycle

# File 'lib/github_changelog_generator.rb', line 21

def initialize
  @options = Parser.parse_options
  @generator = Generator.new @options
end

Instance Method Details

#run ⇒ Object

The entry point of this script to generate change log

Raises:

• (ChangelogGeneratorError) —

  Is thrown when one of specified tags was not found in list of tags.

# File 'lib/github_changelog_generator.rb', line 28

def run
  log = @generator.compound_changelog

  output_filename = (@options[:output]).to_s
  File.open(output_filename, "w") { |file| file.write(log) }
  puts "Done!"
  puts "Generated log placed in #{Dir.pwd}/#{output_filename}"
end