From 7db5c9a274f5ab4a009ee14581cbb8f7b7e59f3e Mon Sep 17 00:00:00 2001 From: Dale Hui Date: Mon, 29 Oct 2018 10:55:22 -0700 Subject: [PATCH] Remove references to `dep` from docs --- CONTRIBUTING.md | 3 ++- README.md | 2 +- cli/README.md | 2 +- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 637c019..8214484 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,8 +2,9 @@ 1. Make sure you have a running Docker daemon (Install for [MacOS](https://docs.docker.com/docker-for-mac/)) + 1. Use a version of Go that supports [modules](https://golang.org/cmd/go/#hdr-Modules__module_versions__and_more) (e.g. Go 1.11+) 1. Fork this repo and `git clone` somewhere to `$GOPATH/src/github.com/golang-migrate/migrate` - 1. Install [dep](https://github.com/golang/dep) and run `dep ensure` to pull dependencies + * Ensure that [Go modules are enabled](https://golang.org/cmd/go/#hdr-Preliminary_module_support) (e.g. your repo path or the `GO111MODULE` environment variable are set correctly) 1. Confirm tests are working: `make test-short` 1. Write awesome code ... 1. `make test` to run all tests against all database versions diff --git a/README.md b/README.md index d7284c1..7e267f8 100644 --- a/README.md +++ b/README.md @@ -97,7 +97,7 @@ $ docker run -v {{ migration dir }}:/migrations --network host migrate/migrate ## Use in your Go project * API is stable and frozen for this release (v3.x). - * Uses [dep](https://github.com/golang/dep) to manage dependencies + * Uses [Go modules](https://golang.org/cmd/go/#hdr-Modules__module_versions__and_more) to manage dependencies * To help prevent database corruptions, it supports graceful stops via `GracefulStop chan bool`. * Bring your own logger. * Uses `io.Reader` streams internally for low memory overhead. diff --git a/cli/README.md b/cli/README.md index cbdfb5f..2b5cd8f 100644 --- a/cli/README.md +++ b/cli/README.md @@ -30,11 +30,11 @@ $ apt-get install -y migrate ``` $ go get -u -d github.com/golang-migrate/migrate/cli $ cd $GOPATH/src/github.com/golang-migrate/migrate/cli -$ dep ensure $ go build -tags 'postgres' -o /usr/local/bin/migrate github.com/golang-migrate/migrate/cli ``` ##### Notes: +1. Requires a version of Go that [supports modules](https://golang.org/cmd/go/#hdr-Preliminary_module_support). e.g. Go 1.11+ 1. This example builds the cli which will only work with postgres. In order to build the cli for use with other databases, replace the `postgres` build tag with the appropriate database tag(s) for the databases desired. The tags