class Fastlane::Actions::DeleteUnreleasedChangelogAction

Public Class Methods

authors() click to toggle source
# File lib/fastlane/plugin/unreleased_changelog/actions/delete_unreleased_changelog.rb, line 66
def self.authors
  ["crazymanish"]
end
available_options() click to toggle source
# File lib/fastlane/plugin/unreleased_changelog/actions/delete_unreleased_changelog.rb, line 52
def self.available_options
  [
    FastlaneCore::ConfigItem.new(key: :entry,
                                 env_name: "FL_DELETE_UNRELEASED_CHANGELOG_ENTRY",
                                 description: "The changelog entry in string format",
                                 is_string: true),
    FastlaneCore::ConfigItem.new(key: :file_name,
                                 env_name: "FL_DELETE_UNRELEASED_CHANGELOG_FILE_NAME",
                                 description: "The YML file name to your release changelog, (default: 'changelog')",
                                 is_string: true,
                                 default_value: "changelog")
  ]
end
delete_changelog(entry, type, unreleased_changelog) click to toggle source
# File lib/fastlane/plugin/unreleased_changelog/actions/delete_unreleased_changelog.rb, line 38
def self.delete_changelog(entry, type, unreleased_changelog)
  if unreleased_changelog[type]
    unreleased_changelog[type] = unreleased_changelog[type].reject do |changelog|
      changelog.include?(entry)
    end

    unreleased_changelog[type] = nil if unreleased_changelog[type].to_a.empty?
  end
end
description() click to toggle source
# File lib/fastlane/plugin/unreleased_changelog/actions/delete_unreleased_changelog.rb, line 48
def self.description
  "Delete changelog entry from unreleased changelog"
end
example_code() click to toggle source
# File lib/fastlane/plugin/unreleased_changelog/actions/delete_unreleased_changelog.rb, line 70
def self.example_code
  [
    'delete_unreleased_changelog(entry: "Some changelog entry")',
    'delete_unreleased_changelog(entry: "Some changelog entry", file_name: "changelog_file_name")'
  ]
end
is_supported?(platform) click to toggle source
# File lib/fastlane/plugin/unreleased_changelog/actions/delete_unreleased_changelog.rb, line 77
def self.is_supported?(platform)
  true
end
run(params) click to toggle source
# File lib/fastlane/plugin/unreleased_changelog/actions/delete_unreleased_changelog.rb, line 7
def self.run(params)
  require 'yaml'

  changelog_entry = params[:entry]
  changelog_file_name = "#{params[:file_name]}.yml"
  UI.important("Deleting \"#{changelog_entry}\" from the unreleased changelog 🚥")

  # finding changelog file path
  changelog_file_path = Helper::UnreleasedChangelogHelper.changelog_file_path(changelog_file_name)
  unreleased_section_name = Helper::UnreleasedChangelogHelper.unreleased_section_name

  # opening the changelog file
  changelog = YAML.load_file(changelog_file_path)

  # finding the unreleased changelog
  unreleased_changelog = changelog[unreleased_section_name]

  # deleting entry from unreleased changelog
  changelog_types = Helper::UnreleasedChangelogHelper.changelog_types
  changelog_types.each do |changelog_type|
    delete_changelog(changelog_entry, changelog_type, unreleased_changelog)
  end

  # saving the changelog file
  File.open(changelog_file_path,"w") do |file|
    file.write changelog.to_yaml
  end

  UI.success("Successfully deleted \"#{changelog_entry}\" from the unreleased changelog. 🔥")
end