add goreleaser #49

leighmcculloch · 2018-09-15T23:57:55Z

Add a goreleaser configuration file that builds binaries for Linux,
MacOS and Windows, for 32bit (x86/386) and 64bit (x64/amd64). The
binaries will be archived into a tar.gz/zip file along with the LICENSE
file.

The dist/ directory will be written to by goreleaser with the binaries
during the build process, so it's also been added to .gitignore.

Goreleaser can be installed with:
go get github.com/goreleaser/goreleaser

Or other methods for install can be found at:
https://goreleaser.com

To build all the binaries and release them to GitHub:

Tag the release. e.g. git tag -a v1.0.0 -m 'First release'
Generate a GitHub Personal Access Token. See https://github.com/settings/tokens.
Push the release to GitHub. e.g. git push origin v1.0.0
Run goreleaser. e.g. GITHUB_TOKEN=xxxxxxx... goreleaser

Goreleaser will build the binaries, and upload the binaries to the
GitHub project's release page for the release that was tagged.

Goreleaser will also set the main.version variable with the version
being released, so I added a -version flag that will print:
grpcurl v<version>

Closes #47

Add a goreleaser configuration file that builds binaries for Linux, MacOS and Windows, for 32bit (x86/386) and 64bit (x64/amd64). The binaries will be archived into a tar.gz/zip file along with the LICENSE file. The `dist/` directory will be written to by goreleaser with the binaries during the build process, so it's also been added to .gitignore. Goreleaser can be installed with: go get github.com/goreleaser/goreleaser Or other methods for install can be found at: https://goreleaser.com To build all the binaries and release them to GitHub: 1. Tag the release. e.g. `git tag -a v1.0.0 -m 'First release'` 2. Generate a GitHub Personal Access Token. See https://github.com/settings/tokens. 3. Push the release to GitHub. e.g. `git push origin v1.0.0` 4. Run goreleaser. e.g. `GITHUB_TOKEN=xxxxxxx... goreleaser` Go releaser will build the binaries, and upload the binaries to the GitHub project's release page for the release that was tagged.

jhump · 2018-09-17T14:11:02Z

cmd/grpcurl/.goreleaser.yml

+    386: x86
+    darwin: macos
+  files:
+    - LICENSE


When I tried to run this locally, this failed because the LICENSE file is not in this directory. However, when I tried editing this to point to ../../LICENSE, it generated a gnarly entry in the resulting TGZ that had ../LICENSE as the path (e.g. it created a directory entry in the archive for .., which seems bad).

I have not yet tried to read through goreleaser docs to see how to fix this situation, but I think we need this configuration to run and produce a good archive before we merge this PR.

I also noticed that the TGZ has a directory inside named grpcurl_<version>_<platform>_<arch>, which seems quite verbose. Many binary distributions I've seen (IIRC) just have a folder named grpcurl (without the version, platform, and architecture). Is there a "best practice" that I don't know about for putting all of this information into the resulting directory after unzipping a TGZ?

Ah yes. I originally had the .goreleaser.yml in the root, then moved it to the subdirectory. I can change the config so there's no nested directory. Some binaries I've seen don't both with the LICENSE, and they just have the binary without the directory. The easiest way to install these then is:

curl https://... | tar xz -C /usr/local/bin

Adding the license can be nice if someone redistributes the binary, but practically for all of the users just downloading it to install immediately, it's an annoyance and it makes the install instructions slightly longer to extract only the binary from the tar.

For now, I think we should keep the license in the distribution. I think it's simple enough to extract the binary into /usr/local/bin, for people that want to install it there.

In the future, I may look into adding a homebrew recipe, which will simplify it further for OS X users, and make it even easier to auto-install into that location.

jhump · 2018-09-17T14:11:39Z

cmd/grpcurl/.goreleaser.yml

+    - goos: windows
+      format: zip
+  replacements:
+    amd64: x64


I was just looking at the protoc distribution, and they use x86_64 as the architecture here and x86_32 for 386. Maybe do the same, for consistency with a closely related binary?

jhump · 2018-09-17T14:12:03Z

cmd/grpcurl/.goreleaser.yml

+  replacements:
+    amd64: x64
+    386: x86
+    darwin: macos


The protoc distribution uses osx. So same remark as above: maybe change for consistency with that project?

jhump · 2018-09-17T14:16:37Z

cmd/grpcurl/grpcurl.go

@@ -30,13 +30,17 @@ import (
 	"github.com/fullstorydev/grpcurl"
 )

+var version = "<not set>"


