Skip to content

Commit

Permalink
Update developer guide to point at faster targets (#1656)
Browse files Browse the repository at this point in the history
Running `make build` or `make test` is probably not reasonable for
developers to use in a development iteration loop - so pointing new
developers instead at `test-go` and `build-images`, which is what is
needed most of the time.

Co-authored-by: Alexander Apalikov <alexander.apalikov@globant.com>
  • Loading branch information
markmandel and aLekSer authored Jun 30, 2020
1 parent b378628 commit 04f546f
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions build/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,10 +152,11 @@ If you are not familiar with GOPATHs, you can read [How to Write Go Code](https:

Make sure you are in the `build` directory to start.

First, let's test all the code. To do this, run `make test`, which will execute all the unit tests for the codebase.
First, let's test the Agones system code. To do this, run `make test-go`, which will execute all the unit tests for
the Go codebase (there are other tests, but they can take a long time to run).

If you haven't run any of the `build` make targets before then this will also create the Docker based build image,
and then run the tests.
If you haven't run any of Make targets before then this will also create the Docker based build
image, and then run the tests.

Building the build image may take a few minutes to download all the dependencies, so feel
free to make cup of tea or coffee at this point. ☕️
Expand All @@ -178,6 +179,9 @@ You may note that docker images, and tar archives are tagged with a concatenatio
upcoming release number and short git hash for the current commit. This has also been set in
the code itself, so that it can be seen in via log statements.

If you don't have a long time to kill, you can run `make build-images` to only build the images for running Agones
, which is often all you need for development.

Congratulations! You have now successfully tested and built Agones!

### Running a Test Google Kubernetes Engine Cluster
Expand Down

0 comments on commit 04f546f

Please sign in to comment.