Skip to content
This repository has been archived by the owner on May 23, 2024. It is now read-only.

Remove go modules #425

Merged
merged 1 commit into from
Sep 6, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 3 additions & 6 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,16 @@ matrix:
- go: 1.12.x
env:
- TESTS=true
- USE_DEP=true
- COVERAGE=true
- GO111MODULE=on
- go: 1.12.x
env:
- CROSSDOCK=true
- GO111MODULE=on
- go: 1.12.x
env:
- TESTS=true
- USE_DEP=true
- CROSSDOCK=true
- go: 1.12.x
env:
- TESTS=true
- USE_DEP=false
- USE_GLIDE=true
- go: 1.11.x
env:
Expand Down
11 changes: 7 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,20 +19,23 @@ file for details.

## Getting Started

This library uses Go modules to manage dependencies.
This library uses [dep](https://golang.github.io/dep/) to manage dependencies.

To get started, clone the Git repository into any location (does not need to be under `$GOPATH`):
To get started, make sure you clone the Git repository into the correct location
`github.com/uber/jaeger-client-go` relative to `$GOPATH`:

```
cd you-dev-root
mkdir -p $GOPATH/src/github.com/uber
cd $GOPATH/src/github.com/uber
git clone git@github.com:jaegertracing/jaeger-client-go.git jaeger-client-go
cd jaeger-client-go
git submodule update --init --recursive
```

Go will download dependencies automatically when you run the tests:
Then install dependencies and run the tests:

```
make install
make test
```

Expand Down
2 changes: 2 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ ALL_SRC := $(shell find . -name "*.go" | grep -v -e vendor -e thrift-gen -e ./th
-e ".*/_.*" \
-e ".*/mocks.*")

USE_DEP := true

-include crossdock/rules.mk

RACE=-race
Expand Down
25 changes: 19 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,27 @@ Please see [CONTRIBUTING.md](CONTRIBUTING.md).

## Installation

We recommended using [semantic versioning](http://semver.org/) when including this library into an application. For example, Jaeger backend imports this library like this (if using Dep):

```yaml
- package: github.com/uber/jaeger-client-go
version: ^2.7.0
We recommended using a dependency manager like [dep](https://golang.github.io/dep/)
and [semantic versioning](http://semver.org/) when including this library into an application.
For example, Jaeger backend imports this library like this:

```toml
[[constraint]]
name = "github.com/uber/jaeger-client-go"
version = "2.17"
```

If you instead want to use the latest version in `master`, you can pull it via `go get github.com/uber/jaeger-client-go`.
If you instead want to use the latest version in `master`, you can pull it via `go get`.
Note that during `go get` you may see build errors due to incompatible dependencies, which is why
we recommend using semantic versions for dependencies. The error may be fixed by running
`make install` (it will install `dep` if you don't have it):

```shell
go get -u github.com/uber/jaeger-client-go/
cd $GOPATH/src/github.com/uber/jaeger-client-go/
git submodule update --init --recursive
make install
```

## Initialization

Expand Down