gitlab-haskell: A Haskell library for the GitLab web API

[ bsd3, git, library ] [ Propose Tags ] [ Report a vulnerability ]

This library lifts the GitLab REST API into Haskell: https://docs.gitlab.com/ee/api/

It also features an event driven reactive API for writing Gitlab file hook applications

Run all GitLab actions with runGitLab:

runGitLab ::
 => GitLabServerConfig -- ^ the GitLab server details
 -> GitLab a           -- ^ the GitLab action
 -> IO a

For example:

myProjects <- runGitLab
     (defaultGitLabServer
         { url = "https://gitlab.example.com"
         , token="my_token"} )
     (searchUser "joe" >>= userProjects . fromJust)

Which uses the functions:

searchUser   :: Text -> GitLab (Maybe User)
userProjects :: User -> GitLab (Maybe [Project])

This is the API to develop event driven rule based GitLab file hooks that fire in real-time on events on a GitLab server:

receive :: [Rule] -> GitLab ()

class (FromJSON a) => SystemHook a where
  match   :: String -> (a -> GitLab ()) -> Rule
  matchIf :: String -> (a -> GitLab Bool) -> (a -> GitLab ()) -> Rule

For more details about the file hooks support: https://www.macs.hw.ac.uk/~rs46/posts/2020-06-06-gitlab-system-hooks.html

Unsurprisingly, this library is maintained on GitLab: https://gitlab.com/robstewart57/gitlab-haskell

[Skip to Readme]

Modules

[Last Documentation]

GitLab
- API
  - GitLab.API.Boards
  - GitLab.API.Branches
  - GitLab.API.Commits
  - GitLab.API.Discussions
  - GitLab.API.Groups
  - GitLab.API.Issues
  - GitLab.API.Jobs
  - GitLab.API.Members
  - GitLab.API.MergeRequests
  - GitLab.API.Notes
  - GitLab.API.Pipelines
  - GitLab.API.Projects
  - GitLab.API.Repositories
  - GitLab.API.RepositoryFiles
  - GitLab.API.Tags
  - GitLab.API.Todos
  - GitLab.API.Users
  - GitLab.API.Version
- SystemHooks
  - GitLab.SystemHooks.GitLabSystemHooks
  - GitLab.SystemHooks.Rules
  - GitLab.SystemHooks.Types
- GitLab.Types

Downloads

gitlab-haskell-1.0.0.0.tar.gz [browse] (Cabal source package)
Package description (as included in the package)

Maintainer's Corner

Package maintainers

RobStewart

For package maintainers and hackage trustees

edit package information

Candidates

No Candidates

Versions [RSS]	0.1.0.0, 0.1.0.1, 0.1.0.2, 0.1.1, 0.1.2, 0.1.3, 0.1.4, 0.1.5, 0.1.6, 0.1.7, 0.1.8, 0.2, 0.2.1, 0.2.2, 0.2.3, 0.2.4, 0.2.5, 0.3.0, 0.3.0.1, 0.3.0.2, 0.3.1, 0.3.1.1, 0.3.2.0, 1.0.0.0, 1.0.0.1, 1.0.0.3, 1.0.0.4, 1.0.0.5, 1.0.1.0, 1.0.2.0, 1.0.2.1, 1.0.2.2, 1.1.0.0
Dependencies	aeson (>=1.4.4.0), base (>=4.7 && <5), bytestring, connection, http-client, http-conduit, http-types, temporary, text, time (>=1.9), transformers, unix [details]
License	BSD-3-Clause
Copyright	2022 Rob Stewart, Heriot-Watt University
Author	Rob Stewart
Maintainer	[email protected]
Category	Git
Home page	https://gitlab.com/robstewart57/gitlab-haskell
Bug tracker	https://gitlab.com/robstewart57/gitlab-haskell/issues
Source repo	head: git clone https://gitlab.com/robstewart57/gitlab-haskell
Uploaded	by RobStewart at 2022-08-22T13:22:44Z
Distributions	LTSHaskell:1.0.2.2, Stackage:1.1.0.0
Downloads	7968 total (2 in the last 30 days)
Rating	2.5 (votes: 3) [estimated by Bayesian average]
Your Rating	λ λ λ
Status	Docs not available [build log] All reported builds failed as of 2022-08-22 [all 2 reports]

Readme for gitlab-haskell-1.0.0.0

[back to package description]

A Haskell library for the GitLab web API

This library lifts the GitLab REST API into Haskell. It supports queries about and updates to:

Branches
Commits
Groups
Issues
Jobs
Members
Merge requests
Pipelines
Projects
Repositories
Repository files
Users
Discussions
Tags
Todos
Version
Notes
Boards

The library parses JSON results into Haskell data types in the GitLab.Types module, allowing you to work with statically typed GitLab data with data types and functions that the library provides. E.g.

searchUser     :: Text -> GitLab (Maybe User)
userProjects   :: User -> GitLab (Maybe [Project])

Example

Run all GitLab actions with runGitLab:

runGitLab ::
   => GitLabServerConfig
   -> GitLab a
   -> IO a

For example the following project finds all GitLab projects for the user "joe".

myProjects <-
  runGitLab
    (defaultGitLabServer
       { url = "https://gitlab.example.com"
       , token="my_token"} )
    (searchUser "joe" >>= userProjects . fromJust)

This library can also be used to implement rule based GitLab file system hooks that, when deployed a GitLab server, react in real time to GitLab events like project creation, new users, merge requests etc.

The rule based API for implementing file hooks is:

receive :: [Rule] -> GitLab ()

class (FromJSON a) => SystemHook a where
  match   :: String -> (a -> GitLab ()) -> Rule
  matchIf :: String -> (a -> GitLab Bool) -> (a -> GitLab ()) -> Rule

For more details about the file system hooks support, see post: GitLab automation with file hook rules.

For the complete gitlab-haskell API, see the hackage documentation.

An example of an application using this library is gitlab-tools, which is a command line tool for bulk GitLab transactions link.