Class: Fastlane::Actions::UpdateChangelogAction

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

Documentation collapse

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



148
149
150
 
# File 'lib/fastlane/plugin/changelog/actions/update_changelog.rb', line 148

def self.authors
  ["pajapro"]
end

.available_options ⇒ Object 



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/fastlane/plugin/changelog/actions/update_changelog.rb', line 100

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_UPDATE_CHANGELOG_SECTION_IDENTIFIER",
                                 description: "The unique section identifier to update 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: :updated_section_identifier,
                                 env_name: "FL_UPDATE_CHANGELOG_UPDATED_SECTION_IDENTIFIER",
                                 description: "The updated unique section identifier (without square brackets)",
                                 is_string: true,
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :should_append_date,
                                 env_name: "FL_UPDATE_CHANGELOG_SHOULD_APPEND_DATE",
                                 description: "Specifies whether the current date as per the append_datetime_format should be appended to section identifier",
                                 default_value: true,
                                 is_string: false,
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :append_datetime_format,
                                 env_name: "FL_UPDATE_CHANGELOG_APPEND_DATETIME_FORMAT",
                                 description: "The strftime format string to use for the date after the section identifier",
                                 default_value: '%FZ',
                                 is_string: true,
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :excluded_placeholder_line,
                                 env_name: "FL_UPDATE_CHANGELOG_EXCLUDED_PLACEHOLDER_LINE",
                                 description: "Placeholder string to be ignored in updated section",
                                 is_string: true,
                                 optional: true)
    # FastlaneCore::ConfigItem.new(key: :updated_section_content,
    #                              env_name: "FL_UPDATE_CHANGELOG_UPDATED_SECTION_CONTENT",
    #                              description: "The updated section content",
    #                              is_string: true,
    #                              optional: true)
  ]
end

.description ⇒ Object 



92
93
94
 
# File 'lib/fastlane/plugin/changelog/actions/update_changelog.rb', line 92

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

.details ⇒ Object 



96
97
98
 
# File 'lib/fastlane/plugin/changelog/actions/update_changelog.rb', line 96

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

.is_section_line(line) ⇒ Object 



84
85
86
 
# File 'lib/fastlane/plugin/changelog/actions/update_changelog.rb', line 84

def self.is_section_line(line)
  line =~ /\#{2}\s?\[.*\]/
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


152
153
154
 
# File 'lib/fastlane/plugin/changelog/actions/update_changelog.rb', line 152

def self.is_supported?(platform)
  true
end

.run(params) ⇒ Object 



4
5
6
7
8
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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/fastlane/plugin/changelog/actions/update_changelog.rb', line 4

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 = section_identifier[/\[(.*?)\]/, 1]

  new_section_identifier = params[:updated_section_identifier] unless params[:updated_section_identifier].to_s.empty?
  excluded_placeholder_line = params[:excluded_placeholder_line] unless params[:excluded_placeholder_line].to_s.empty?

  UI.message "Starting to update #{section_identifier} section of '#{changelog_path}'"

  # Read & update file content
  file_content = ""
  found_identifying_section = false

  File.open(changelog_path, "r") do |file|
    line_separator = Helper::ChangelogHelper.get_line_separator(changelog_path)
    file.each_line do |line|
      # 3. Ignore placeholder line (if provided) within the updated section
      if found_identifying_section && !excluded_placeholder_line.nil?
        if is_section_line(line)
          found_identifying_section = false # Reached the end of section, hence stop reading
        else
          if line =~ /^#{excluded_placeholder_line}/
            next # Ignore placeholder line, don't output it
          else
            file_content.concat(line) # Output unmodified line
            next
          end
        end
      end

      # 1. Find line matching section identifier
      if line =~ /\#{2}\s?\[#{escaped_section_identifier}\]/
        found_identifying_section = true
      else
        found_identifying_section = false
      end

      # 2. Update section identifier (if found)
      if !new_section_identifier.empty? && found_identifying_section
        section_name = section_identifier[/\[(.*?)\]/, 1]

        line_old = line.dup
        line.sub!(section_name, new_section_identifier)

        should_append_date = params[:should_append_date]

        if should_append_date
          append_datetime_format = params[:append_datetime_format]

          now = Time.now.utc.strftime(append_datetime_format)
          ENV["FL_UPDATE_APPEND_DATETIME_VAL"] = now

          line.concat(" - " + now)
          line.delete!(line_separator) # remove line break, because concatenation adds line break between section identifer & date
          line.concat(line_separator) # add line break to the end of the string, in order to start next line on the next line
        end

        UI.message "Old section identifier: #{line_old.delete!("\n")}"
        UI.message "New section identifier: #{line.delete("\n")}"

        # Output updated line
        file_content.concat(line)
        next
      end

      # Output read line
      file_content.concat(line)
    end
  end

  # Write updated content to file
  changelog = File.open(changelog_path, "w")
  changelog.puts(file_content)
  changelog.close
  UI.success("Successfully updated #{changelog_path}")
end