Maybe something a little more informative, like dev build <no version set>? And it would also be nice to update the Makefile so it uses -ldflags to set main.version to something like dev build <git sha> (though that's fine to omit from this PR and maybe just add a TODO; if you want to tackle in another branch, great, and if not I can address it).

👍 Lets tackle it in this branch. I'll add it.

@jhump I took a stab at doing the git sha. When doing make install it will build a binary where the output is like:

$ grpcurl -version grpcurl dev build e198d3e

If the working directory is dirty, it will look like:

$ grpcurl -version grpcurl dev build e198d3e-dirty

If it's for a released version, it will look like:

$ grpcurl -version grpcurl 1.0.1

I dropped the v because it couldn't be uniformly applied to a version number of the dev build... string, but if you particularly like that format I can add it back in by customizing the configuring what goreleaser sets with the ldflags so that it is prefixed with a v.

leighmcculloch · 2018-09-17T15:06:39Z

I've pushed some changes to this branch, but I want to add the dev build <git sha> and will circle back to do that. Still would appreciate thoughts on #49 (comment). Thanks for already reviewing it so quickly!

…he makefile

leighmcculloch · 2018-09-18T05:38:07Z

@jhump Ready for another 👀 from you 😄 .

jhump · 2018-09-20T19:45:38Z

@leighmcculloch, promise I haven't forgotten. I will try to make time for further review later today.

jhump

I think this is really close. I just left a couple of more comments. Sorry it took me so long to get to looking at this.

.goreleaser.yml

Makefile

leighmcculloch · 2018-09-25T04:03:07Z

@jhump Addressed your last round of feedback. I also changed the format of the version text that's injected so it has a v on the beginning of it for the goreleaser builds. That's in 0620c43.

leighmcculloch · 2018-09-25T04:05:08Z

.goreleaser.yml

+      - amd64
+      - 386
+    ldflags:
+      - -s -w -X main.version=v{{.Version}}


I copied this line from the documentation, and the -s -w are part of the default (see below). The main difference I made was to drop the fields we don't use and to add a v at the beginning of the version. I did the prefix here and not in the code because the code would print out v in front of the dev build... string which wouldn't look great.

The default value is:

-s -w -X main.version={{.Version}} -X main.commit={{.Commit}} -X main.date={{.Date}}

Ref: https://goreleaser.com/customization/#Name%20Templates

leighmcculloch · 2018-09-25T04:09:25Z

Makefile

+
+.PHONY: release
+release:
+	@GO111MODULE=off go get github.com/goreleaser/goreleaser


I also added GO111MODULE=off here to make sure the go get command doesn't mess with the go.mod file, otherwise go get will add goreleaser and it's dependencies to go.mod. There's a chance the behavior of go get might change in go1.12 so that we don't have to turn it off because of very active conversation on golang/go#27643.

leighmcculloch mentioned this pull request Sep 15, 2018

Release binaries #47

Closed

jhump reviewed Sep 17, 2018

View reviewed changes

leighmcculloch added 5 commits September 17, 2018 15:03

Remove wrap in directory

86b25ff

Remove LICENSE

ba827bc

Rename macos to osx for consistency with protoc

9c68385

Rename amd64 and 386 filenames to match protoc

b732cd1

Print dev build <no version set> when no version set

0b86ec0

leighmcculloch added 6 commits September 18, 2018 05:12

Set version in Makefile when installing

e198d3e

Re-add LICENSE

99ad3ca

Add instructions for binaries

3d758f4

Fix comment location in Makefile

ec9d5a8

Add release target to Makefile

0a2a010

Install goreleaser if needed, like how other tools are installed in t…

c162649

…he makefile

jhump reviewed Sep 24, 2018

View reviewed changes

.goreleaser.yml Outdated Show resolved Hide resolved

Makefile Outdated Show resolved Hide resolved

leighmcculloch added 4 commits September 25, 2018 03:29

Add tags

2a6a598

Set main to dir and not file

bfbcb03

Don't alter go.mod when getting goreleaser

36eac26

Prefix version with v

0620c43

leighmcculloch commented Sep 25, 2018

View reviewed changes

jhump approved these changes Sep 25, 2018

View reviewed changes

jhump merged commit 79a550b into fullstorydev:master Sep 25, 2018

leighmcculloch deleted the goreleaser branch September 27, 2018 03:26

jhump mentioned this pull request Dec 14, 2018

fullstory.ExportList is throwing a 404 error for bigquery fullstorydev/hauser#38

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add goreleaser #49

add goreleaser #49

leighmcculloch commented Sep 15, 2018

jhump Sep 17, 2018

leighmcculloch Sep 17, 2018

leighmcculloch Sep 17, 2018

jhump Sep 17, 2018

jhump Sep 17, 2018

leighmcculloch Sep 17, 2018

jhump Sep 17, 2018

jhump Sep 17, 2018

leighmcculloch Sep 17, 2018

leighmcculloch Sep 18, 2018

leighmcculloch commented Sep 17, 2018

leighmcculloch commented Sep 18, 2018

jhump commented Sep 20, 2018

jhump left a comment

leighmcculloch commented Sep 25, 2018

leighmcculloch Sep 25, 2018 •

edited

Loading

leighmcculloch Sep 25, 2018

add goreleaser #49

add goreleaser #49

Conversation

leighmcculloch commented Sep 15, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

leighmcculloch commented Sep 17, 2018

leighmcculloch commented Sep 18, 2018

jhump commented Sep 20, 2018

jhump left a comment

Choose a reason for hiding this comment

leighmcculloch commented Sep 25, 2018

leighmcculloch Sep 25, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

leighmcculloch Sep 25, 2018 •

edited

Loading