ridv/gorealis-v2
1
0
Fork 0
Code Issues Pull requests Projects Releases 13 Packages Wiki Activity Actions

Update developing.md

Browse source 
Updating documentation for developing gorealis
This commit is contained in:
Renán I. Del Valle 2020-05-20 18:21:47 -07:00 • committed by GitHub
parent 851f9686b6
commit 34a950306d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

24
docs/developing.md
View file

@ -19,25 +19,18 @@ This also allows us to delete and recreate our development cluster very quickly.
To install docker-compose please follow the instructions for your platform To install docker-compose please follow the instructions for your platform
[here](https://docs.docker.com/compose/install/). [here](https://docs.docker.com/compose/install/).
### Getting the source code ### Getting the source code
As of go 1.10.x, GOPATH is still relevant. This may change in the future but `$ git clone https://github.com/aurora-scheduler/gorealis`
for the sake of making development less error prone, it is suggested that the following
directories be created:
`$ mkdir -p $GOPATH/src/github.com/paypal` Inside of the newly cloned repo you may download dependencies to the local cache using go mod
And then clone the master branch into the newly created folder: `$ go mod download`
`$ cd $GOPATH/src/github.com/paypal; git clone git@github.com:paypal/gorealis.git`
Since we check in our vendor folder, gorealis no further set up is needed.
### Bringing up the cluster ### Bringing up the cluster
To develop gorealis, you will need a fully functioning Mesos cluster along with To develop gorealis, you will need a fully functioning Mesos cluster along with
Apache Aurora. the Aurora Scheduler.
In order to bring up our docker-compose set up execute the following command from the root In order to bring up our docker-compose set up execute the following command from the root
of the git repository: of the git repository:
@ -62,14 +55,14 @@ environment but not when running under MacOS. To run code involving the ZK leade
For example, running the tests in a container can be done through the following command from For example, running the tests in a container can be done through the following command from
the root of the git repository: the root of the git repository:
`$ docker run -t -v $(pwd):/go/src/github.com/paypal/gorealis --network gorealis_aurora_cluster golang:1.10.3-alpine go test github.com/paypal/gorealis` `$ docker run -t -v $(pwd):/go/src/github.com/aurora-scheduler/gorealis --network gorealis_aurora_cluster golang:1.14.3-alpine go test github.com/paypal/gorealis`
Or Or
`$ ./runTestsMac.sh` `$ ./runTestsMac.sh`
Alternatively, if an interactive shell is necessary, the following command may be used: Alternatively, if an interactive shell is necessary, the following command may be used:
`$ docker run -it -v $(pwd):/go/src/github.com/paypal/gorealis --network gorealis_aurora_cluster golang:1.10.3-alpine /bin/sh` `$ docker run -it -v $(pwd):/go/src/github.com/paypal/gorealis --network gorealis_aurora_cluster golang:1.14.3-alpine /bin/sh`
### Cleaning up the cluster ### Cleaning up the cluster
@ -85,6 +78,3 @@ Once development is done, the environment may be torn down by executing (from th
git directory): git directory):
`$ docker-compose down` `$ docker-compose down`