blob: 2b3b3c153be16c0705efa3a5a275d617093d2b9b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
|
# Development Guide
## Building the development environment
You need a working [Go environment](https://golang.org/doc/install) (1.11 or newer) with the module support enabled.
```bash
$ git clone git://github.com/osrg/gobgp
$ cd gobgp && go mod download
```
Now ready to modify the code and build two binaries, `cmd/gobgp` and `cmd/gobgpd`.
## Releases
GoBGP releases are time-based. Minor releases will occur every month ([Semantic Versioning](https://semver.org/)). Major releases occur only when absolutely necessary.
## Layout
The GoBGP project adopts [Standard Go Project Layout](https://github.com/golang-standards/project-layout).
## Changing the gRPC API
If you change the gRPC API, generate `api/gobgp.pb.go` in the following way:
```bash
$ protoc -I ~/protobuf/src -I ${GOBGP}/api --go_out=plugins=grpc:${GOBGP}/api \
${GOBGP}/api/gobgp.proto ${GOBGP}/api/attribute.proto ${GOBGP}/api/capability.proto
```
|
