Basic operations common between the different Monads defined in this package.

this is a convenient class to allow a common interface for what user may need to optain a Ref from a given Resolvable object.

each of this instances is a convenient implementation of what a user would have to do in order to resolve a branch, a tag or a String.

resolve (Ref "2ad98b90...2ca") === Ref "2ad98b90...2ca"
resolve "master"
resolve "HEAD^^^"

ReadOnly operations on a given commit

open a commit in the current GitMonad

Read commit's info (Author, Committer, message...) or Commit's Tree.

withCurrentRepo $
   withCommit "master" $ do
       -- print the commit's author information
       author <- getAuthor
       liftGit $ print author

       -- print the list of files|dirs in the root directory
       l <- getDir []
       liftGit $ print l

get the content of the file at the given Path

if the given Path is not a file or does not exist, the function returns Nothing.

list the element present in the Given Directory Path

if the given Path is not a directory or does not exist, the function returns Nothing.

create a new commit in the current GitMonad

The commit is pre-filled with the following default values:

• author and committer are the same
• the commit's parents is an empty list
• there is no commit encoding
• the commit's extras is an empty list
• the commit message is an empty ByteString
• the working tree is a new empty Tree or the Tree associated to the given Revision or Ref.

You can update these values with the commit setters (setFile, setAuthor...)

Example:

withCurrentRepo $ do
   (r, ()) <- withNewCommit person (Nothing :: Maybe (Ref SHA1)) $ do
       setMessage "inital commit"
       setFile ["README.md"] "# My awesome project\n\nthis is a new project\n"
   branchWrite "master" r

you can also continue the work on a same branch. In this case the commit's parent is already set to the Reference associated to the revision. You can, change the parents if you wish to erase, or replace, this value.

withCurrentRepo $ do
   readmeContent <- withCommit (Just "master") $ getFile ["README.md"]
   (r, ()) <- withNewCommit person (Just "master") $ do
       setMessage "update the README"
       setFile ["README.md"] $ readmeContent <> "just add some more description\n"
   branchWrite "master" r

create or continue to work on a branch

This is a convenient function to create or to linearily work on a branch. This function applies a first Collect of information on the parent commit (the actual branch's commit). Then it creates a new commit and update the branch to point to this commit.

for example:

withCurrentRepo $
    withBranch person "master" True
        (getAuthor)
        (maybe (setMessage "initial commit on this branch")
               (author -> setMessage $ "continue the great work of " ++ show (personName author))
        )

replace the Commit's Author

replace the Commit's Committer

replace the Commit's Parents

replace the Commit's Extras

replace the Commit's encoding

replace the Commit's message with the new given message.

add a new file in in the Commit's Working Tree

delete a file from the Commit's Working Tree.

represent a git repo, with possibly already opened filereaders for indexes and packs

represent a git reference (SHA1)

Represent a commit object.

an author or committer line has the format: name email time timezone FIXME: should be a string, but I don't know if the data is stored consistantly in one encoding (UTF8)