https://github.com/vedro-universe/vedro-gitlab-reporter

GitLab reporter with collapsable sections for Vedro framework
https://github.com/vedro-universe/vedro-gitlab-reporter

gitlab vedro vedro-plugin

Last synced: 8 months ago
JSON representation

GitLab reporter with collapsable sections for Vedro framework

• Host: GitHub
• URL: https://github.com/vedro-universe/vedro-gitlab-reporter
• Owner: vedro-universe
• License: apache-2.0
• Created: 2021-06-21T11:44:47.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-02-27T15:59:43.000Z (over 2 years ago)
• Last Synced: 2025-09-21T21:28:02.402Z (9 months ago)
• Topics: gitlab, vedro, vedro-plugin
• Language: Python
• Homepage: https://vedro.io/docs/integrations/gitlab-reporter
• Size: 84 KB
• Stars: 2
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Vedro GitLab Reporter

[![Codecov](https://img.shields.io/codecov/c/github/vedro-universe/vedro-gitlab-reporter/master.svg?style=flat-square)](https://codecov.io/gh/vedro-universe/vedro-gitlab-reporter)

[![PyPI](https://img.shields.io/pypi/v/vedro-gitlab-reporter.svg?style=flat-square)](https://pypi.python.org/pypi/vedro-gitlab-reporter/)

[![PyPI - Downloads](https://img.shields.io/pypi/dm/vedro-gitlab-reporter?style=flat-square)](https://pypi.python.org/pypi/vedro-gitlab-reporter/)

[![Python Version](https://img.shields.io/pypi/pyversions/vedro-gitlab-reporter.svg?style=flat-square)](https://pypi.python.org/pypi/vedro-gitlab-reporter/)

GitLab (>=12.0) reporter with [collapsable sections](https://docs.gitlab.com/ee/ci/jobs/#custom-collapsible-sections) for [Vedro](https://vedro.io/) framework

## Installation

Quick



For a quick installation, you can use a plugin manager as follows:

```shell

$ vedro plugin install vedro-gitlab-reporter

```



Manual



To install manually, follow these steps:

1. Install the package using pip:

```shell

$ pip3 install vedro-gitlab-reporter

```

2. Next, activate the plugin in your `vedro.cfg.py` configuration file:

```python

# ./vedro.cfg.py

import vedro

import vedro_gitlab_reporter

class Config(vedro.Config):

    class Plugins(vedro.Config.Plugins):

        class GitlabReporter(vedro_gitlab_reporter.GitlabReporter):

            enabled = True

```



## Usage

### Run tests

```shell

$ vedro run -r gitlab --gitlab-collapsable steps

```

## Documentation

`--gitlab-collapsable=`

| Mode  | Description                                     |

| ----- | ----------------------------------------------- |

| steps | Show exception and collapsable steps            |

| vars  | Show exception, steps and collapsable variables |

| scope | Show exception, steps and collapsable scope     |