squashing

Author: Brian Bentson

.errcheck-excludes

@@ -0,0 +1,5 @@
+// (*io.PipeWriter).CloseWithError "never overwrites the previous error if it
+// exists and always returns nil".
+//
+// https://golang.org/pkg/io/#PipeWriter.CloseWithError
+(*io.PipeWriter).CloseWithError

.github/workflows/ci.yml

@@ -0,0 +1,38 @@
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        go: [1.13, 1.14, 1.15]
+        os: [ubuntu-latest, macos-latest]
+    name: Build & Test
+    runs-on: ${{ matrix.os }}
+    steps:
+    - name: Set up Go ${{ matrix.go }}
+      uses: actions/setup-go@v2
+      with:
+        go-version: ${{ matrix.go }}
+    - name: Check out
+      uses: actions/checkout@v2
+    - name: Test
+      run: go test -tags=unit ./...
+  golangci:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+    - name: Check out
+      uses: actions/checkout@v2
+    - name: golangci-lint
+      uses: golangci/golangci-lint-action@v2
+      with:
+        version: v1.29
+        only-new-issues: true
+        args: --timeout=5m

.golangci.yml

@@ -0,0 +1,95 @@
+run:
+  concurrency: 4
+  timeout: 1m
+
+  # exit code when at least one issue was found
+  issues-exit-code: 1
+
+  # include test files
+  tests: true
+
+  build-tags:
+
+  # which dirs to skip: issues from them won't be reported;
+  skip-dirs:
+
+  # enables skipping of default directories:
+  #   vendor$, third_party$, testdata$, examples$, Godeps$, builtin$
+  skip-dirs-use-default: true
+
+  # which files to skip: they will be analyzed, but issues from them won't be
+  # reported.
+  skip-files:
+
+  # disallow multiple parallel golangci-lint instances
+  allow-parallel-runners: false
+
+output:
+  # colored-line-number|line-number|json|tab|checkstyle|code-climate
+  format: colored-line-number
+
+  # print lines of code with issue
+  print-issued-lines: true
+
+  # print linter name in the end of issue text
+  print-linter-name: true
+
+  # make issues output unique by line
+  uniq-by-line: true
+
+linters-settings:
+  errcheck:
+    # do not report about not checking errors in type assertions: `a :=
+    # b.(MyStruct)`
+    check-type-assertions: false
+
+    # do not report about assignment of errors to blank identifier: `num, _ :=
+    # strconv.Atoi(numStr)`
+    check-blank: false
+
+    # path to a file containing a list of functions to exclude from checking
+    # see https://github.com/kisielk/errcheck#excluding-functions for details
+    exclude: .errcheck-excludes
+
+  govet:
+    # report about shadowed variables
+    check-shadowing: true
+
+    # settings per analyzer
+    settings:
+      # run `go tool vet help` to see all analyzers
+      printf:
+        # run `go tool vet help printf` to see available settings for `printf`
+        # analyzer
+        funcs:
+          - (github.com/grailbio/base/log).Fatal
+          - (github.com/grailbio/base/log).Output
+          - (github.com/grailbio/base/log).Outputf
+          - (github.com/grailbio/base/log).Panic
+          - (github.com/grailbio/base/log).Panicf
+          - (github.com/grailbio/base/log).Print
+          - (github.com/grailbio/base/log).Printf
+
+  unused:
+    # do not report unused exported identifiers
+    check-exported: false
+  
+  misspell:
+    locale: US
+
+linters:
+  disable-all: true
+  fast: false
+  enable:
+    - deadcode
+    - goimports
+    - gosimple
+    - govet
+    - errcheck
+    - ineffassign
+    - misspell
+    - staticcheck
+    - structcheck
+    - typecheck
+    - unused
+    - varcheck

README.md

@@ -1,6 +1,10 @@
 The grailbio/base project includes all the packages used by many
 other grailbio Go packages:
 
+- API documentation: [godoc.org/github.com/grailbio/base](https://godoc.org/github.com/grailbio/base)
+- Issue tracker: [github.com/grailbio/base/issues](https://github.com/grailbio/base/issues)
+- [![CI](https://github.com/grailbio/base/workflows/CI/badge.svg)](https://github.com/grailbio/base/actions?query=workflow%3ACI)
+
 - [recordio](https://godoc.org/github.com/grailbio/base/recordio): encrypted and compressed record oriented files with indexing support
 - [file](https://godoc.org/github.com/grailbio/base/file): unified file API for the local file system and S3
 - [digest](https://godoc.org/github.com/grailbio/base/digest): common in-memory and serialized representation of digests
@@ -12,4 +16,9 @@ other grailbio Go packages:
 - [syncqueue](https://godoc.org/github.com/grailbio/base/syncqueue): various flavors of producer-consumer queues
 - [unsafe](https://godoc.org/github.com/grailbio/base/unsafe): conversion from []byte to string, etc.
 - [compress/libdeflate](https://godoc.org/github.com/grailbio/base/compress/libdeflate): efficient block compression/decompression
+- [bitset](https://godoc.org/github.com/grailbio/base/bitset): []uintptr bitset support
 - [simd](https://godoc.org/github.com/grailbio/base/simd): fast operations on []byte
+- [tsv](https://godoc.org/github.com/grailbio/base/tsv): simple and efficient TSV writer
+- [cloud/spotadvisor](https://godoc.org/github.com/grailbio/base/cloud/spotadvisor): provides an interface for fetching and utilizing AWS Spot Advisor data
+- [cloud/spotfeed](https://godoc.org/github.com/grailbio/base/cloud/spotfeed): provides interfaces for interacting with the AWS spot data feed format for files hosted on S3
+