Class: Gitlab::Changelog::Release
- Inherits:
-
Object
- Object
- Gitlab::Changelog::Release
- Defined in:
- lib/gitlab/changelog/release.rb
Overview
A release to add to a changelog.
Instance Attribute Summary collapse
-
#version ⇒ Object
readonly
Returns the value of attribute version.
Instance Method Summary collapse
- #add_entry(title:, commit:, category:, author: nil, merge_request: nil) ⇒ Object
- #header_start_pattern ⇒ Object
-
#initialize(version:, date:, config:) ⇒ Release
constructor
A new instance of Release.
- #to_markdown ⇒ Object
Constructor Details
#initialize(version:, date:, config:) ⇒ Release
Returns a new instance of Release.
9 10 11 12 13 14 15 16 17 18 19 20 |
# File 'lib/gitlab/changelog/release.rb', line 9 def initialize(version:, date:, config:) @version = version @date = date @config = config @entries = Hash.new { |h, k| h[k] = [] } # This ensures that entries are presented in the same order as the # categories Hash in the user's configuration. @config.categories.values.each do |category| @entries[category] = [] end end |
Instance Attribute Details
#version ⇒ Object (readonly)
Returns the value of attribute version.
7 8 9 |
# File 'lib/gitlab/changelog/release.rb', line 7 def version @version end |
Instance Method Details
#add_entry(title:, commit:, category:, author: nil, merge_request: nil) ⇒ Object
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 |
# File 'lib/gitlab/changelog/release.rb', line 22 def add_entry( title:, commit:, category:, author: nil, merge_request: nil ) # When changing these fields, keep in mind that this needs to be # backwards compatible. For example, you can't just remove a field as # this will break the changelog generation process for existing users. entry = { 'title' => title, 'commit' => { 'reference' => commit.to_reference(full: true), 'trailers' => commit.trailers } } if entry['author'] = { 'reference' => .to_reference(full: true), 'contributor' => @config.contributor?() } entry['author']['credit'] = entry['author']['contributor'] || @config.() end if merge_request entry['merge_request'] = { 'reference' => merge_request.to_reference(full: true) } end @entries[@config.category(category)] << entry end |
#header_start_pattern ⇒ Object
80 81 82 |
# File 'lib/gitlab/changelog/release.rb', line 80 def header_start_pattern /^##\s*#{Regexp.escape(@version)}/ end |
#to_markdown ⇒ Object
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 |
# File 'lib/gitlab/changelog/release.rb', line 57 def to_markdown state = TemplateParser::EvalState.new data = { 'categories' => entries_for_template } # While not critical, we would like release sections to be separated by # an empty line in the changelog; ensuring it's readable even in its # raw form. # # Since it can be a bit tricky to get this right in a template, we # enforce an empty line separator ourselves. markdown = begin @config.template.evaluate(state, data).strip rescue TemplateParser::Error => e raise Error, e. end # The release header can't be changed using the Liquid template, as we # need this to be in a known format. Without this restriction, we won't # know where to insert a new release section in an existing changelog. "## #{@version} (#{release_date})\n\n#{markdown}\n\n" end |