c5496f3...master · typeable/gitrev

git.iko.soy/typeable/gitrev

on master help sign in

.travis.yml+68−70

since splitsnapshots

unifiedsplit

@@ -1,86 +1,84 @@

1−# NB: don't set `language: haskell` here

1+# This file has been generated -- see https://github.com/hvr/multi-ghc-travis

2language: c

3+sudo: false

5+cache:

6+ directories:

7+ - $HOME/.cabsnap

8+ - $HOME/.cabal/packages

10+before_cache:

11+ - rm -fv $HOME/.cabal/packages/hackage.haskell.org/build-reports.log

12+ - rm -fv $HOME/.cabal/packages/hackage.haskell.org/00-index.tar

13+

14+matrix:

15+ include:

16+ - env: CABALVER=1.16 GHCVER=7.6.3

17+ compiler: ": #GHC 7.6.3"

18+ addons: {apt: {packages: [cabal-install-1.16,ghc-7.6.3], sources: [hvr-ghc]}}

19+ - env: CABALVER=1.18 GHCVER=7.8.4

20+ compiler: ": #GHC 7.8.4"

21+ addons: {apt: {packages: [cabal-install-1.18,ghc-7.8.4], sources: [hvr-ghc]}}

22+ - env: CABALVER=1.22 GHCVER=7.10.3

23+ compiler: ": #GHC 7.10.3"

24+ addons: {apt: {packages: [cabal-install-1.22,ghc-7.10.3], sources: [hvr-ghc]}}

25+ - env: CABALVER=1.24 GHCVER=8.0.2

26+ compiler: ": #GHC 8.0.2"

27+ addons: {apt: {packages: [cabal-install-1.24,ghc-8.0.2], sources: [hvr-ghc]}}

4−# See also https://github.com/hvr/multi-ghc-travis for more information

5−

6−# The following lines enable several GHC versions and/or HP versions

7−# to be tested; often it's enough to test only against the last

8−# release of a major GHC version. Setting HPVER implictly sets

9−# GHCVER. Omit lines with versions you don't need/want testing for.

10−env:

11− - CABALVER=1.18 GHCVER=7.6.3

12− - CABALVER=1.18 GHCVER=7.8.4

13− - CABALVER=1.22 GHCVER=7.10.3

14− - CABALVER=head GHCVER=head

15−

16−# Note: the distinction between `before_install` and `install` is not

17−# important.

18before_install:

29before_install:

19− - case "$HPVER" in

30+ - unset CC

20− "") ;;

21−

22− "2014.2.0.0")

23− export CABALVER=1.18 ;

24− export GHCVER=7.8.3 ;

25− echo "constraints:async==2.0.1.5,attoparsec==0.10.4.0,case-insensitive==1.1.0.3,fgl==5.5.0.1,GLUT==2.5.1.1,GLURaw==1.4.0.1,haskell-src==1.0.1.6,hashable==1.2.2.0,html==1.0.1.2,HTTP==4000.2.10,HUnit==1.2.5.2,mtl==2.1.3.1,network==2.4.2.3,OpenGL==2.9.2.0,OpenGLRaw==1.5.0.0,parallel==3.2.0.4,parsec==3.1.5,primitive==0.5.2.1,QuickCheck==2.6,random==1.0.1.1,regex-base==0.93.2,regex-compat==0.95.1,regex-posix==0.95.2,split==0.2.2,stm==2.4.2,syb==0.4.1,text==1.1.0.0,transformers==0.3.0.0,unordered-containers==0.2.4.0,vector==0.10.9.1,xhtml==3000.2.1,zlib==0.5.4.1" > cabal.config ;;

26−

27− "2013.2.0.0")

28− export CABALVER=1.16 ;

29− export GHCVER=7.6.3 ;

30− echo "constraints:async==2.0.1.4,attoparsec==0.10.4.0,case-insensitive==1.0.0.1,cgi==3001.1.7.5,fgl==5.4.2.4,GLUT==2.4.0.0,GLURaw==1.3.0.0,haskell-src==1.0.1.5,hashable==1.1.2.5,html==1.0.1.2,HTTP==4000.2.8,HUnit==1.2.5.2,mtl==2.1.2,network==2.4.1.2,OpenGL==2.8.0.0,OpenGLRaw==1.3.0.0,parallel==3.2.0.3,parsec==3.1.3,QuickCheck==2.6,random==1.0.1.1,regex-base==0.93.2,regex-compat==0.95.1,regex-posix==0.95.2,split==0.2.2,stm==2.4.2,syb==0.4.0,text==0.11.3.1,transformers==0.3.0.0,unordered-containers==0.2.3.0,vector==0.10.0.1,xhtml==3000.2.1,zlib==0.5.4.1" > cabal.config ;;

