Class: Fastlane::Actions::ReadChangelogAction

Inherits:
Action
  • Object
show all
Defined in:
lib/fastlane/plugin/changelog/actions/read_changelog.rb

Documentation collapse

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



111
112
113
 
# File 'lib/fastlane/plugin/changelog/actions/read_changelog.rb', line 111

def self.authors
  ["pajapro"]
end

.available_options ⇒ Object 



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/fastlane/plugin/changelog/actions/read_changelog.rb', line 77

def self.available_options
  [
    FastlaneCore::ConfigItem.new(key: :changelog_path,
                                 env_name: "FL_CHANGELOG_PATH",
                                 description: "The path to your project CHANGELOG.md",
                                 is_string: true,
                                 default_value: "./CHANGELOG.md",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :section_identifier,
                                 env_name: "FL_READ_CHANGELOG_SECTION_IDENTIFIER",
                                 description: "The unique section identifier to read content of",
                                 is_string: true,
                                 default_value: "[Unreleased]",
                                 optional: true,
                                 verify_block: proc do |value|
                                   UI.user_error!("Sections (##) in CHANGELOG format must be encapsulated in []") unless value.start_with?("[") && value.end_with?("]")
                                   UI.user_error!("Sections (##) in CHANGELOG format cannot be empty") if value[/\[(.*?)\]/, 1].empty?
                                 end),
    FastlaneCore::ConfigItem.new(key: :excluded_markdown_elements,
                                 env_name: "FL_READ_CHANGELOG_EXCLUDED_MARKDOWN_ELEMENTS",
                                 description: "Markdown elements you wish to exclude from the output",
                                 type: Array,
                                 default_value: ["###"],
                                 optional: true)
  ]
end

.description ⇒ Object 



69
70
71
 
# File 'lib/fastlane/plugin/changelog/actions/read_changelog.rb', line 69

def self.description
  "Reads content of a section from your project CHANGELOG.md file"
end

.details ⇒ Object 



73
74
75
 
# File 'lib/fastlane/plugin/changelog/actions/read_changelog.rb', line 73

def self.details
  "Use this action to read content of an arbitrary section from your project CHANGELOG.md"
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


115
116
117
 
# File 'lib/fastlane/plugin/changelog/actions/read_changelog.rb', line 115

def self.is_supported?(platform)
  true
end

.output ⇒ Object 



104
105
106
107
108
109
 
# File 'lib/fastlane/plugin/changelog/actions/read_changelog.rb', line 104

def self.output
  [
    ['READ_CHANGELOG_SECTION_CONTENT', 'Contains text from a section of your CHANGELOG.md file'],
    ['READ_CHANGELOG_CHANGELOG_PATH', 'Contains the path to the CHANGELOG.md file']
  ]
end

.remove_markdown(line, excluded_markdown_elements) ⇒ Object 



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/fastlane/plugin/changelog/actions/read_changelog.rb', line 48

def self.remove_markdown(line, excluded_markdown_elements)
  markdownless_line = line
  excluded_markdown_elements.each do |element|
    next unless line =~ /^#{element}/
    index_of_element = line.index(element)
    index_of_whitespace = index_of_element + element.to_s.length

    if line[index_of_whitespace] == " " # remove white space (if any) following the markdown element
      markdownless_line = markdownless_line.gsub(element.to_s + " ", "")
    else
      markdownless_line = markdownless_line.gsub(element.to_s, "")
    end
  end

  markdownless_line
end

.run(params) ⇒ Object 



9
10
11
12
13
14
15
16
17
18
19
20
21
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
 
# File 'lib/fastlane/plugin/changelog/actions/read_changelog.rb', line 9

def self.run(params)
  changelog_path = params[:changelog_path] unless params[:changelog_path].to_s.empty?
  changelog_path = Helper::ChangelogHelper.ensure_changelog_exists(changelog_path)

  section_identifier = params[:section_identifier] unless params[:section_identifier].to_s.empty?
  escaped_section_identifier = Regexp.escape(section_identifier[/\[(.*?)\]/, 1])

  excluded_markdown_elements = params[:excluded_markdown_elements]

  UI.message "Starting to read #{section_identifier} section from '#{changelog_path}' "

  section_content = ""
  found_section = false
  File.open(changelog_path, "r") do |file|
    file.each_line do |line|
      if found_section
        break if line =~ /\#{2}\s?\[(.*?)\]/
        if !excluded_markdown_elements.nil? && !excluded_markdown_elements.empty?
          markdownless_line = remove_markdown(line, excluded_markdown_elements)
          section_content.concat(markdownless_line)
        else
          section_content.concat(line)
        end
      end

      if line =~ /\#{2}\s?\[#{escaped_section_identifier}\]/
        found_section = true
      end
    end
  end

  UI.error("Could not find #{section_identifier} section in your CHANGELOG.md") if section_content.empty?

  UI.success("Finished reading #{section_identifier} section from '#{changelog_path}'") unless section_content.empty?

  Actions.lane_context[SharedValues::READ_CHANGELOG_CHANGELOG_PATH] = changelog_path
  Actions.lane_context[SharedValues::READ_CHANGELOG_SECTION_CONTENT] = section_content.strip
end