|
1 | 1 | # Contributing |
2 | 2 |
|
| 3 | +## Prerequisites |
| 4 | + |
| 5 | +To build and run this extension locally, you need: |
| 6 | + |
| 7 | +- [Go](https://go.dev/dl/) 1.26 or later |
| 8 | +- [GNU Make](https://www.gnu.org/software/make/) |
| 9 | +- [GoReleaser](https://goreleaser.com/) (used by `make build`) |
| 10 | +- [Docker](https://www.docker.com/) (required for `make container` and container-based tests) |
| 11 | +- [Helm](https://helm.sh/docs/intro/install/) and [helm-unittest](https://github.com/helm-unittest/helm-unittest) (for chart development; `make charttesting` and `make chartlint`) |
| 12 | + |
3 | 13 | ## Getting Started |
4 | 14 |
|
5 | 15 | 1. Clone the repository |
|
9 | 19 |
|
10 | 20 | ## Tasks |
11 | 21 |
|
12 | | -The `Makefile` in the project root contains commands to easily run common admin tasks: |
| 22 | +The `Makefile` in the project root contains commands to easily run common admin tasks. Run `make help` to list all available targets. |
13 | 23 |
|
14 | | -| Command | Meaning | |
15 | | -|----------------|-------------------------------------------------------------------------------------------------------| |
16 | | -| `$ make tidy` | Format all code using `go fmt` and tidy the `go.mod` file. | |
17 | | -| `$ make audit` | Run `go vet`, `staticheck`, execute all tests and verify required modules. | |
18 | | -| `$ make build` | Build a binary for the extension. Creates a file called `extension` in the repository root directory. | |
19 | | -| `$ make run` | Build and then run the created binary. | |
| 24 | +| Command | Meaning | |
| 25 | +|--------------------|-------------------------------------------------------------------------------------------------------| |
| 26 | +| `$ make tidy` | Format all code using `go fmt` and tidy the `go.mod` file. | |
| 27 | +| `$ make audit` | Run `go vet`, `staticcheck`, execute all tests and verify required modules. | |
| 28 | +| `$ make build` | Build a binary for the extension. Creates a file called `extension` in the repository root directory. | |
| 29 | +| `$ make run` | Build and then run the created binary. | |
| 30 | +| `$ make container` | Build the container image (`extension-debug:latest`) using Docker buildx. | |
20 | 31 |
|
21 | 32 | ## Releasing the Code/Docker Image |
22 | 33 |
|
|
0 commit comments