31−

32− "2012.4.0.0")

33− export CABALVER=1.16 ;

34− export GHCVER=7.6.2 ;

35− echo "constraints:async==2.0.1.3,cgi==3001.1.7.4,fgl==5.4.2.4,GLUT==2.1.2.1,haskell-src==1.0.1.5,html==1.0.1.2,HTTP==4000.2.5,HUnit==1.2.5.1,mtl==2.1.2,network==2.3.1.0,OpenGL==2.2.3.1,parallel==3.2.0.3,parsec==3.1.3,QuickCheck==2.5.1.1,random==1.0.1.1,regex-base==0.93.2,regex-compat==0.95.1,regex-posix==0.95.2,split==0.2.1.1,stm==2.4,syb==0.3.7,text==0.11.2.3,transformers==0.3.0.0,vector==0.10.0.1,xhtml==3000.2.1,zlib==0.5.4.0" > cabal.config ;;

36−

37− "2012.2.0.0")

38− export CABALVER=1.16 ;

39− export GHCVER=7.4.1 ;

40− echo "constraints:cgi==3001.1.7.4,fgl==5.4.2.4,GLUT==2.1.2.1,haskell-src==1.0.1.5,html==1.0.1.2,HTTP==4000.2.3,HUnit==1.2.4.2,mtl==2.1.1,network==2.3.0.13,OpenGL==2.2.3.1,parallel==3.2.0.2,parsec==3.1.2,QuickCheck==2.4.2,random==1.0.1.1,regex-base==0.93.2,regex-compat==0.95.1,regex-posix==0.95.1,stm==2.3,syb==0.3.6.1,text==0.11.2.0,transformers==0.3.0.0,xhtml==3000.2.1,zlib==0.5.3.3" > cabal.config ;;

41−

42− "2011.4.0.0")

43− export CABALVER=1.16 ;

44− export GHCVER=7.0.4 ;

45− echo "constraints:cgi==3001.1.7.4,fgl==5.4.2.4,GLUT==2.1.2.1,haskell-src==1.0.1.4,html==1.0.1.2,HUnit==1.2.4.2,network==2.3.0.5,OpenGL==2.2.3.0,parallel==3.1.0.1,parsec==3.1.1,QuickCheck==2.4.1.1,regex-base==0.93.2,regex-compat==0.95.1,regex-posix==0.95.1,stm==2.2.0.1,syb==0.3.3,xhtml==3000.2.0.4,zlib==0.5.3.1,HTTP==4000.1.2,deepseq==1.1.0.2" > cabal.config ;;

46−

47− *)

48− export GHCVER=unknown ;

49− echo "unknown/invalid Haskell Platform requested" ;

50− exit 1 ;;

51−

52− esac

53−

54− - travis_retry sudo add-apt-repository -y ppa:hvr/ghc

55− - travis_retry sudo apt-get update

56− - travis_retry sudo apt-get install cabal-install-$CABALVER ghc-$GHCVER

57 - export PATH=/opt/ghc/$GHCVER/bin:/opt/cabal/$CABALVER/bin:$PATH

31 - export PATH=/opt/ghc/$GHCVER/bin:/opt/cabal/$CABALVER/bin:$PATH

59install:

33install:

60 - cabal --version

34 - cabal --version

61 - echo "$(ghc --version) [$(ghc --print-project-git-commit-id 2> /dev/null || echo '?')]"

35 - echo "$(ghc --version) [$(ghc --print-project-git-commit-id 2> /dev/null || echo '?')]"

36+ - if [ -f $HOME/.cabal/packages/hackage.haskell.org/00-index.tar.gz ];

37+ then

38+ zcat $HOME/.cabal/packages/hackage.haskell.org/00-index.tar.gz >

39+ $HOME/.cabal/packages/hackage.haskell.org/00-index.tar;

40+ fi

62− - travis_retry cabal update

41+ - travis_retry cabal update -v

42+ - sed -i 's/^jobs:/-- jobs:/' ${HOME}/.cabal/config

63− - cabal install --only-dependencies --enable-tests --enable-benchmarks

43+ - cabal install --only-dependencies --enable-tests --enable-benchmarks --dry -v > installplan.txt

64−

44+ - sed -i -e '1,/^Resolving /d' installplan.txt; cat installplan.txt

45+

46+# check whether current requested install-plan matches cached package-db snapshot

