Copyright	(c) Rob Stewart Heriot-Watt University 2019
License	BSD3
Maintainer	robstewart57@gmail.com
Stability	stable
Safe Haskell	None
Language	Haskell2010

GitLab.API.Commits

Contents

List repository commits
Create a commit with multiple files and actions
Get a single commit
Get references a commit is pushed to
Cherry-pick a commit
Revert a commit
Get the diff of a commit
Get the comments of a commit
Post comment to commit
Get the discussions of a commit
List merge requests associated with a commit
Commits on specific branch
Types

Description

Synopsis

repoCommits :: Project -> GitLab [Commit]
createCommitMultipleFilesActions :: Project -> Text -> Text -> [CommitAction] -> GitLab (Maybe Commit)
singleCommit :: Project -> Text -> GitLab (Maybe Commit)
cheryPickCommit :: Project -> Text -> Text -> GitLab (Maybe Commit)
revertCommit :: Project -> Text -> Text -> GitLab (Maybe Commit)
commitDiff :: Project -> Text -> GitLab (Either (Response ByteString) [Diff])
commitComments :: Project -> Text -> GitLab (Either (Response ByteString) [CommitNote])
postCommitComment :: Project -> Text -> Text -> GitLab (Either (Response ByteString) (Maybe CommitNote))
commitDiscussions :: Project -> Text -> GitLab (Either (Response ByteString) [Discussion])
commitMergeRequests :: Project -> Text -> GitLab (Either (Response ByteString) [MergeRequest])
branchCommits :: Project -> Text -> GitLab (Either (Response ByteString) [Commit])
data CommitAction = CommitAction {
}
data ContentEncoding
- = EncodingText
- | EncodingBase64
data Action
- = ActionCreate
- | ActionDelete
- | ActionMove
- | ActionUpdate
- | ActionChmod

List repository commits

repoCommits Source #

Arguments

:: Project	the project
-> GitLab [Commit]

Get a list of repository commits in a project.

Create a commit with multiple files and actions

createCommitMultipleFilesActions Source #

Arguments

:: Project	the project
-> Text	Name of the branch to commit into.
-> Text	Commit message
-> [CommitAction]
-> GitLab (Maybe Commit)

Get a list of repository commits in a project.

Get a single commit

singleCommit Source #

Arguments

:: Project	the project
-> Text	the commit hash
-> GitLab (Maybe Commit)

Get a specific commit identified by the commit hash or name of a branch or tag.

Get references a commit is pushed to

Cherry-pick a commit

cheryPickCommit Source #

Arguments

:: Project	the project
-> Text	the commit hash
-> Text	The name of the branch
-> GitLab (Maybe Commit)

Cherry-picks a commit to a given branch.

Revert a commit

revertCommit Source #

Arguments

:: Project	the project
-> Text	the commit hash
-> Text	target branch name
-> GitLab (Maybe Commit)

Reverts a commit in a given branch.

Get the diff of a commit

commitDiff Source #

Arguments

:: Project	project
-> Text	The commit hash or name of a repository branch or tag
-> GitLab (Either (Response ByteString) [Diff])

Get the diff of a commit in a project.

Get the comments of a commit

commitComments Source #

Arguments

:: Project	project
-> Text	The commit hash or name of a repository branch or tag
-> GitLab (Either (Response ByteString) [CommitNote])

Get the diff of a commit in a project.

Post comment to commit

postCommitComment Source #

Arguments

:: Project	project
-> Text	The commit hash or name of a repository branch or tag
-> Text	The text of the comment
-> GitLab (Either (Response ByteString) (Maybe CommitNote))

Adds a comment to a commit.

Get the discussions of a commit

commitDiscussions Source #

Arguments

:: Project	project
-> Text	The commit hash or name of a repository branch or tag
-> GitLab (Either (Response ByteString) [Discussion])

Get the discussions of a commit in a project.

List merge requests associated with a commit

commitMergeRequests Source #

Arguments

:: Project	project
-> Text	The commit SHA
-> GitLab (Either (Response ByteString) [MergeRequest])

Get the discussions of a commit in a project.

Commits on specific branch

branchCommits Source #

Arguments

:: Project	project
-> Text	branch name
-> GitLab (Either (Response ByteString) [Commit])

returns all commits of a branch from a project given its project ID and the branch name.

Types

data CommitAction Source #

A commit action.

Constructors

CommitAction

Fields

commit_action_action :: Action
commit_action_file_path :: FilePath
Full path to the file.
commit_action_previous_path :: Maybe Text
Original full path to the file being moved. Ex. lib/class1.rb. Only considered for move action.
commit_action_content :: Maybe Text
File content, required for all except delete, chmod, and move. Move actions that do not specify content preserve the existing file content, and any other value of content overwrites the file content.
commit_action_encoding :: Maybe ContentEncoding
text or base64. text is default.
commit_action_last_commit_id :: Maybe Text
Last known file commit ID. Only considered in update, move, and delete actions.
commit_action_execute_filemode :: Maybe Bool
When truefalse enablesdisables the execute flag on the file. Only considered for chmod action.

Instances

Instances details

Eq CommitAction Source #
Instance details Defined in GitLab.API.Commits Methods (==) :: CommitAction -> CommitAction -> Bool # (/=) :: CommitAction -> CommitAction -> Bool #
Show CommitAction Source #
Instance details Defined in GitLab.API.Commits Methods showsPrec :: Int -> CommitAction -> ShowS # show :: CommitAction -> String # showList :: [CommitAction] -> ShowS #

data ContentEncoding Source #

Whether the content is text or base 64.

Constructors

EncodingText
EncodingBase64

Instances

Instances details

Eq ContentEncoding Source #
Instance details Defined in GitLab.API.Commits Methods (==) :: ContentEncoding -> ContentEncoding -> Bool # (/=) :: ContentEncoding -> ContentEncoding -> Bool #
Show ContentEncoding Source #
Instance details Defined in GitLab.API.Commits Methods showsPrec :: Int -> ContentEncoding -> ShowS # show :: ContentEncoding -> String # showList :: [ContentEncoding] -> ShowS #

data Action Source #

The actual action within a commit action.

Constructors

ActionCreate
ActionDelete
ActionMove
ActionUpdate
ActionChmod

Instances

Instances details

Eq Action Source #
Instance details Defined in GitLab.API.Commits Methods (==) :: Action -> Action -> Bool # (/=) :: Action -> Action -> Bool #
Show Action Source #
Instance details Defined in GitLab.API.Commits Methods showsPrec :: Int -> Action -> ShowS # show :: Action -> String # showList :: [Action] -> ShowS #