Skip to content

Commit

Permalink
Added "common development flows" to dev guide (#2655)
Browse files Browse the repository at this point in the history
Broke out a section in the dev guide to highlight and suggest some
common development flows when using the `make` based system that might
not be obvious to spot.
  • Loading branch information
markmandel authored Jun 30, 2022
1 parent 6f1ffe7 commit 9ba7a35
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions build/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ Table of Contents
* [Running a Test Minikube cluster](#running-a-test-minikube-cluster)
* [Running a Test Kind cluster](#running-a-test-kind-cluster)
* [Running a Custom Test Environment](#running-a-custom-test-environment)
* [Common Development Flows](#common-development-flows)
* [Set Local Make Targets and Variables with `local-includes`](#set-local-make-targets-and-variables-with-local-includes)
* [Running Individual End-to-End Tests](#running-individual-end-to-end-tests)
* [Make Variable Reference](#make-variable-reference)
Expand Down Expand Up @@ -345,10 +346,17 @@ Now you're ready to begin the development/test cycle:
- `make install` will install/upgrade Agones into your cluster
- `make test-e2e` will run end-to-end tests in your cluster

You can combine some of the above steps into a single one, for example `make build push install` or `make build push test-e2e`.

If you need to clean up your cluster, you can use `make uninstall` to remove Agones.

### Common Development Flows

You can combine some of the above steps into a single one, for example `make build-images push install` is very
common flow, to build you changes on Agones, push them to a container registry and install this development
version to your cluster.

Another would be to run `make lint test-go` to run the golang linter against the Go code, and then run all the unit
tests.

### Set Local Make Targets and Variables with `local-includes`

If you want to permanently set `Makefile` variables or add targets to your local setup, all `local-includes/*.mk`
Expand Down

0 comments on commit 9ba7a35

Please sign in to comment.