Modulegithash-0.1.7.0Haskell2010

GitHash

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.

2 types
15 values

Packagegithash-0.1.7.0
Exports17
LanguageHaskell2010
LicenceBSD-3-Clause
SourceGitHash.hs

Types

2 declarations

datadata GitInfo

Various pieces of information about a Git repository.

Instances2Show, Lift

Show GitInfoDefined in githash-0.1.7.0 · GitHash
Lift GitInfoDefined in githash-0.1.7.0 · GitHash

datadata GitHashException

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

Constructors

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

Instances3Eq, Show, Exception

Eq GitHashExceptionDefined in githash-0.1.7.0 · GitHash
Show GitHashExceptionDefined in githash-0.1.7.0 · GitHash
Exception GitHashExceptionDefined in githash-0.1.7.0 · GitHash

Getters

valuegiHash :: GitInfo -> String

The hash of the most recent commit.

valuegiBranch :: GitInfo -> String

The hash of the most recent commit.

valuegiDirty :: GitInfo -> Bool

valuegiCommitDate :: GitInfo -> String

valuegiCommitCount :: GitInfo -> Int

valuegiCommitMessage :: GitInfo -> String

The message of the most recent commit.

valuegiDescribe :: GitInfo -> String

The output of git describe --always for the most recent commit.

valuegiTag :: GitInfo -> String

The output of git describe --always --tags for the most recent commit.

valuegiFiles :: GitInfo -> [FilePath]

The files used to determine whether recompilation is necessary in splices.

Creators

2 declarations

valuegetGitInfo :: FilePath -> IO (Either GitHashException GitInfo)

Get the GitInfo for the given root directory. Root directory should be the directory containing the .git directory.

valuegetGitRoot :: FilePath -> IO (Either GitHashException FilePath)

Get the root directory of the Git repo containing the given file path.

Template Haskell

4 declarations

valuetGitInfo :: FilePath -> SpliceQ GitInfo

Load up the GitInfo value at compile time for the given directory. Compilation fails if no info is available.

valuetGitInfoCwd :: SpliceQ GitInfo

Load up the GitInfo value at compile time for the current working directory.

valuetGitInfoTry :: FilePath -> SpliceQ (Either String GitInfo)

Try to load up the GitInfo value at compile time for the given directory.

valuetGitInfoCwdTry :: SpliceQ (Either String GitInfo)

Try to load up the GitInfo value at compile time for the current working directory.