47+ - if diff -u $HOME/.cabsnap/installplan.txt installplan.txt;

48+ then

49+ echo "cabal build-cache HIT";

50+ rm -rfv .ghc;

51+ cp -a $HOME/.cabsnap/ghc $HOME/.ghc;

52+ cp -a $HOME/.cabsnap/lib $HOME/.cabsnap/share $HOME/.cabsnap/bin $HOME/.cabal/;

53+ else

54+ echo "cabal build-cache MISS";

55+ rm -rf $HOME/.cabsnap;

56+ mkdir -p $HOME/.ghc $HOME/.cabal/lib $HOME/.cabal/share $HOME/.cabal/bin;

57+ cabal install --only-dependencies --enable-tests --enable-benchmarks;

58+ fi

59+

60+# snapshot package-db on cache miss

61+ - if [ ! -d $HOME/.cabsnap ];

62+ then

63+ echo "snapshotting package-db to build-cache";

64+ mkdir $HOME/.cabsnap;

65+ cp -a $HOME/.ghc $HOME/.cabsnap/ghc;

66+ cp -a $HOME/.cabal/lib $HOME/.cabal/share $HOME/.cabal/bin installplan.txt $HOME/.cabsnap/;

67+ fi

68+

65−# Here starts the actual work to be performed for the package under

69+# Here starts the actual work to be performed for the package under test;

66−# test; any command which exits with a non-zero exit code causes the

70+# any command which exits with a non-zero exit code causes the build to fail.

67−# build to fail.

68script:

71script:

69 - if [ -f configure.ac ]; then autoreconf -i; fi

72 - if [ -f configure.ac ]; then autoreconf -i; fi

70− # -v2 provides useful information for debugging

73+ - cabal configure --enable-tests --enable-benchmarks -v2 # -v2 provides useful information for debugging

71− - cabal configure --enable-tests --enable-benchmarks -v2

72−

73− # this builds all libraries and executables

74+ - cabal build # this builds all libraries and executables (including tests/benchmarks)

74− # (including tests/benchmarks)

75− - cabal build

76−

77 - cabal test

75 - cabal test

78 - cabal check

76 - cabal check

77+ - cabal sdist # tests that a source-distribution can be generated

80− # tests that a source-distribution can be generated

81− - cabal sdist

82−

83− # check that the generated source-distribution can be built & installed

79+# Check that the resulting source distribution can be built & installed.

80+# If there are no other `.tar.gz` files in `dist`, this can be even simpler:

81+# `cabal install --force-reinstalls dist/*-*.tar.gz`

84 - SRC_TGZ=$(cabal info . | awk '{print $2;exit}').tar.gz &&

82 - SRC_TGZ=$(cabal info . | awk '{print $2;exit}').tar.gz &&

85 (cd dist && cabal install --force-reinstalls "$SRC_TGZ")

83 (cd dist && cabal install --force-reinstalls "$SRC_TGZ")

README.md+9−5

@@ -11,9 +11,13 @@ places the current git hash might be stored:

111. Detached HEAD: the hash is in `.git/HEAD`

122. On a branch or tag: the hash is in a file pointed to by `.git/HEAD`

13in a location like `.git/refs/heads`

14−3. On a branch or tag but in a repository with packed refs: the hash is

14+3. On a branch or tag but in a repository with packed refs: the hash

15−in `.git/packed-refs`

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

17−These situations all arise under normal development workflows, but

19+These files are added as dependencies to modules that use `GitRev`, and

20+so the module should be rebuilt automatically whenever these files

21+change.

22+

18−there might be further scenarios that cause problems. Let me know if

23+If you run into further scenarios that cause problems, let me know!

19−you run into them!

gitrev.cabal+4−1

@@ -1,5 +1,5 @@

1name: gitrev

2−version: 1.2.0

2+version: 1.3.1

3synopsis: Compile git revision info into Haskell projects

4homepage: https://github.com/acfoltzer/gitrev

5license: BSD3

@@ -9,6 +9,7 @@ maintainer: acfoltzer@galois.com

9category: Development

10build-type: Simple

11cabal-version: >=1.10

12+tested-with: GHC == 7.6.3, GHC == 7.8.4, GHC == 7.10.3, GHC == 8.0.2

12description: 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.

13description: 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.

14source-repository head

15source-repository head

@@ -17,10 +18,12 @@ source-repository head

18library

19library

19 build-depends: base >= 4.6 && < 5,

20 build-depends: base >= 4.6 && < 5,

21+ base-compat >= 0.6.0,

