Merge pull request #237 from nhooyr/ci

Back to GH Actions

Author: nhooyr

.github/workflows/ci.yaml

@@ -0,0 +1,39 @@
+name: ci
+
+on: [push, pull_request]
+
+jobs:
+  fmt:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - name: Run ./ci/fmt.sh
+        uses: ./ci/container
+        with:
+          args: ./ci/fmt.sh
+
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - name: Run ./ci/lint.sh
+        uses: ./ci/container
+        with:
+          args: ./ci/lint.sh
+
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - name: Run ./ci/test.sh
+        uses: ./ci/container
+        with:
+          args: ./ci/test.sh
+        env:
+          NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
+          NETLIFY_SITE_ID: 9b3ee4dc-8297-4774-b4b9-a61561fbbce7
+      - name: Upload coverage.html
+        uses: actions/upload-artifact@v2
+        with:
+          name: coverage.html
+          path: ./ci/out/coverage.html

.travis.yml

@@ -1,6 +1,7 @@
 # websocket
 
 [![godoc](https://godoc.org/nhooyr.io/websocket?status.svg)](https://pkg.go.dev/nhooyr.io/websocket)
+[![coverage](https://img.shields.io/badge/coverage-88%25-success)](https://nhooyrio-websocket-coverage.netlify.app)
 
 websocket is a minimal and idiomatic WebSocket library for Go.
 
@@ -10,12 +11,11 @@ websocket is a minimal and idiomatic WebSocket library for Go.
 go get nhooyr.io/websocket
 ```
 
-## Features
+## Highlights
 
 - Minimal and idiomatic API
 - First class [context.Context](https://blog.golang.org/context) support
 - Fully passes the WebSocket [autobahn-testsuite](https://github.com/crossbario/autobahn-testsuite)
-- Thorough tests with [90% coverage](https://coveralls.io/github/nhooyr/websocket)
 - [Single dependency](https://pkg.go.dev/nhooyr.io/websocket?tab=imports)
 - JSON and protobuf helpers in the [wsjson](https://pkg.go.dev/nhooyr.io/websocket/wsjson) and [wspb](https://pkg.go.dev/nhooyr.io/websocket/wspb) subpackages
 - Zero alloc reads and writes

Makefile

@@ -0,0 +1,14 @@
+FROM golang
+
+RUN apt-get update
+RUN apt-get install -y npm shellcheck chromium
+
+ENV GO111MODULE=on
+RUN go get golang.org/x/tools/cmd/goimports
+RUN go get mvdan.cc/sh/v3/cmd/shfmt
+RUN go get golang.org/x/tools/cmd/stringer
+RUN go get golang.org/x/lint/golint
+RUN go get github.com/agnivade/wasmbrowsertest
+
+RUN npm install -g prettier
+RUN npm install -g netlify-cli

README.md

@@ -0,0 +1,38 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+main() {
+  cd "$(dirname "$0")/.."
+
+  go mod tidy
+  gofmt -w -s .
+  goimports -w "-local=$(go list -m)" .
+
+  prettier \
+    --write \
+    --print-width=120 \
+    --no-semi \
+    --trailing-comma=all \
+    --loglevel=warn \
+    --arrow-parens=avoid \
+    $(git ls-files "*.yml" "*.md" "*.js" "*.css" "*.html")
+  shfmt -i 2 -w -s -sr $(git ls-files "*.sh")
+
+  stringer -type=opcode,MessageType,StatusCode -output=stringer.go
+
+  if [[ ${CI-} ]]; then
+    ensure_fmt
+  fi
+}
+
+ensure_fmt() {
+  if [[ $(git ls-files --other --modified --exclude-standard) ]]; then
+    git -c color.ui=always --no-pager diff
+    echo
+    echo "Please run the following locally:"
+    echo "  ./ci/fmt.sh"
+    exit 1
+  fi
+}
+
+main "$@"

ci/container/Dockerfile

@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+main() {
+  cd "$(dirname "$0")/.."
+
+  go vet ./...
+  GOOS=js GOARCH=wasm go vet ./...
+
+  golint -set_exit_status ./...
+  GOOS=js GOARCH=wasm golint -set_exit_status ./...
+
+  shellcheck --exclude=SC2046 $(git ls-files "*.sh")
+}
+
+main "$@"