Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mgedmin/gitlab-jobs
Show a summary of GitLab job durations
https://github.com/mgedmin/gitlab-jobs
Last synced: about 2 months ago
JSON representation
Show a summary of GitLab job durations
- Host: GitHub
- URL: https://github.com/mgedmin/gitlab-jobs
- Owner: mgedmin
- License: gpl-3.0
- Created: 2018-11-14T14:02:43.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-10T12:40:57.000Z (3 months ago)
- Last Synced: 2024-10-13T18:27:04.341Z (2 months ago)
- Language: Python
- Homepage: https://pypi.org/project/gitlab-jobs/
- Size: 93.8 KB
- Stars: 12
- Watchers: 4
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGES.rst
- License: LICENSE
Awesome Lists containing this project
README
Show a summary of GitLab job durations
======================================
.. image:: https://github.com/mgedmin/gitlab-jobs/workflows/build/badge.svg?branch=master
:target: https://github.com/mgedmin/gitlab-jobs/actions
.. image:: https://coveralls.io/repos/mgedmin/gitlab-jobs/badge.svg?branch=master
:target: https://coveralls.io/r/mgedmin/gitlab-jobs
GitLab CI is nice, but I miss build time trends graphs from Jenkins.
So here's a script that can at least compute some summary information::
$ gitlab-jobs --csv jobs.csv
Last 20 successful pipelines of myproject master:
...
Summary:
build_client min 4.2m, max 7.6m, avg 5.8m, median 5.7m, stdev 1.0m
build_docker min 2.7m, max 11.6m, avg 3.5m, median 3.0m, stdev 1.9m
build_server min 6.6m, max 12.2m, avg 8.9m, median 8.1m, stdev 1.9m
test_robot min 25.4m, max 38.3m, avg 30.0m, median 29.1m, stdev 3.6m
unittests_client min 1.1m, max 7.9m, avg 4.1m, median 4.6m, stdev 2.5m
unittests_server min 3.5m, max 6.3m, avg 4.9m, median 5.1m, stdev 0.9m
overall min 37.4m, max 55.8m, avg 45.6m, median 45.6m, stdev 3.8m
Writing jobs.csv...
You can then import the CSV file into a spreadsheet and produce nice charts
like
.. image:: https://github.com/mgedmin/gitlab-jobs/raw/master/chart.png
(NB: this chart has the X axis flipped and the Y axis scaled, because that
makes more sense to me. The CSV data contains durations in seconds,
newest first.)
Installation
------------
``pip3 install --user gitlab-jobs`` should take care of everything, just make
sure ~/.local/bin is on your $PATH.
Or you may want to use a script installer like pipx_ (my favourite).
Configuration
-------------
Create a ``~/.python-gitlab.cfg`` like this::
[global]
default = mygitlab
[mygitlab]
url = https://gitlab.example.com/
private_token = ...
You can create a private access token in your GitLab profile settings. It'll
need the "read_api" access scope.
Usage
-----
You'll need a GitLab project ID. By default gitlab-jobs tries to guess it
from the 'origin' git remote URL, if you're running it inside a git checkout.
Otherwise you'll have to specify it (either as a number like 1234, or as
"group/project", with the slash between them) ::
gitlab-jobs --project GROUP/PROJECT ...
Help is available via ::
$ gitlab-jobs --help
usage: gitlab_jobs.py [-h] [--version] [-v] [-g GITLAB] [-p ID] [-b REF] [--all-branches]
[--all-pipelines] [-l N] [--csv FILENAME] [--debug]
Show GitLab pipeline job durations.
optional arguments:
-h, --help show this help message and exit
--version show program's version number and exit
-v, --verbose print more information
-g GITLAB, --gitlab GITLAB
select configuration section in ~/.python-gitlab.cfg
-p ID, --project ID select GitLab project ("group/project" or the numeric ID)
-b REF, --branch REF, --ref REF
select git branch
--all-branches do not filter by git branch
--all-pipelines include pipelines that were not successful
-l N, --limit N limit analysis to last N pipelines
--csv FILENAME export raw data to CSV file
--debug print even more information, for debugging
.. _python-gitlab: https://pypi.org/p/python-gitlab
.. _pipx: https://pipxproject.github.io/pipx/