woodpecker/README.md

69 lines
2.6 KiB
Markdown
Raw Normal View History

2015-10-26 17:41:07 +00:00
[![Build Status](http://beta.drone.io/api/badges/drone/drone/status.svg)](http://beta.drone.io/drone/drone)
2015-07-10 00:01:03 +00:00
Drone is a Continuous Integration platform built on container technology. Every build is executed inside an ephemeral Docker container, giving developers complete control over their build environment with guaranteed isolation.
2015-07-10 03:15:29 +00:00
### Goals
Drone's prime directive is to help teams [ship code like GitHub](https://github.com/blog/1241-deploying-at-github#always-be-shipping). Drone is easy to install, setup and maintain and offers a powerful container-based plugin system. Drone aspires to be an industry-wide replacement for Jenkins.
### Documentation
2015-07-10 00:01:03 +00:00
Drone documentation is organized into several categories:
2015-10-26 17:41:07 +00:00
* [Setup Guide](http://readme.drone.io/setup/)
* [Build Guide](http://readme.drone.io/build/)
* [Plugin Guide](http://readme.drone.io/plugin/)
* [CLI Reference](http://readme.drone.io/cli/)
* [API Reference](http://readme.drone.io/api/)
2015-07-10 00:01:03 +00:00
2015-08-04 17:55:27 +00:00
### Community, Help
2015-05-31 20:36:51 +00:00
2015-08-04 17:55:27 +00:00
Contributions, questions, and comments are welcomed and encouraged. Drone developers hang out in the [drone/drone](https://gitter.im/drone/drone) room on gitter. We ask that you please post your questions to [gitter](https://gitter.im/drone/drone) before creating an issue.
2015-08-18 17:28:07 +00:00
2015-08-18 20:57:40 +00:00
### Cloning, Building, Running
2015-08-20 19:42:13 +00:00
If you are new to Go, make sure you [install](http://golang.org/doc/install) Go 1.5+ and [setup](http://golang.org/doc/code.html) your workspace (ie `$GOPATH`). Go programs use directory structure for package imports, therefore, it is very important you clone this project to the specified directory in your Go path:
2015-08-18 20:57:40 +00:00
```
git clone git://github.com/drone/drone.git $GOPATH/src/github.com/drone/drone
cd $GOPATH/src/github.com/drone/drone
```
2015-08-18 17:28:07 +00:00
2015-10-08 14:06:42 +00:00
Pleasure ensure your local environment has the following dependencies installed. We provide scripts in the `./contrib` folder as a convenience that can be used to install:
* libsqlite3
* sassc
2015-08-18 17:28:07 +00:00
Commands to build from source:
```sh
2015-10-08 14:06:42 +00:00
export GO15VENDOREXPERIMENT=1
make deps # Download required dependencies
make gen # Generate code
make build # Build the binary
2015-09-01 14:08:42 +00:00
```
Commands for development:
```sh
make gen_static # Generate static content
make gen_template # Generate templates from amber files
make gen_migrations # Generate embedded database migrations
make vet # Execute go vet command
make fmt # Execute go fmt command
2015-08-18 17:28:07 +00:00
```
Commands to start drone:
```sh
drone
drone --debug # Debug mode enables more verbose logging
2015-08-18 17:28:07 +00:00
```
2015-08-18 17:31:15 +00:00
If you are seeing slow compile times please install the following:
2015-08-18 17:28:07 +00:00
```sh
2015-10-26 17:41:07 +00:00
go install github.com/mattn/go-sqlite3
2015-08-18 17:28:07 +00:00
```