git.iko.soy/typeable/gitrev
on master help sign in
3 files changed+71−11
since splitsnapshots
unifiedsplit
README.md+5−5 gitrev.cabal+4−1 src/Development/GitRev.hs+62−5
README.md+5−5
@@ -11,13 +11,13 @@ places the current git hash might be stored:
11111. Detached HEAD: the hash is in `.git/HEAD`
12122. On a branch or tag: the hash is in a file pointed to by `.git/HEAD`
1313in a location like `.git/refs/heads`
14−3. On a branch or tag but in a repository with packed refs: the hash is
15−in `.git/packed-refs`
14+3. On a branch or tag but in a repository with packed refs: the hash
15+is in `.git/packed-refs`
16+4. In any of the above situations, if the current repo is checked out
17+as a submodule, follow the reference to its `.git` directory first
1618
1719These files are added as dependencies to modules that use `GitRev`, and
1820so the module should be rebuilt automatically whenever these files
1921change.
2022
21−These situations all arise under normal development workflows, but
22−there might be further scenarios that cause problems. Let me know if
23−you run into them!
23+If you run into further scenarios that cause problems, let me know!
gitrev.cabal+4−1
@@ -1,5 +1,5 @@
11name: gitrev
2−version: 1.2.0
2+version: 1.3.1
33synopsis: Compile git revision info into Haskell projects
44homepage: https://github.com/acfoltzer/gitrev
55license: BSD3
@@ -9,6 +9,7 @@ maintainer: acfoltzer@galois.com
99category: Development
1010build-type: Simple
1111cabal-version: >=1.10
12+tested-with: GHC == 7.6.3, GHC == 7.8.4, GHC == 7.10.3, GHC == 8.0.2
1213description: 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.
1314
1415source-repository head
@@ -17,10 +18,12 @@ source-repository head
1718
1819library
1920 build-depends: base >= 4.6 && < 5,
21+ base-compat >= 0.6.0,
2022 directory,
2123 filepath,
2224 template-haskell,
2325 process
2426 hs-source-dirs: src
27+ ghc-options: -Wall
2528 default-language: Haskell2010
2629 exposed-modules: Development.GitRev
src/Development/GitRev.hs+62−5
@@ -1,3 +1,6 @@
1+{-# LANGUAGE LambdaCase #-}
2+{-# LANGUAGE MultiWayIf #-}
3+
14-- |
25-- Module : $Header$
36-- Copyright : (c) 2015 Adam C. Foltzer
@@ -29,9 +32,16 @@
2932-- > % cabal exec runhaskell Example.hs
3033-- > Example.hs: [panic master@2ae047ba5e4a6f0f3e705a43615363ac006099c1 (Mon Jan 11 11:50:59 2016 -0800) (14 commits in HEAD) (uncommitted files present)] oh no!
3134
32−module Development.GitRev (gitHash, gitBranch, gitDirty, gitCommitCount, gitCommitDate) where
35+module Development.GitRev
36+ ( gitBranch
37+ , gitCommitCount
38+ , gitCommitDate
39+ , gitDescribe
40+ , gitDirty
41+ , gitDirtyTracked
42+ , gitHash
43+ ) where
3344
34−import Control.Applicative
3545import Control.Exception
3646import Control.Monad
3747import Data.Maybe
@@ -42,6 +52,9 @@ import System.Exit
4252import System.FilePath
4353import System.Process
4454
55+import Prelude ()
56+import Prelude.Compat
57+
4558-- | Run git with the given arguments and no stdin, returning the
4659-- stdout output. If git isn't available or something goes wrong,
4760-- return the second argument.
@@ -53,7 +66,7 @@ runGit args def useIdx = do
5366 if gitFound
5467 then do
5568 -- a lot of bookkeeping to record the right dependencies
56− pwd <- runIO getCurrentDirectory
69+ pwd <- runIO getDotGit
5770 let hd = pwd </> ".git" </> "HEAD"
5871 index = pwd </> ".git" </> "index"
5972 packedRefs = pwd </> ".git" </> "packed-refs"
@@ -61,8 +74,7 @@ runGit args def useIdx = do
6174 when hdExists $ do
6275 -- the HEAD file either contains the hash of a detached head
6376 -- or a pointer to the file that contains the hash of the head
64− hdRef <- runIO $ readFile hd
65− case splitAt 5 hdRef of
77+ splitAt 5 `fmap` runIO (readFile hd) >>= \case
6678 -- pointer to ref
6779 ("ref: ", relRef) -> do
6880 let ref = pwd </> ".git" </> relRef
@@ -85,6 +97,36 @@ runGit args def useIdx = do
8597 ExitFailure _ -> return def
8698 else return def
8799
100+-- | Determine where our @.git@ directory is, in case we're in a
101+-- submodule.
102+getDotGit :: IO FilePath
103+getDotGit = do
104+ pwd <- getGitRoot
105+ let dotGit = pwd </> ".git"
106+ oops = return dotGit -- it's gonna fail, that's fine
107+ isDir <- doesDirectoryExist dotGit
108+ isFile <- doesFileExist dotGit
109+ if | isDir -> return dotGit
110+ | not isFile -> oops
111+ | isFile ->
112+ splitAt 8 `fmap` readFile dotGit >>= \case
113+ ("gitdir: ", relDir) -> do
114+ isRelDir <- doesDirectoryExist relDir
115+ if isRelDir
116+ then return relDir
117+ else oops
118+ _ -> oops
119+
120+-- | Get the root directory of the Git repo.
121+getGitRoot :: IO FilePath
122+getGitRoot = do
123+ pwd <- getCurrentDirectory
124+ (code, out, _) <-
125+ readProcessWithExitCode "git" ["rev-parse", "--show-toplevel"] ""
126+ case code of
127+ ExitSuccess -> return $ takeWhile (/= '\n') out
128+ ExitFailure _ -> return pwd -- later steps will fail, that's fine
129+
88130-- | Type to flag if the git index is used or not in a call to runGit
89131data IndexUsed = IdxUsed -- ^ The git index is used
90132 | IdxNotUsed -- ^ The git index is /not/ used
@@ -103,6 +145,12 @@ gitBranch :: ExpQ
103145gitBranch =
104146 stringE =<< runGit ["rev-parse", "--abbrev-ref", "HEAD"] "UNKNOWN" IdxNotUsed
105147
148+-- | Return the long git description for the current git commit, or
149+-- @UNKNOWN@ if not in a git repository.
150+gitDescribe :: ExpQ
151+gitDescribe =
152+ stringE =<< runGit ["describe", "--long", "--always"] "UNKNOWN" IdxNotUsed
153+
106154-- | Return @True@ if there are non-committed files present in the
107155-- repository
108156gitDirty :: ExpQ
@@ -112,6 +160,15 @@ gitDirty = do
112160 "" -> conE falseName
113161 _ -> conE trueName
114162
163+-- | Return @True@ if there are non-commited changes to tracked files
164+-- present in the repository
165+gitDirtyTracked :: ExpQ
166+gitDirtyTracked = do
167+ output <- runGit ["status", "--porcelain","--untracked-files=no"] "" IdxUsed
168+ case output of
169+ "" -> conE falseName
170+ _ -> conE trueName
171+
115172-- | Return the number of commits in the current head
116173gitCommitCount :: ExpQ
117174gitCommitCount =