20 directory,

22 directory,

21 filepath,

23 filepath,

22 template-haskell,

24 template-haskell,

23 process

25 process

24 hs-source-dirs: src

26 hs-source-dirs: src

27+ ghc-options: -Wall

25 default-language: Haskell2010

28 default-language: Haskell2010

26 exposed-modules: Development.GitRev

29 exposed-modules: Development.GitRev

src/Development/GitRev.hs+62−5

@@ -1,3 +1,6 @@

1+{-# LANGUAGE LambdaCase #-}

2+{-# LANGUAGE MultiWayIf #-}

1-- |

4-- |

2-- Module : $Header$

5-- Module : $Header$

@@ -29,9 +32,16 @@

29-- > % cabal exec runhaskell Example.hs

32-- > % cabal exec runhaskell Example.hs

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

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

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

34−import Control.Applicative

35import Control.Exception

45import Control.Exception

36import Control.Monad

46import Control.Monad

37import Data.Maybe

47import Data.Maybe

@@ -42,6 +52,9 @@ import System.Exit

42import System.FilePath

52import System.FilePath

43import System.Process

53import System.Process

55+import Prelude ()

56+import Prelude.Compat

57+

45-- | Run git with the given arguments and no stdin, returning the

58-- | Run git with the given arguments and no stdin, returning the

46-- stdout output. If git isn't available or something goes wrong,

59-- stdout output. If git isn't available or something goes wrong,

47-- return the second argument.

60-- return the second argument.

@@ -53,7 +66,7 @@ runGit args def useIdx = do

53 if gitFound

66 if gitFound

54 then do

67 then do

55 -- a lot of bookkeeping to record the right dependencies

68 -- a lot of bookkeeping to record the right dependencies

56− pwd <- runIO getCurrentDirectory

69+ pwd <- runIO getDotGit

57 let hd = pwd </> ".git" </> "HEAD"

70 let hd = pwd </> ".git" </> "HEAD"

58 index = pwd </> ".git" </> "index"

71 index = pwd </> ".git" </> "index"

59 packedRefs = pwd </> ".git" </> "packed-refs"

72 packedRefs = pwd </> ".git" </> "packed-refs"

@@ -61,8 +74,7 @@ runGit args def useIdx = do

61 when hdExists $ do

74 when hdExists $ do

62 -- the HEAD file either contains the hash of a detached head

75 -- the HEAD file either contains the hash of a detached head

63 -- or a pointer to the file that contains the hash of the head

76 -- or a pointer to the file that contains the hash of the head

64− hdRef <- runIO $ readFile hd

77+ splitAt 5 `fmap` runIO (readFile hd) >>= \case

65− case splitAt 5 hdRef of

66 -- pointer to ref

78 -- pointer to ref

67 ("ref: ", relRef) -> do

79 ("ref: ", relRef) -> do

68 let ref = pwd </> ".git" </> relRef

80 let ref = pwd </> ".git" </> relRef

@@ -85,6 +97,36 @@ runGit args def useIdx = do

85 ExitFailure _ -> return def

97 ExitFailure _ -> return def

86 else return def

98 else return def

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+

88-- | Type to flag if the git index is used or not in a call to runGit

130-- | Type to flag if the git index is used or not in a call to runGit

89data IndexUsed = IdxUsed -- ^ The git index is used

131data IndexUsed = IdxUsed -- ^ The git index is used

90 | IdxNotUsed -- ^ The git index is /not/ used

132 | IdxNotUsed -- ^ The git index is /not/ used

@@ -103,6 +145,12 @@ gitBranch :: ExpQ

103gitBranch =

145gitBranch =

104 stringE =<< runGit ["rev-parse", "--abbrev-ref", "HEAD"] "UNKNOWN" IdxNotUsed

146 stringE =<< runGit ["rev-parse", "--abbrev-ref", "HEAD"] "UNKNOWN" IdxNotUsed

105

147

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+

106-- | Return @True@ if there are non-committed files present in the

154-- | Return @True@ if there are non-committed files present in the

107-- repository

155-- repository

108gitDirty :: ExpQ

156gitDirty :: ExpQ

@@ -112,6 +160,15 @@ gitDirty = do

112 "" -> conE falseName

160 "" -> conE falseName

113 _ -> conE trueName

161 _ -> conE trueName

114

162

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+

115-- | Return the number of commits in the current head

172-- | Return the number of commits in the current head

116gitCommitCount :: ExpQ

173gitCommitCount :: ExpQ

117gitCommitCount =

174gitCommitCount =