mirror of https://github.com/containrrr/watchtower
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
38 lines
1.7 KiB
Markdown
38 lines
1.7 KiB
Markdown
## Prerequisites
|
|
To contribute code changes to this project you will need the following development kits.
|
|
* [Go](https://golang.org/doc/install)
|
|
* [Docker](https://docs.docker.com/engine/installation/)
|
|
|
|
As watchtower utilizes go modules for vendor locking, you'll need at least Go 1.11.
|
|
You can check your current version of the go language as follows:
|
|
```bash
|
|
~ $ go version
|
|
go version go1.12.1 darwin/amd64
|
|
```
|
|
|
|
|
|
## Checking out the code
|
|
Do not place your code in the go source path.
|
|
```bash
|
|
git clone git@github.com:<yourfork>/watchtower.git
|
|
cd watchtower
|
|
```
|
|
|
|
## Building and testing
|
|
watchtower is a go application and is built with go commands. The following commands assume that you are at the root level of your repo.
|
|
```bash
|
|
go build # compiles and packages an executable binary, watchtower
|
|
go test ./... -v # runs tests with verbose output
|
|
./watchtower # runs the application (outside of a container)
|
|
```
|
|
|
|
If you dont have it enabled, you'll either have to prefix each command with `GO111MODULE=on` or run `export GO111MODULE=on` before running the commands. [You can read more about modules here.](https://github.com/golang/go/wiki/Modules)
|
|
|
|
To build a Watchtower image of your own, use the self-contained Dockerfiles. As the main Dockerfile, they can be found in `dockerfiles/`:
|
|
- `dockerfiles/Dockerfile.dev-self-contained` will build an image based on your current local Watchtower files.
|
|
- `dockerfiles/Dockerfile.self-contained` will build an image based on current Watchtower's repository on GitHub.
|
|
|
|
e.g.:
|
|
```bash
|
|
sudo docker build . -f dockerfiles/Dockerfile.dev-self-contained -t containrrr/watchtower # to build an image from local files
|
|
``` |