lookout

A service for assisted code review, that allows running custom code Analyzers on pull requests.

Installation

go get github.com/src-d/lookout

Dependencies

The included ./docker-compose.yml allows to start all dependencies using Docker Compose

• bblfshd, on localhost:9432
• PostgreSQL, on localhost:5432 password example

Clone the repository, or download ./docker-compose.yml, and run:

docker-compose up

Example

SDK

If you are developing an Analyzer, please check SDK documentation.

It includes a curl-style binary that allows to trigger Analyzers directly, without launching a full lookout server.

Server

To trigger the analysis on an actual pull request of a GitHub repository do:

1. Start an analyzer Any of the analyzers or a default dummy one, included in this repository

   go build -o analyzer ./cmd/dummy
   ./analyzer serve
   

2. Start a lookout server
   1. With posting analysis results on GitHub
      • Obtain GitHub access token
      • Run lookout serve --github-token <token> --github-user <user> <repository>
   2. Without posting analysis results (only printing)
      • lookout serve --dry-run <repository>
3. Create a new pull requires in the repository

Contribute

Contributions are more than welcome, if you are interested please take a look to our Contributing Guidelines.

Code of Conduct

All activities under source{d} projects are governed by the source{d} code of conduct.

License

Affero GPL v3.0, see LICENSE.

SDK package in ./sdk is released under the terms of the Apache License v2.0