Skip to content

Commit

Permalink
Add CI testing for PRs
Browse files Browse the repository at this point in the history
Add a GitHub actions workflow to run our tests when a PR is proposed
or updated.

Update Makefile's .PHONY list to include all of our targets.

Update README.md with instructions on how to run tests and update some
stale text.

Closes: #13
  • Loading branch information
rtamalin committed Jun 5, 2024
1 parent a32fb22 commit 7773a7f
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 3 deletions.
23 changes: 23 additions & 0 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---

name: Run Pull Request CI Verification

on:
pull_request:
branches:
- main

jobs:
tests:
runs-on: ubuntu-latest
container:
image: registry.suse.com/bci/golang:1.21-openssl

steps:
- name: Checkout PR sources
uses: actions/checkout@v4
with:
path: telemetry

- name: Run tests in verbose mode
run: cd telemetry && make test-verbose
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.DEFAULT_GOAL := build

.PHONY: fmt vet build test
.PHONY: fmt vet build clean test test-verbose

fmt:
go fmt ./...
Expand Down
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# telemetry
Proof of Concept Telemetry scaffolding
SUSE Telemetry Client Library and associated client CLI tools

# What's available

Expand Down Expand Up @@ -35,7 +35,17 @@ The pkg/types module defined useful common types
The pkg/lib module provides functionality for managing the local staging
of data items, bundles and reports.

# Testing

The tests can be run from within the telemetry repo as follows:

```
% cd telemetry
% make test
```


# See Also
See the companion telemetry-server repo for a basic implementation of
a telemetry server to handle the requests generated by the telemetry
client tools.
client tools.

0 comments on commit 7773a7f

Please sign in to comment.