Skip to content

Commit

Permalink
chore: add more local development instructions to README
Browse files Browse the repository at this point in the history
  • Loading branch information
smlx committed Feb 4, 2025
1 parent 0f1b00e commit 8469896
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,21 @@ This helps to correlate error messages reported by users with detailed errors in

## Development tips

### Build locally

The build process requires [goreleaser](https://github.com/goreleaser/goreleaser) 2.x to be installed in your path.

`make build` will build a binary for your local architecture in `dist/`.

`make release-snapshot` will build binaries and docker images for all configured architectures.

### Running tests

`make test` will run the test suite.
It regenerates code, so requires [mockgen](https://github.com/uber-go/mock/) and [enumer](https://github.com/dmarkham/enumer/) to be installed in your path.

Alternatively you can just run `go test -v ./...` manually to avoid regenerating any code.

### Debugging Keycloak permissions

A command to debug Keycloak permissions locally is included in `./cmd/keycloak-debug`.
Expand Down

0 comments on commit 8469896

Please sign in to comment.