nittymcpick 1.2.0

Install tool to a machine

This machine has to be reachable by the GitLab server via network. In the following we will assume a local installation on the GitLab Server itself (127.0.0.1)

• Install via pypi

  pip3 install nittymcpick

Create a GitLab user

• Go to GitLab with an account that can create users (e.g. root)

  • admin/users/new

    • Name = Nitty McPick

    • Username = nittymcpick

    • Email = foo@localhost (or any other non-exisiting mail address)

    • Access Level = Regular

  • admin/users/nittymcpick/impersonation_tokens

    • Name = e.g. Nitty McPick Bot

    • Scopes = api, read_repository

    • IMPORTANT copy the content of Your New Impersonation Token

Add bot to the project

• Goto Gitlab with an account that can change project settings

  • [username]/[project]/-project_members/

    • search Nitty McPick at **GitLabd member or Email address*

    • click Invite

    • Change level Nitty McPick from Guest to Reporter

Create a GitLab webhook

• Goto Gitlab with an account that can change project settings

  • **[username]/[project]/-/settings/integrations

    • URL: http://127.0.0.1:8888

    • Trigger: Merge requests events

    • SSL verification: uncheck the box

    • Click on Add webhook

Create a configuration for the bot

Create a json file like shown at config.json.sample. The file can contain any number of items

Run the tool

usage: nittymcpick [-h] [--token TOKEN] [--onlynew] [--nowip] [--host HOST]
                   [--port PORT] [--botname BOTNAME]
                   config

Your friendly linting bot for gitlab

positional arguments:
  config             config file

optional arguments:
  -h, --help         show this help message and exit
  --token TOKEN      Access token to use (default:GL_ACCESS_TOKEN from
                     environment)
  --onlynew          Comment only on changes (default:false)
  --nowip            Ignore WIP merge requests (default:false)
  --host HOST        IP to bind to (default:127.0.0.1)
  --port PORT        Port to bind to (default:8888)
  --botname BOTNAME  Username of the bot in GitLab
                     (default:NITTY_MCPICK_USERNAME from env or 'nittymcpick')

e.g. run

export GL_ACCESS_TOKEN=<Impersonation Token from gitlab>
nittymcpick config.json

now everytime a merge request is opened or changed the tool will run all the configured linting tools. On a finding it would comment directly to the MR like this

Nitty McPick @nittymcpick · just now
Reporter

mytool found a potential error - the code is absolutely insecure