Contents

module Fastlane
  module Actions
    module SharedValues
      GIT_REPO_WAS_CLEAN_ON_START = :GIT_REPO_WAS_CLEAN_ON_START
    end

    # Raises an exception and stop the lane execution if the repo is not in a clean state
    class EnsureGitStatusCleanAction < Action
      def self.run(params)
        repo_clean = `git status --porcelain`.empty?

        if repo_clean
          UI.success('Git status is clean, all good! 💪')
          Actions.lane_context[SharedValues::GIT_REPO_WAS_CLEAN_ON_START] = true
        else
          UI.user_error!("Git repository is dirty! Please ensure the repo is in a clean state by commiting/stashing/discarding all changes first.")
        end
      end

      def self.description
        "Raises an exception if there are uncommited git changes"
      end

      def self.details
        [
          'A sanity check to make sure you are working in a repo that is clean. Especially',
          'useful to put at the beginning of your Fastfile in the `before_all` block, if',
          'some of your other actions will touch your filesystem, do things to your git repo,',
          'or just as a general reminder to save your work. Also needed as a prerequisite for',
          'some other actions like `reset_git_repo`.'
        ].join("\n")
      end

      def self.output
        [
          ['GIT_REPO_WAS_CLEAN_ON_START', 'Stores the fact that the git repo was clean at some point']
        ]
      end

      def self.author
        "lmirosevic"
      end

      def self.example_code
        ['ensure_git_status_clean']
      end

      def self.category
        :source_control
      end

      def self.is_supported?(platform)
        true
      end
    end
  end
end

Version data entries

106 entries across 106 versions & 1 rubygems

Version	Path
fastlane-1.106.1	lib/fastlane/actions/ensure_git_status_clean.rb
fastlane-1.106.0	lib/fastlane/actions/ensure_git_status_clean.rb
fastlane-1.105.3	lib/fastlane/actions/ensure_git_status_clean.rb
fastlane-1.105.2	lib/fastlane/actions/ensure_git_status_clean.rb
fastlane-1.105.1	lib/fastlane/actions/ensure_git_status_clean.rb
fastlane-1.105.0	lib/fastlane/actions/ensure_git_status_clean.rb