Skip to content

Commit 57c2a3d

Browse files
feat(release): add docs, windows release target, and fix ldflags for version command (#92)
* feat(docs): add Installation and Usage sections to README * fix(release): qualify ldflags packages as full import paths When ldflags are intended to be injected in non-main packages, the package name must be fully qualified. * feat(release): include windows as $GOOS target Kleat will now be released for the matrix of $GOOS (darwin, linux, windows) and $GOARCH (386, amd64), which are all valid combinations per https://golang.org/doc/install/source#environment. Added documentation to .goreleaser.yml in case users need additional combinations in the future.
1 parent 7721671 commit 57c2a3d

File tree

2 files changed

+19
-1
lines changed

2 files changed

+19
-1
lines changed

.goreleaser.yml

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
11
builds:
22
- ldflags:
3-
- -s -w -X cmd.version={{.Version}} -X cmd.commit={{.Commit}} -X cmd.date={{.Date}}
3+
- -s -w -X github.com/spinnaker/kleat/cmd.version={{.Version}} -X github.com/spinnaker/kleat/cmd.commit={{.Commit}} -X github.com/spinnaker/kleat/cmd.date={{.Date}}
4+
# By default, will build each specified $GOOS for the default $GOARCH options of 386 and amd64.
5+
# If necessary in the future, can specify non-default $GOARCH options under `goarch` key per
6+
# https://goreleaser.com/customization/build/.
7+
goos:
8+
- darwin
9+
- linux
10+
- windows

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,3 +91,14 @@ be used as input to Kleat.
9191
acceptable to remove all values for which the microservice's deafult value is
9292
acceptable. For example, if you do not use the Google App Engine provider, you
9393
can remove the `Providers.AppengineProvider` block from your halconfig.
94+
95+
### Installation
96+
97+
Download the appropriate binary from the
98+
[releases page](https://github.com/spinnaker/kleat/releases/latest).
99+
100+
### Usage
101+
102+
- `kleat generate /path/to/halconfig /path/to/output/directory`
103+
- `kleat help`
104+
- `kleat version`

0 commit comments

Comments
 (0)