Skip to content

Commit f027a89

Browse files
thirteen37feast-ci-bot
thirteen37
authored and
feast-ci-bot
committed
Simplify and document CLI building steps (feast-dev#158)
* Use vendored protoc-gen-go * Simplified CLI building README Building the CLI is now two steps to install dev dependencies and one step to build. * Cleanup Gopkg.toml
1 parent 39d2c45 commit f027a89

20 files changed

+340
-332
lines changed

‎Gopkg.lock‎

Lines changed: 8 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎Gopkg.toml‎

Lines changed: 1 addition & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,4 @@
1-
# Gopkg.toml example
2-
#
3-
# Refer to https://github.com/golang/dep/blob/master/docs/Gopkg.toml.md
4-
# for detailed Gopkg.toml documentation.
5-
#
6-
# required = ["github.com/user/thing/cmd/thing"]
7-
# ignored = ["github.com/user/project/pkgX", "bitbucket.org/user/project/pkgA/pkgY"]
8-
#
9-
# [[constraint]]
10-
# name = "github.com/user/project"
11-
# version = "1.0.0"
12-
#
13-
# [[constraint]]
14-
# name = "github.com/user/project2"
15-
# branch = "dev"
16-
# source = "github.com/myfork/project2"
17-
#
18-
# [[override]]
19-
# name = "github.com/x/y"
20-
# version = "2.4.0"
21-
#
22-
# [prune]
23-
# non-go = false
24-
# go-tests = true
25-
# unused-packages = true
26-
1+
required = ["github.com/golang/protobuf/protoc-gen-go"]
272

283
[[constraint]]
294
name = "github.com/ghodss/yaml"
@@ -49,10 +24,6 @@
4924
name = "github.com/spf13/viper"
5025
version = "1.2.1"
5126

52-
[[constraint]]
53-
branch = "master"
54-
name = "golang.org/x/net"
55-
5627
[[constraint]]
5728
name = "google.golang.org/grpc"
5829
version = "1.15.0"

‎cli/README.md‎

Lines changed: 29 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Feast CLI
22

3-
The feast command-line tool, `feast`, is used to register resources to feast, as well as manage and run ingestion jobs.
3+
The feast command-line tool, `feast`, is used to register resources to
4+
feast, as well as manage and run ingestion jobs.
45

56
## Installation
67

@@ -10,32 +11,39 @@ The quickest way to get the CLI is to download the compiled binary: #TODO
1011

1112
### Building from source
1213

13-
The following dependencies are required to install the CLI from source:
14-
#### protoc
15-
To install protoc, find the compiled binary for your distribution [here](https://github.com/protocolbuffers/protobuf/releases), then install it:
16-
```
17-
PROTOC_VERSION=3.3.0
14+
The following dependencies are required to build the CLI from source:
15+
* [`go`](https://golang.org/)
16+
* [`protoc`](https://developers.google.com/protocol-buffers/)
17+
* [`dep`](https://github.com/golang/dep)
18+
19+
See below for specific instructions on how to install the dependencies.
1820

19-
curl -OL https://github.com/google/protobuf/releases/download/v$PROTOC_VERSION/$PROTOC_ZIP
20-
unzip -o $PROTOC_ZIP -d /usr/local bin/protoc
21-
rm -f $PROTOC_ZIP
21+
After the dependencies are installed, you can build the CLI using:
22+
```sh
23+
# at feast top-level directory
24+
$ make build-cli
2225
```
2326

24-
#### dep
25-
On MacOS you can install or upgrade to the latest released version with Homebrew:
27+
### Dependencies
2628

27-
```
28-
brew install dep
29-
brew upgrade dep
30-
```
29+
#### `protoc-gen-go`
3130

32-
On other platforms you can use the install.sh script:
33-
```
34-
curl https://raw.githubusercontent.com/golang/dep/master/install.sh | sh
31+
To ensure you have a matching version of `protoc-gen-go`, install the vendored version:
32+
```sh
33+
$ go install ./vendor/github.com/golang/protobuf/protoc-gen-go
34+
$ which protoc-gen-go
35+
~/go/bin/protoc-gen-go
3536
```
3637

37-
Then just install the cli using:
38+
#### `dep`
39+
40+
On MacOS you can install or upgrade to the latest released version with Homebrew:
41+
```sh
42+
$ brew install dep
43+
$ brew upgrade dep
3844
```
39-
# at feast top-level directory
40-
make install-cli
45+
46+
On other platforms you can use the `install.sh` script:
47+
```sh
48+
$ curl https://raw.githubusercontent.com/golang/dep/master/install.sh | sh
4149
```

‎protos/generated/go/feast/core/CoreService.pb.go‎

Lines changed: 46 additions & 44 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎protos/generated/go/feast/core/DatasetService.pb.go‎

Lines changed: 19 additions & 17 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)