Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Jess Frazelle <acidburn@microsoft.com>
- Loading branch information
0 parents
commit 39d47e0
Showing
10 changed files
with
543 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,50 @@ | ||
###Go### | ||
|
||
# Compiled Object files, Static and Dynamic libs (Shared Objects) | ||
*.o | ||
*.a | ||
*.so | ||
|
||
# Folders | ||
_obj | ||
_test | ||
|
||
# Architecture specific extensions/prefixes | ||
*.[568vq] | ||
[568vq].out | ||
|
||
*.cgo1.go | ||
*.cgo2.c | ||
_cgo_defun.c | ||
_cgo_gotypes.go | ||
_cgo_export.* | ||
|
||
_testmain.go | ||
|
||
*.exe | ||
*.test | ||
|
||
|
||
###OSX### | ||
|
||
.DS_Store | ||
.AppleDouble | ||
.LSOverride | ||
|
||
# Icon must ends with two \r. | ||
Icon | ||
|
||
|
||
# Thumbnails | ||
._* | ||
|
||
# Files that might appear on external disk | ||
.Spotlight-V100 | ||
.Trashes | ||
|
||
pkg | ||
cross/ | ||
|
||
# Go coverage results | ||
coverage.txt | ||
profile.out |
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,13 @@ | ||
language: go | ||
sudo: false | ||
go: | ||
- 1.10.x | ||
before_install: | ||
- go get github.com/golang/lint/golint | ||
- go get honnef.co/go/tools/cmd/staticcheck | ||
jobs: | ||
include: | ||
- script: make all | ||
- stage: Run Test Coverage | ||
script: make cover | ||
after_success: bash <(curl -s https://codecov.io/bash) |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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,25 @@ | ||
# Gopkg.toml example | ||
# | ||
# Refer to https://github.com/golang/dep/blob/master/docs/Gopkg.toml.md | ||
# for detailed Gopkg.toml documentation. | ||
# | ||
# required = ["github.com/user/thing/cmd/thing"] | ||
# ignored = ["github.com/user/project/pkgX", "bitbucket.org/user/project/pkgA/pkgY"] | ||
# | ||
# [[constraint]] | ||
# name = "github.com/user/project" | ||
# version = "1.0.0" | ||
# | ||
# [[constraint]] | ||
# name = "github.com/user/project2" | ||
# branch = "dev" | ||
# source = "github.com/myfork/project2" | ||
# | ||
# [[override]] | ||
# name = "github.com/x/y" | ||
# version = "2.4.0" | ||
|
||
[prune] | ||
non-go = true | ||
go-tests = true | ||
unused-packages = true |
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,21 @@ | ||
The MIT License (MIT) | ||
|
||
Copyright (c) 2018 The Genuinetools Authors | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
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,150 @@ | ||
# Set an output prefix, which is the local directory if not specified | ||
PREFIX?=$(shell pwd) | ||
|
||
# Setup name variables for the package/tool | ||
NAME := pkg | ||
PKG := github.com/genuinetools/$(NAME) | ||
|
||
# Set any default go build tags | ||
BUILDTAGS := | ||
|
||
# Set the build dir, where built cross-compiled binaries will be output | ||
BUILDDIR := ${PREFIX}/cross | ||
|
||
# Populate version variables | ||
# Add to compile time flags | ||
VERSION := $(shell cat VERSION.txt) | ||
GITCOMMIT := $(shell git rev-parse --short HEAD) | ||
GITUNTRACKEDCHANGES := $(shell git status --porcelain --untracked-files=no) | ||
ifneq ($(GITUNTRACKEDCHANGES),) | ||
GITCOMMIT := $(GITCOMMIT)-dirty | ||
endif | ||
CTIMEVAR=-X $(PKG)/version.GITCOMMIT=$(GITCOMMIT) -X $(PKG)/version.VERSION=$(VERSION) | ||
GO_LDFLAGS=-ldflags "-w $(CTIMEVAR)" | ||
GO_LDFLAGS_STATIC=-ldflags "-w $(CTIMEVAR) -extldflags -static" | ||
|
||
# Set our default go compiler | ||
GO := go | ||
|
||
# List the GOOS and GOARCH to build | ||
GOOSARCHES = darwin/amd64 darwin/386 freebsd/amd64 freebsd/386 linux/arm linux/arm64 linux/amd64 linux/386 solaris/amd64 windows/amd64 windows/386 | ||
|
||
.PHONY: build | ||
build: $(NAME) ## Builds a dynamic executable or package | ||
|
||
$(NAME): $(wildcard *.go) $(wildcard */*.go) VERSION.txt | ||
@echo "+ $@" | ||
$(GO) build -tags "$(BUILDTAGS)" ${GO_LDFLAGS} -o $(NAME) ./... | ||
|
||
.PHONY: static | ||
static: ## Builds a static executable | ||
@echo "+ $@" | ||
CGO_ENABLED=0 $(GO) build \ | ||
-tags "$(BUILDTAGS) static_build" \ | ||
${GO_LDFLAGS_STATIC} -o $(NAME) ./... | ||
|
||
all: clean build fmt lint test staticcheck vet install ## Runs a clean, build, fmt, lint, test, staticcheck, vet and install | ||
|
||
.PHONY: fmt | ||
fmt: ## Verifies all files have been `gofmt`ed | ||
@echo "+ $@" | ||
@gofmt -s -l . | grep -v '.pb.go:' | grep -v vendor | tee /dev/stderr | ||
|
||
.PHONY: lint | ||
lint: ## Verifies `golint` passes | ||
@echo "+ $@" | ||
@golint ./... | grep -v '.pb.go:' | grep -v vendor | tee /dev/stderr | ||
|
||
.PHONY: test | ||
test: ## Runs the go tests | ||
@echo "+ $@" | ||
@$(GO) test -v -tags "$(BUILDTAGS) cgo" $(shell $(GO) list ./... | grep -v vendor) | ||
|
||
.PHONY: vet | ||
vet: ## Verifies `go vet` passes | ||
@echo "+ $@" | ||
@$(GO) vet $(shell $(GO) list ./... | grep -v vendor) | grep -v '.pb.go:' | tee /dev/stderr | ||
|
||
.PHONY: staticcheck | ||
staticcheck: ## Verifies `staticcheck` passes | ||
@echo "+ $@" | ||
@staticcheck $(shell $(GO) list ./... | grep -v vendor) | grep -v '.pb.go:' | tee /dev/stderr | ||
|
||
.PHONY: cover | ||
cover: ## Runs go test with coverage | ||
@echo "" > coverage.txt | ||
@for d in $(shell $(GO) list ./... | grep -v vendor); do \ | ||
$(GO) test -race -coverprofile=profile.out -covermode=atomic "$$d"; \ | ||
if [ -f profile.out ]; then \ | ||
cat profile.out >> coverage.txt; \ | ||
rm profile.out; \ | ||
fi; \ | ||
done; | ||
|
||
.PHONY: install | ||
install: ## Installs the executable or package | ||
@echo "+ $@" | ||
$(GO) install -a -tags "$(BUILDTAGS)" ${GO_LDFLAGS} ./... | ||
|
||
define buildpretty | ||
mkdir -p $(BUILDDIR)/$(1)/$(2); | ||
GOOS=$(1) GOARCH=$(2) CGO_ENABLED=0 $(GO) build \ | ||
-o $(BUILDDIR)/$(1)/$(2)/$(NAME) \ | ||
-a -tags "$(BUILDTAGS) static_build netgo" \ | ||
-installsuffix netgo ${GO_LDFLAGS_STATIC} .; | ||
md5sum $(BUILDDIR)/$(1)/$(2)/$(NAME) > $(BUILDDIR)/$(1)/$(2)/$(NAME).md5; | ||
sha256sum $(BUILDDIR)/$(1)/$(2)/$(NAME) > $(BUILDDIR)/$(1)/$(2)/$(NAME).sha256; | ||
endef | ||
|
||
.PHONY: cross | ||
cross: *.go VERSION.txt ## Builds the cross-compiled binaries, creating a clean directory structure (eg. GOOS/GOARCH/binary) | ||
@echo "+ $@" | ||
$(foreach GOOSARCH,$(GOOSARCHES), $(call buildpretty,$(subst /,,$(dir $(GOOSARCH))),$(notdir $(GOOSARCH)))) | ||
|
||
define buildrelease | ||
GOOS=$(1) GOARCH=$(2) CGO_ENABLED=0 $(GO) build \ | ||
-o $(BUILDDIR)/$(NAME)-$(1)-$(2) \ | ||
-a -tags "$(BUILDTAGS) static_build netgo" \ | ||
-installsuffix netgo ${GO_LDFLAGS_STATIC} .; | ||
md5sum $(BUILDDIR)/$(NAME)-$(1)-$(2) > $(BUILDDIR)/$(NAME)-$(1)-$(2).md5; | ||
sha256sum $(BUILDDIR)/$(NAME)-$(1)-$(2) > $(BUILDDIR)/$(NAME)-$(1)-$(2).sha256; | ||
endef | ||
|
||
.PHONY: release | ||
release: *.go VERSION.txt ## Builds the cross-compiled binaries, naming them in such a way for release (eg. binary-GOOS-GOARCH) | ||
@echo "+ $@" | ||
$(foreach GOOSARCH,$(GOOSARCHES), $(call buildrelease,$(subst /,,$(dir $(GOOSARCH))),$(notdir $(GOOSARCH)))) | ||
|
||
.PHONY: bump-version | ||
BUMP := patch | ||
bump-version: ## Bump the version in the version file. Set BUMP to [ patch | major | minor ] | ||
@$(GO) get -u github.com/jessfraz/junk/sembump # update sembump tool | ||
$(eval NEW_VERSION = $(shell sembump --kind $(BUMP) $(VERSION))) | ||
@echo "Bumping VERSION.txt from $(VERSION) to $(NEW_VERSION)" | ||
echo $(NEW_VERSION) > VERSION.txt | ||
@echo "Updating links to download binaries in README.md" | ||
sed -i s/$(VERSION)/$(NEW_VERSION)/g README.md | ||
git add VERSION.txt README.md | ||
git commit -vsam "Bump version to $(NEW_VERSION)" | ||
@echo "Run make tag to create and push the tag for new version $(NEW_VERSION)" | ||
|
||
.PHONY: tag | ||
tag: ## Create a new git tag to prepare to build a release | ||
git tag -sa $(VERSION) -m "$(VERSION)" | ||
@echo "Run git push origin $(VERSION) to push your new tag to GitHub and trigger a travis build." | ||
|
||
.PHONY: AUTHORS | ||
AUTHORS: | ||
@$(file >$@,# This file lists all individuals having contributed content to the repository.) | ||
@$(file >>$@,# For how it is generated, see `make AUTHORS`.) | ||
@echo "$(shell git log --format='\n%aN <%aE>' | LC_ALL=C.UTF-8 sort -uf)" >> $@ | ||
|
||
.PHONY: clean | ||
clean: ## Cleanup any build binaries or packages | ||
@echo "+ $@" | ||
$(RM) $(NAME) | ||
$(RM) -r $(BUILDDIR) | ||
|
||
.PHONY: help | ||
help: | ||
@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}' |
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,8 @@ | ||
# pkg | ||
|
||
[![Travis CI](https://img.shields.io/travis/genuinetools/pkg.svg?style=for-the-badge)](https://travis-ci.org/genuinetools/pkg) | ||
[![GoDoc](https://img.shields.io/badge/godoc-reference-5272B4.svg?style=for-the-badge)](https://godoc.org/github.com/genuinetools/pkg) | ||
[![Github All Releases](https://img.shields.io/github/downloads/genuinetools/pkg/total.svg?style=for-the-badge)](https://github.com/genuinetools/pkg/releases) | ||
|
||
|
||
A home for various go packages to be imported by other projects. |
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 @@ | ||
v0.0.0 |
Oops, something went wrong.