module Fastlane module Actions module SharedValues FL_CHANGELOG = :FL_CHANGELOG end class ChangelogFromGitCommitsAction < Action def self.run(params) if params[:between] from, to = params[:between] else from = Actions.last_git_tag_name(params[:match_lightweight_tag]) Helper.log.debug "Found the last Git tag: #{from}" to = 'HEAD' end Helper.log.info "Collecting Git commits between #{from} and #{to}".green changelog = Actions.git_log_between(params[:pretty], from, to) changelog = changelog.gsub("\n\n", "\n") if changelog # as there are duplicate newlines Actions.lane_context[SharedValues::FL_CHANGELOG] = changelog changelog end ##################################################### # @!group Documentation ##################################################### def self.description "Collect git commit messages into a changelog" end def self.details "By default, messages will be collected back to the last tag, but the range can be controlled" end def self.output ['FL_CHANGELOG', 'The changelog String generated from the collected Git commit messages'] end def self.available_options [ FastlaneCore::ConfigItem.new(key: :between, env_name: 'FL_CHANGELOG_FROM_GIT_COMMITS_BETWEEN', description: 'Array containing two Git revision values between which to collect messages', optional: true, is_string: false, verify_block: proc do |value| raise ":between must be of type array".red unless value.kind_of?(Array) raise ":between must be an array of size 2".red unless (value || []).size == 2 end), FastlaneCore::ConfigItem.new(key: :pretty, env_name: 'FL_CHANGELOG_FROM_GIT_COMMITS_PRETTY', description: 'The format applied to each commit while generating the collected value', optional: true, default_value: '%B', is_string: true), FastlaneCore::ConfigItem.new(key: :match_lightweight_tag, env_name: 'FL_CHANGELOG_FROM_GIT_COMMITS_MATCH_LIGHTWEIGHT_TAG', description: 'Whether or not to match a lightweight tag when searching for the last one', optional: true, default_value: true, is_string: false) ] end def self.return_value "Returns a String containing your formatted git commits" end def self.author ['mfurtak', 'asfalcone'] end def self.is_supported?(platform) true end end end end