changelogged-0.2.0: Changelog manager for Git projects.

Safe HaskellNone
LanguageHaskell2010

Changelogged.Git

Synopsis

Documentation

data GitInfo Source #

Information about the state of a git repository.

Constructors

GitInfo 

Fields

Instances

loadGitLatestTag :: Maybe Text -> IO (Maybe Text) Source #

Get latest git tag in a given branch (if present). If no branch is specified then HEAD^ is used.

loadGitRemoteUrl :: IO Text Source #

Get link to origin and strip '.git' to get valid url to project page.

remoteUrlToHttps :: Text -> Text Source #

Change git remote URL so that it can be used in the browser.

>>> remoteUrlToHttps "git@github.com:GetShopTV/changelogged.git"
"https://github.com/GetShopTV/changelogged"
>>> remoteUrlToHttps "https://github.com/GetShopTV/changelogged.git"
"https://github.com/GetShopTV/changelogged"

loadGitHistory Source #

Arguments

:: Maybe Text

A commit/tag to mark the start of history.

-> IO [Line] 

Load git history from a given commit or from the start of the project.

loadGitInfo Source #

Arguments

:: Bool

Include the whole project history?

-> Maybe Text

Branch with version tags (HEAD is used by default).

-> IO GitInfo 

Extract latest history and origin link from git through temporary file and store it in GitInfo.

ppGitInfo :: GitInfo -> Text Source #

Pretty print known information about a Git project.