Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update CI and add badges to README #21

Merged
merged 5 commits into from
Mar 30, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Update CI and add badges to README
CI updates:

- Update Go versions (1.17.x and 1.18.x)
- Update actions versions
- Use actions for staticcheck
- Drop golint (deprecated)
- Report test coverage
  • Loading branch information
ChrisHines committed Mar 20, 2022
commit 24cd39e027d1f148a7b0c9362b0b8082c5575b5a
45 changes: 28 additions & 17 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -1,38 +1,49 @@
on: push
on:
push:
pull_request:
types: [synchronize]
peterbourgon marked this conversation as resolved.
Show resolved Hide resolved
name: Test
jobs:
test:
strategy:
fail-fast: false
matrix:
go-version: [1.16.x, 1.17.x]
go-version: [1.17.x, 1.18.x]
ChrisHines marked this conversation as resolved.
Show resolved Hide resolved
platform: [ubuntu-latest, macos-latest, windows-latest]
runs-on: ${{ matrix.platform }}
steps:
- name: Checkout code
uses: actions/checkout@v2
- name: Install Go
uses: actions/setup-go@v1
uses: actions/setup-go@v2
with:
go-version: ${{ matrix.go-version }}
- name: Install staticcheck
run: go install honnef.co/go/tools/cmd/staticcheck@latest
shell: bash
- name: Install golint
run: go install golang.org/x/lint/golint@latest
shell: bash
- name: Update PATH
run: echo "$(go env GOPATH)/bin" >> $GITHUB_PATH
shell: bash
- name: Checkout code
uses: actions/checkout@v1
- name: Fmt
if: matrix.platform != 'windows-latest' # :(
run: "diff <(gofmt -d .) <(printf '')"
shell: bash
- name: Vet
run: go vet ./...
- name: Staticcheck
run: staticcheck ./...
- name: Lint
run: golint ./...
ChrisHines marked this conversation as resolved.
Show resolved Hide resolved
uses: dominikh/staticcheck-action@v1
with:
install-go: false
cache-key: ${{ matrix.go-version }}
- name: Test
run: go test -race ./...
- name: Test coverage
run: go test -coverprofile="cover.out" ./... # quotes needed for powershell
- name: Send coverage
uses: shogo82148/actions-goveralls@v1
with:
path-to-profile: cover.out
flag-name: go${{ matrix.go-version }}-${{ matrix.os }}
parallel: true
peterbourgon marked this conversation as resolved.
Show resolved Hide resolved
# notifies that all test jobs are finished.
finish:
needs: test
runs-on: ubuntu-latest
steps:
- uses: shogo82148/actions-goveralls@v1
with:
parallel-finished: true
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# package log

[![Go Reference](https://pkg.go.dev/badge/github.com/go-kit/log.svg)](https://pkg.go.dev/github.com/go-kit/log)
[![Go Report Card](https://goreportcard.com/badge/go-kit/log)](https://goreportcard.com/report/go-kit/log)
[![Github Actions](https://github.com/go-kit/log/actions/workflows/test.yml/badge.svg)](https://github.com/go-kit/log/actions/workflows/test.yml)
ChrisHines marked this conversation as resolved.
Show resolved Hide resolved
[![Coverage Status](https://coveralls.io/repos/github/go-kit/log/badge.svg?branch=master)](https://coveralls.io/github/go-kit/log?branch=main)
ChrisHines marked this conversation as resolved.
Show resolved Hide resolved

`package log` provides a minimal interface for structured logging in services.
It may be wrapped to encode conventions, enforce type-safety, provide leveled
logging, and so on. It can be used for both typical application log events,
Expand Down