/lgtm

A simple pull request approval system

Primary LanguageGoApache License 2.0Apache-2.0

LGTM

Build Status Join the Discord chat at https://discord.gg/NsatcWJ Join the Matrix chat at https://matrix.to/#/#gitea:matrix.org codecov Go Report Card GoDoc GitHub release

LGTM is a simple pull request approval system using GitHub protected branches and maintainers files or maintainers groups. Pull requests are locked and cannot be merged until the minimum number of approvals are received. Project maintainers can indicate their approval by commenting on the pull request and including LGTM (looks good to me) in their approval text.

Install

You can download prebuilt binaries from the GitHub releases or from our download site. You are a Mac user? Just take a look at our homebrew formula. If you have questions that are not covered by the documentation, you can get in contact with us on our Discord server, Matrix room, or forum!. If you find a security issue please contact security@gitea.io first.

Development

Make sure you have a working Go environment, for further reference or a guide take a look at the install instructions. As this project relies on vendoring of the dependencies and we are not exporting GO15VENDOREXPERIMENT=1 within our makefile you have to use a Go version >= 1.6. It is also possible to just simply execute the go get github.com/go-gitea/lgtm command, but we prefer to use our Makefile:

go get -d github.com/go-gitea/lgtm
cd $GOPATH/src/github.com/go-gitea/lgtm
make clean build

bin/lgtm -h

Docker

A Docker Image is available for easy deployment. It can be run locally or on a dedicated Server as follows:

docker run --name lgtm -v /my/host/path:/var/lib/lgtm:z -e GITHUB_CLIENT= -e GITHUB_SECRET= -p 8000:8000 gitea/lgtm

To Fill the Environment Variables GITHUB_CLIENT and GITHUB_SECRET, create new OAuth Application here

To Build the Image by yourself please refere to the Dockerfile and the Drone Configuration.

Contributing

Fork -> Patch -> Push -> Pull Request

Authors

License

This project is under the Apache-2.0 License. See the LICENSE file for the full license text.

Copyright

Copyright (c) 2018 The Gitea Authors <https://gitea.io>