From 301bdaab76c2ce9e1f20b5fec63a759277cb341f Mon Sep 17 00:00:00 2001 From: jackspirou Date: Fri, 29 Jan 2016 19:44:18 -0600 Subject: [PATCH] renaming README.md to DOCS.md --- DOCS.md | 85 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 81 ---------------------------------------------------- 2 files changed, 85 insertions(+), 81 deletions(-) create mode 100644 DOCS.md diff --git a/DOCS.md b/DOCS.md new file mode 100644 index 0000000..7858f68 --- /dev/null +++ b/DOCS.md @@ -0,0 +1,85 @@ +# drone-with-go [![Build Status](http://beta.drone.io/api/badges/drone-demos/drone-with-go/status.svg)](http://beta.drone.io/drone-demos/drone-with-go) [![Build Status](https://aircover.co/badges/drone-demos/drone-with-go/coverage.svg)](https://aircover.co/drone-demos/drone-with-go) + +An example of how to test Go code with Drone. + +# Basic Testing +To run basic CI tests use the following in your `.drone.yml` file. + +```yaml +build: + image: golang:1.5.3 + commands: + - go test ./... +``` + +In this config `image: golang:1.5.3` references the official Golang Docker image hosted at https://hub.docker.com/r/_/golang/ and Go tests are execute with the `go test ./...` command. + +# Advanced Testing + +## Environment Variables +Use environment variables to configure Go testing. +Set environment variables with the `build` section's `environment`. + +```yaml +build: + image: golang:1.5.3 + environment: + - GO15VENDOREXPERIMENT=1 + - GOOS=linux + - GOARCH=amd64 + - CGO_ENABLED=0 + commands: + - go test ./... +``` + +## Coverage +Drone tests work best with the [Coverage plugin](http://readme.drone.io/plugins/coverage/) and the [aircover.co](https://aircover.co/docs/overview/) service. +We only want to send a coverage report when all tests pass, so the Coverage plugin uses `publish`. +Also, we should specify a particular branch so that coverage reports are consistent. + +```yaml +build: + image: golang:1.5.3 + environment: + - GO15VENDOREXPERIMENT=1 + - GOOS=linux + - GOARCH=amd64 + - CGO_ENABLED=0 + commands: + - go test -cover -coverprofile coverage.out + +publish: + coverage: + when: + branch: master +``` + +## Plugins +Notification plugins use `notify` for integrations like HipChat. +`publish` is used for publishing GitHub Releases, Coverage reports, and more. +`deploy` is used for deployments to systems like AWS and Rancher. +You can find a list of plugins at [readme.drone.io/plugins](http://readme.drone.io/plugins/). + +```yaml +build: + image: golang:1.5.3 + environment: + - GO15VENDOREXPERIMENT=1 + - GOOS=linux + - GOARCH=amd64 + - CGO_ENABLED=0 + commands: + - go test -cover -coverprofile coverage.out + +publish: + coverage: + when: + branch: master + +notify: + hipchat: + from: Your_Project + notify: true + room_id_or_name: Your_Room + auth_token: $$HIPCHAT_DRONE_TOKEN +``` diff --git a/README.md b/README.md index b598c0c..38ed11d 100644 --- a/README.md +++ b/README.md @@ -1,84 +1,3 @@ # drone-with-go [![Build Status](http://beta.drone.io/api/badges/drone-demos/drone-with-go/status.svg)](http://beta.drone.io/drone-demos/drone-with-go) [![Build Status](https://aircover.co/badges/drone-demos/drone-with-go/coverage.svg)](https://aircover.co/drone-demos/drone-with-go) An example of how to test Go code with Drone. - -# Basic Testing -To run basic CI tests use the following in your `.drone.yml` file. - -```yaml -build: - image: golang:1.5.3 - commands: - - go test ./... -``` - -In this config `image: golang:1.5.3` references the official Golang Docker image hosted on the Docker Hub registry at https://hub.docker.com/r/_/golang/. -Go tests are execute with the `go test ./...` command. - -# Advanced Testing - -## Environment Variables -Using environment variables to configure Go testing is easy. -Configure environment variables by setting the `build` section's `environment`. - -```yaml -build: - image: golang:1.5.3 - environment: - - GO15VENDOREXPERIMENT=1 - - GOOS=linux - - GOARCH=amd64 - - CGO_ENABLED=0 - commands: - - go test ./... -``` - -## Coverage -Drone tests work best with the coverage plugin and the [aircover.co](https://aircover.co) service. -We only want to send a coverage report when all tests pass, so the coverage plugin uses `publish`. -Also, we should specify a particular branch so that coverage reports are consistent. - -```yaml -build: - image: golang:1.5.3 - environment: - - GO15VENDOREXPERIMENT=1 - - GOOS=linux - - GOARCH=amd64 - - CGO_ENABLED=0 - commands: - - go test -cover -coverprofile coverage.out - -publish: - coverage: - when: - branch: master -``` - -## Plugins -Notification plugins use `notify` for integrations like HipChat. -You can find a list of plugins at [readme.drone.io/plugins](http://readme.drone.io/plugins/). - -```yaml -build: - image: golang:1.5.3 - environment: - - GO15VENDOREXPERIMENT=1 - - GOOS=linux - - GOARCH=amd64 - - CGO_ENABLED=0 - commands: - - go test -cover -coverprofile coverage.out - -publish: - coverage: - when: - branch: master - -notify: - hipchat: - from: Your_Project - notify: true - room_id_or_name: Your_Room - auth_token: $$HIPCHAT_DRONE_TOKEN -```