-
Notifications
You must be signed in to change notification settings - Fork 79
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add documentation for developers
- Loading branch information
Showing
1 changed file
with
26 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
# Developing hcloud-cli | ||
|
||
## Generated files | ||
This repository contains generated files, mainly for testing purposes. These files are generated by running | ||
```sh | ||
go generate ./... | ||
``` | ||
in the root directory of this repository. Make sure to keep generated files up-to-date | ||
when making changes to the code. | ||
|
||
## Unit tests | ||
Unit tests are located in the `internal` directory. Run them with | ||
```sh | ||
go test ./... | ||
``` | ||
|
||
## Build | ||
To build the binary, run | ||
```sh | ||
go build -o hcloud-cli ./cmd/hcloud | ||
``` | ||
|
||
To include version information in the resulting binary and build for all targets, use GoReleaser: | ||
```sh | ||
goreleaser --snapshot --skip-publish --rm-dist | ||
``` |