fixup! Add tracing and relevant tests (#21) #64
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
name: Run tests on PR | |
on: | |
pull_request: | |
branches: | |
- "main" | |
push: | |
paths-ignore: | |
- "**/**.md" | |
- "**/**.yaml" | |
- "static/**" | |
branches: | |
- "!main" | |
env: | |
GO_VERSION: ">=1.21" | |
permissions: | |
# deployments permission to deploy GitHub pages website | |
deployments: write | |
# contents permission to update benchmark contents in gh-pages branch | |
contents: write | |
jobs: | |
# This job is responsible for preparation of the build | |
# environment variables. | |
prepare: | |
name: Preparing build context | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout repo | |
uses: actions/checkout@v4 | |
- name: Install Go | |
uses: actions/setup-go@v5 | |
id: cache | |
with: | |
go-version: ${{env.GO_VERSION}} | |
cache-dependency-path: "**/*.sum" | |
- name: Go get dependencies | |
if: steps.cache.outputs.cache-hit != 'true' | |
run: | | |
go get ./... | |
# This job is responsible for running tests and linting the codebase | |
test: | |
name: "Unit testing" | |
# needs: [prepare] | |
runs-on: ubuntu-latest | |
container: golang:1 | |
# container: github/super-linter:v4 | |
needs: [prepare] | |
# services: | |
# # Label used to access the service container | |
# redis: | |
# # Docker Hub image | |
# image: redis | |
# # Set health checks to wait until redis has started | |
# options: >- | |
# --health-cmd "redis-cli ping" | |
# --health-interval 10s | |
# --health-timeout 5s | |
# --health-retries 5 | |
# ports: | |
# # Maps the container port to the host machine | |
# - 6379:6379 | |
steps: | |
- name: Checkout repository | |
uses: actions/checkout@v4 | |
- name: Install Go | |
uses: actions/setup-go@v5 | |
with: | |
go-version: ${{env.GO_VERSION}} | |
cache-dependency-path: "**/*.sum" | |
- name: Install dependencies | |
run: | | |
apt-get update | |
apt-get install ca-certificates make -y | |
update-ca-certificates | |
go mod tidy | |
git config --global --add safe.directory "$GITHUB_WORKSPACE" | |
- name: Run unit tests | |
run: | | |
CI_RUN=${CI} make test | |
- name: Run benchmark | |
run: | | |
go test -bench=. -benchmem ./... -run=^# | tee output.txt | |
- name: Store benchmark result | |
uses: benchmark-action/github-action-benchmark@v1 | |
with: | |
tool: "go" | |
output-file-path: output.txt | |
fail-on-alert: true | |
github-token: ${{ secrets.GITHUB_TOKEN }} | |
comment-on-alert: true | |
summary-always: true | |
# auto-push only if it's on main branch | |
auto-push: false | |
gh-pages-branch: "gh-pages" | |
benchmark-data-dir-path: "docs" |