class Fastlane::Actions::AddUnreleasedChangelogAction

Public Class Methods

authors() click to toggle source
# File lib/fastlane/plugin/unreleased_changelog/actions/add_unreleased_changelog.rb, line 57
def self.authors
  ["crazymanish"]
end
available_options() click to toggle source
# File lib/fastlane/plugin/unreleased_changelog/actions/add_unreleased_changelog.rb, line 39
def self.available_options
  [
    FastlaneCore::ConfigItem.new(key: :entry,
                                 env_name: "FL_ADD_UNRELEASED_CHANGELOG_ENTRY",
                                 description: "The changelog entry in string format",
                                 is_string: true),
    FastlaneCore::ConfigItem.new(key: :type,
                                 env_name: "FL_ADD_UNRELEASED_CHANGELOG_TYPE",
                                 description: "The type of changelog i.e Added, Fixed, Security etc (default: Added) ",
                                 default_value: "Added"),
    FastlaneCore::ConfigItem.new(key: :file_name,
                                 env_name: "FL_ADD_UNRELEASED_CHANGELOG_FILE_NAME",
                                 description: "The YML file name to your release changelog, (default: 'changelog')",
                                 is_string: true,
                                 default_value: "changelog")
  ]
end
description() click to toggle source
# File lib/fastlane/plugin/unreleased_changelog/actions/add_unreleased_changelog.rb, line 35
def self.description
  "Add a new entry in unreleased changelog"
end
example_code() click to toggle source
# File lib/fastlane/plugin/unreleased_changelog/actions/add_unreleased_changelog.rb, line 61
def self.example_code
  [
    'add_unreleased_changelog(entry: "Some changelog entry")',
    'add_unreleased_changelog(entry: "Some changelog entry", type: "Fixed")',
    'add_unreleased_changelog(entry: "Some changelog entry", type: "Fixed", file_name: "changelog_file_name")'
  ]
end
is_supported?(platform) click to toggle source
# File lib/fastlane/plugin/unreleased_changelog/actions/add_unreleased_changelog.rb, line 69
def self.is_supported?(platform)
  true
end
run(params) click to toggle source
# File lib/fastlane/plugin/unreleased_changelog/actions/add_unreleased_changelog.rb, line 7
def self.run(params)
  require 'yaml'

  changelog_file_name = "#{params[:file_name]}.yml"
  UI.important("Adding unreleased changelog: \"#{changelog_file_name}\" 🚥")

  # 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] || {}

  # adding a new entry in changelog file
  (unreleased_changelog[params[:type]] ||= []) << params[:entry]

  # saving the changelog file
  changelog[unreleased_section_name] = unreleased_changelog
  File.open(changelog_file_path,"w") do |file|
    file.write changelog.to_yaml
  end

  UI.success("Successfully added a new entry in unreleased changelog. 📝")
end