Skip to content

This is a Gitlab API wrapper that helps to automate common actions on CI jobs (eg: Open a merge request, Open or close an issue etc)

License

Notifications You must be signed in to change notification settings

sparkfabrik/gitlab-ci-client

Repository files navigation

Gitlab CI client

build and test

This is a Gitlab API wrapper that helps to automate common actions on CI jobs (eg: Open a merge request, Open or close an issue etc)

Basic Usage

docker run \
  -e GITLAB_PRIVATE_TOKEN=<YOUR-ACCESS_TOKEN> \
  -e CI_SERVER_URL=<YOUR-GITLAB-CI_SERVER_URL> \
  sparkfabrik/gitlab-ci-client mergeRequests.all "[null,{\"state\":\"opened\"}]"

The above command will return all opened merge requests.

You can also pass -v, -vv or -vvv to increase output verbosity.

Command format

gitlab-ci-client <RESOURCE>.<METHOD>(required arg: string) "[arg1,arg2,...,argN]" (optional arg: array of arguments as json string)

How it works

The first argument defines which API resource you want to use and which action you want to perform.

Here's a list of all available resources:

  • deployKeys
  • deployments
  • environments
  • groups
  • groupsBoards
  • groupsEpics
  • groupsMilestones
  • issueBoards
  • issueLinks
  • issues
  • issuesStatistics
  • jobs
  • keys
  • mergeRequests
  • milestones
  • namespaces
  • projects
  • repositories
  • repositoryFiles
  • schedules
  • snippets
  • systemHooks
  • tags
  • users
  • version
  • wiki

The second argument is a json string that represents an array or arguments. This array is passed to the API as a query string.

Each resource has its own set of actions and common actions among all resources could have different set of arguments. This work is based on https://github.com/GitLabPHP/Client project and to know all available actions for each resource please refer to available methods in the classes defined here: https://github.com/GitLabPHP/Client/tree/11.8/src/Api

For full list of available resources and methods, please refer to the official documentation.

Gitlab CI pipeline

It is possible to use this client to automate steps in a CI pipeline. The only required action is to create an Access Token for your project and set a CI/CD Variable with the name GITLAB_PRIVATE_TOKEN. The scope required is "api". This will grant access to your repository and all its resources.

Once done you can run as any other script in your gitlab-ci step.

Examples in gitlab-ci pipeline

example-gitlab-ci-job:
  stage: build
  image: ghcr.io/sparkfabrik/gitlab-ci-client
  script:
    - |
        mergeRequests.create "[$CI_PROJECT_ID,\"autobranch/$CI_PIPELINE_ID\",\"develop\",\"AUTO: New merge request from pipeline $CI_PIPELINE_ID\"]"

The above example will create a new merge request on the current project from branch "autobranch/$CI_PIPELINE_ID" (which is supposed to be created by this job before this execution) to branch "develop" and will title it "AUTO: New merge request from pipeline $CI_PIPELINE_ID".

Another example for fetching all opened merge requests:

example-gitlab-ci-job:
  stage: build
  image: ghcr.io/sparkfabrik/gitlab-ci-client
  script:
    - |
    mergeRequests.all '[null,{"state":"opened","iids":[123,456]}]'

The above example will return only opened merge requests for the current project among a subset of given merge request ids (iids).

Note that if you want to pass env variables you have to use double-quotes and, thus, you have to escape the double-quotes of the json string.

Of course these are just simple examples. There are plenty of actions you can automate with this tool. The sky is the limit.

About

This is a Gitlab API wrapper that helps to automate common actions on CI jobs (eg: Open a merge request, Open or close an issue etc)

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors 4

  •  
  •  
  •  
  •