Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sgaunet/gitlab-issue-report

Tool report issues of a gitlab project.
https://github.com/sgaunet/gitlab-issue-report

cli gitlab issues

Last synced: 25 days ago
JSON representation

Tool report issues of a gitlab project.

Awesome Lists containing this project

README

        

[![Go Report Card](https://goreportcard.com/badge/github.com/sgaunet/gitlab-issue-report)](https://goreportcard.com/report/github.com/sgaunet/gitlab-issue-report)
[![GitHub release](https://img.shields.io/github/release/sgaunet/gitlab-issue-report.svg)](https://github.com/sgaunet/gitlab-issue-report/releases/latest)
![GitHub Downloads](https://img.shields.io/github/downloads/sgaunet/gitlab-issue-report/total)
[![Maintainability](https://api.codeclimate.com/v1/badges/b69f230e0040bb521f83/maintainability)](https://codeclimate.com/github/sgaunet/gitlab-issue-report/maintainability)
[![GoDoc](https://godoc.org/github.com/sgaunet/gitlab-issue-report?status.svg)](https://godoc.org/github.com/sgaunet/gitlab-issue-report)
[![License](https://img.shields.io/github/license/sgaunet/gitlab-issue-report.svg)](LICENSE)

# gitlab-issue-report

Tool report issues of a gitlab project.
**The tool is in beta actually, the command line can change, the options too...**

# Install

Copy the binary to /usr/local/bin for example. (or another directory which is in your PATH).

# Usage

```
Usage of gitlab-issue-report:
-closed
only closed issues
-createdAt
issues filtered with created date (updated date by default)
-d string
Debug level (info,warn,debug) (default "error")
-g int
Group ID to get issues from (not compatible with -p option)
-i string
interval, ex /-1/ :: to describe ... (default "/-1/ ::")
-opened
only opened issues
-p int
Project ID to get issues from
-v Get version
```

## Configuration

2 environement variables can be set :

* GITLAB_TOKEN: used to access to private repositories
* GITLAB_URI: to specify another instance of Gitlab (if not set, GITLAB_URI is set to https://gitlab.com)

# Infos

* [Gitlab Issue API](https://docs.gitlab.com/ee/api/issues.html)

# Development

This project is using :

* golang
* [task for development](https://taskfile.dev/#/)
* docker
* [docker buildx](https://github.com/docker/buildx)
* docker manifest
* [goreleaser](https://goreleaser.com/)
* [venom](https://github.com/ovh/venom) : Tests
* [pre-commit](https://pre-commit.com/)

There are hooks executed in the precommit stage. Once the project cloned on your disk, please install pre-commit:

```
brew install pre-commit
```

Install tools:

```
task install-prereq
```

And install the hooks:

```
task install-pre-commit
```

If you like to launch manually the pre-commmit hook:

```
task pre-commit
```