Module: Release::Notes

Defined in:
lib/release/notes.rb,
lib/release/notes/git.rb,
lib/release/notes/log.rb,
lib/release/notes/tag.rb,
lib/release/notes/link.rb,
lib/release/notes/write.rb,
lib/release/notes/system.rb,
lib/release/notes/commits.rb,
lib/release/notes/railtie.rb,
lib/release/notes/version.rb,
lib/release/notes/prettify.rb,
lib/release/notes/configurable.rb,
lib/release/notes/configuration.rb,
lib/release/notes/date_formatter.rb,
lib/generators/release/notes/install/install_generator.rb

Defined Under Namespace

Modules: Configurable, Generators, Link Classes: Commits, Configuration, DateFormatter, Git, Log, Prettify, Railtie, System, Tag, Write

Constant Summary collapse

NEWLINE =
"\n"
VERSION =
"3.0.0"

Class Method Summary collapse

Class Method Details

.configurationRelease::Notes::Configuration


219
220
221
# File 'lib/release/notes/configuration.rb', line 219

def self.configuration
  @configuration ||= Configuration.new
end

.configuration=(config) ⇒ Object

Set Release::Notes's configuration


225
226
227
# File 'lib/release/notes/configuration.rb', line 225

def self.configuration=(config)
  @configuration = config
end

.configure {|config| ... } ⇒ Object

Modify Release::Notes's current configuration

Release::Notes.configure do |config|
  config.routes = false
end

Yield Parameters:


236
237
238
# File 'lib/release/notes/configuration.rb', line 236

def self.configure
  yield configuration
end

.generateObject


29
30
31
# File 'lib/release/notes.rb', line 29

def generate
  log.perform
end

.logObject (private)


39
40
41
# File 'lib/release/notes.rb', line 39

def log
  Log.new
end

.rootObject


33
34
35
# File 'lib/release/notes.rb', line 33

def root
  File.expand_path("..", __dir__)
end