Skip to content

Update readme

Update readme #62

Workflow file for this run

name: CI
on:
pull_request:
push:
branches:
- main
jobs:
pr-checks:
name: PR Checks
if: github.event_name == 'pull_request'
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Set up Go
uses: actions/setup-go@v5
with:
go-version: "1.24.5"
cache: true
- name: Check gofmt
run: |
unformatted=$(gofmt -l .)
if [ -n "$unformatted" ]; then
echo "gofmt needed:"
echo "$unformatted"
exit 1
fi
- name: Run tests
run: go test ./...
coverage:
name: Test and Coverage
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Set up Go
uses: actions/setup-go@v5
with:
go-version: "1.24.5"
cache: true
- name: Check gofmt
run: |
unformatted=$(gofmt -l .)
if [ -n "$unformatted" ]; then
echo "gofmt needed:"
echo "$unformatted"
exit 1
fi
- name: Run tests with coverage
run: |
go test ./... -coverprofile=coverage.out -covermode=atomic -coverpkg=./...
test -f coverage.out
go tool cover -func=coverage.out > coverage.txt
- name: Upload coverage to Codecov
uses: codecov/codecov-action@v5
with:
files: coverage.out
fail_ci_if_error: true
verbose: true
token: ${{ secrets.CODECOV_TOKEN }}
- name: Upload coverage artifacts
uses: actions/upload-artifact@v4
with:
name: coverage
path: |
coverage.out
coverage.txt