Copyright	(c) 2018 Michael Snoyman 2015 Adam C. Foltzer
License	BSD3
Maintainer	michael@snoyman.com
Stability	provisional
Portability	portable
Safe Haskell	Safe-Inferred
Language	Haskell2010

GitHash

Contents

Types
- Getters
Creators
Template Haskell

Description

Some handy Template Haskell splices for including the current git hash and branch in the code of your project. Useful for including in panic messages, --version output, or diagnostic info for more informative bug reports.

{-# LANGUAGE TemplateHaskell #-}
import GitHash

panic :: String -> a
panic msg = error panicMsg
  where panicMsg =
          concat [ "[panic ", giBranch gi, "@", giHash gi
                 , " (", giCommitDate gi, ")"
                 , " (", show (giCommitCount gi), " commits in HEAD)"
                 , dirty, "] ", msg ]
        dirty | giDirty gi = " (uncommitted files present)"
              | otherwise   = ""
        gi = $$tGitInfoCwd

main = panic "oh no!"

% stack runghc Example.hs
Example.hs: [panic master@2ae047ba5e4a6f0f3e705a43615363ac006099c1 (Mon Jan 11 11:50:59 2016 -0800) (14 commits in HEAD) (uncommitted files present)] oh no!

WARNING: None of this will work in a git repository without any commits.

Since: 0.1.0.0

Synopsis

data GitInfo
data GitHashException
- = GHECouldn'tReadFile !FilePath !IOException
- | GHEInvalidCommitCount !FilePath !String
- | GHEInvalidGitFile !String
- | GHEGitRunFailed !FilePath ![String] !ExitCode !String !String
- | GHEGitRunException !FilePath ![String] !IOException
giHash :: GitInfo -> String
giBranch :: GitInfo -> String
giDirty :: GitInfo -> Bool
giCommitDate :: GitInfo -> String
giCommitCount :: GitInfo -> Int
giCommitMessage :: GitInfo -> String
giDescribe :: GitInfo -> String
giTag :: GitInfo -> String
getGitInfo :: FilePath -> IO (Either GitHashException GitInfo)
getGitRoot :: FilePath -> IO (Either GitHashException FilePath)
tGitInfo :: FilePath -> SpliceQ GitInfo
tGitInfoCwd :: SpliceQ GitInfo
tGitInfoTry :: FilePath -> SpliceQ (Either String GitInfo)
tGitInfoCwdTry :: SpliceQ (Either String GitInfo)

Types

data GitInfo Source #

Various pieces of information about a Git repository.

Since: 0.1.0.0

Instances

Instances details

Show GitInfo Source #
Instance details Defined in GitHash Methods showsPrec :: Int -> GitInfo -> ShowS show :: GitInfo -> String showList :: [GitInfo] -> ShowS
Lift GitInfo Source #
Instance details Defined in GitHash Methods lift :: GitInfo -> Q Exp liftTyped :: GitInfo -> Q (TExp GitInfo)

data GitHashException Source #

Exceptions which can occur when using this library's functions.

Since: 0.1.0.0

Constructors

GHECouldn'tReadFile !FilePath !IOException
GHEInvalidCommitCount !FilePath !String
GHEInvalidGitFile !String
GHEGitRunFailed !FilePath ![String] !ExitCode !String !String
GHEGitRunException !FilePath ![String] !IOException

Instances

Instances details

Eq GitHashException Source #
Instance details Defined in GitHash Methods (==) :: GitHashException -> GitHashException -> Bool (/=) :: GitHashException -> GitHashException -> Bool
Show GitHashException Source #
Instance details Defined in GitHash Methods showsPrec :: Int -> GitHashException -> ShowS show :: GitHashException -> String showList :: [GitHashException] -> ShowS
Exception GitHashException Source #
Instance details Defined in GitHash Methods toException :: GitHashException -> SomeException fromException :: SomeException -> Maybe GitHashException displayException :: GitHashException -> String