From e81ac61baefb78271b8d8d5aec9753bb4859083a Mon Sep 17 00:00:00 2001 From: Isaac Zinda Date: Fri, 30 Aug 2019 09:11:40 -0700 Subject: [PATCH] add tests caveat --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 0d6a9f5..e89d0f6 100644 --- a/README.md +++ b/README.md @@ -95,3 +95,7 @@ return lightstep.Tracer( ``` This library is the LightStep binding for [OpenTracing](http://opentracing.io/). See the [OpenTracing Python API](https://github.com/opentracing/opentracing-python) for additional detail. + +## Testing + +The LightStep Python Tracer is performance tested in CI using [LightStep Benchmarks](https://github.com/lightstep/lightstep-benchmarks). Performance regression tests are run automatically every commit, and performance graphs can be generated with manual approval. **This repo will show a yellow dot for CI test status even when all of the automatic tests have run. Because LightStep Benchmarks performance graphs are only generated after manual approval and CircleCI counts them as "running" before they've been approved, you won't see a green status check mark unless you've manually approved performance graph generation.**