-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Bindings to the git command-line interface
--   
--   Bindings to the git command-line interface
@package cli-git
@version 0.2.0.1

module Bindings.Cli.Git
type CommitId = Text

-- | Create a <a>ProcessSpec</a> for invoking <tt>git</tt> in a specified
--   repository path, using the given arguments.
gitProc :: FilePath -> [String] -> ProcessSpec

-- | Ensure that the given directory is a clean git repository. If the
--   repository has changes, throw an error.
ensureCleanGitRepo :: (MonadIO m, MonadLog Output m, MonadError e m, AsProcessFailure e, MonadFail m, AsUnstructuredError e, HasCliConfig e m, MonadMask m) => FilePath -> Bool -> Text -> m ()

-- | Call <tt>git</tt> in the specified directory with the given arguments
--   and return its standard output stream. Error messages from
--   <tt>git</tt>, if any, are printed with <a>Notice</a> verbosity.
readGitProcess :: (MonadIO m, MonadLog Output m, MonadError e m, AsProcessFailure e, MonadFail m, MonadMask m) => FilePath -> [String] -> m Text

-- | Modify the <a>ProcessSpec</a> to apply environment flags which ensure
--   <tt>git</tt> has no dependency on external information. Specifically:
--   
--   <ul>
--   <li>The <tt>HOME</tt> directory is unset</li>
--   <li><tt>GIT_CONFIG_NOSYSTEM</tt> is set to 1</li>
--   <li><tt>GIT_TERMINAL_PROMPT</tt> is set to 0 and <tt>GIT_ASKPASS</tt>
--   is set to <tt>echo</tt>, so that password prompts will not pop up</li>
--   <li>The SSH command used is <tt>ssh -o
--   PreferredAuthentications=password -o PubkeyAuthentication=no -o
--   GSSAPIAuthentication=no</tt></li>
--   </ul>
isolateGitProc :: ProcessSpec -> ProcessSpec

-- | Create a <a>ProcessSpec</a> for invoking <tt>git</tt> without a
--   specified repository, using the given arguments.
gitProcNoRepo :: [String] -> ProcessSpec
gitLsRemote :: (MonadIO m, MonadLog Output m, MonadError e m, AsProcessFailure e, MonadFail m, AsUnstructuredError e) => String -> Maybe GitRef -> Maybe String -> m (ExitCode, GitLsRemoteMaps)
gitLookupDefaultBranch :: GitLsRemoteMaps -> Either Text Text
gitLookupCommitForRef :: GitLsRemoteMaps -> GitRef -> Either Text CommitId
data GitRef
GitRef_Head :: GitRef
GitRef_Branch :: Text -> GitRef
GitRef_Tag :: Text -> GitRef
GitRef_Other :: Text -> GitRef
instance GHC.Classes.Ord Bindings.Cli.Git.GitRef
instance GHC.Classes.Eq Bindings.Cli.Git.GitRef
instance GHC.Show.Show Bindings.Cli.Git.GitRef