Skip to content

Commit

Permalink
add release examples
Browse files Browse the repository at this point in the history
  • Loading branch information
ezekg committed Oct 7, 2024
1 parent 8ea3a34 commit 0fa97ed
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -211,14 +211,28 @@ go build -o relay ./cmd/relay
```

Alternatively, you can build binaries for specific platforms and architectures
using the provided `Makefile`:
using the provided `make` commands:

```bash
make build
make build-linux-amd64
make build-all
```

### Releasing

To cut and publish a new release of Relay, update the `VERSION` file and run
the following `make` command:

```
make release
```

Releases are uploaded and published using the [Keygen CLI](https://keygen.sh/docs/cli/).
Releases are hosted and distributed by [Keygen Cloud](https://keygen.sh). You
will need credentials and permission to upload to our production Keygen Cloud
account.

### Testing

Keygen Relay comes with a suite of tests, including integration tests that
Expand Down

0 comments on commit 0fa97ed

Please sign in to comment.