class Fastlane::Actions::EnsureNoChangesAction

Public Class Methods

authors() click to toggle source
# File lib/fastlane/plugin/menigit/actions/ensure_no_changes.rb, line 61
def self.authors
  ["Marcin Stepnowski"]
end
available_options() click to toggle source
# File lib/fastlane/plugin/menigit/actions/ensure_no_changes.rb, line 26
def self.available_options
  [
    FastlaneCore::ConfigItem.new(key: :path,
                                 env_name: "ENSURE_NO_CHANGES_PATH",
                                 description: "Path for directory/file that you want check for diff",
                                 optional: false,
                                 type: String),
    FastlaneCore::ConfigItem.new(key: :show_diff,
                                 env_name: "ENSURE_NO_CHANGES_SHOW_DIFF",
                                 description: "The flag whether to show the git diff if the repo is dirty",
                                 optional: true,
                                 default_value: false,
                                 type: Boolean),
    FastlaneCore::ConfigItem.new(key: :error_message,
                                 env_name: "ENSURE_NO_CHANGES_ERROR_MESSAGE",
                                 description: "Error message that will be show instead of default one based on path",
                                 optional: true,
                                 type: String)
  ]
end
category() click to toggle source
# File lib/fastlane/plugin/menigit/actions/ensure_no_changes.rb, line 53
def self.category
  :source_control
end
description() click to toggle source
# File lib/fastlane/plugin/menigit/actions/ensure_no_changes.rb, line 22
def self.description
  "Raises an exception if there are uncommitted git changes at path"
end
example_code() click to toggle source
# File lib/fastlane/plugin/menigit/actions/ensure_no_changes.rb, line 47
def self.example_code
  [
    'ensure_no_changes(path: "fastlane/Fastfile", show_diff: true)'
  ]
end
is_supported?(platform) click to toggle source
# File lib/fastlane/plugin/menigit/actions/ensure_no_changes.rb, line 57
def self.is_supported?(platform)
  true
end
run(params) click to toggle source
# File lib/fastlane/plugin/menigit/actions/ensure_no_changes.rb, line 6
def self.run(params)
  path = params[:path]
  git_diff = Actions.sh("git diff #{path}")
  no_changes = git_diff.empty?
  if no_changes
    UI.success("Git diff for #{path} is clean, all good! 💪")
  else
    error_message = params[:error_message]
    error_message ||= "Git diff for #{path} is dirty! Please ensure the repo is in a clean state by committing/stashing/discarding all changes first."
    if params[:show_diff]
      error_message += "\nGit diff:\n#{git_diff}"
    end
    UI.user_error!(error_message)
  end
end