github.com/testrecall/reporter@v0.2.3-0.20240102230324-a312dcb6d921/README.md (about)

     1  [![Build Status](https://github.com/TestRecall/reporter/workflows/CI/badge.svg?branch=main)](https://github.com/TestRecall/reporter/actions?query=workflow%3ACI)
     2  [![GitHub release](https://img.shields.io/github/release/TestRecall/reporter.svg)](https://github.com/TestRecall/reporter/releases/latest)
     3  [![license](https://img.shields.io/github/license/TestRecall/reporter.svg)](https://github.com/TestRecall/reporter/blob/master/LICENSE)
     4  
     5  
     6  # TestRecall Reporter
     7  
     8  This is a TestRecall command line for uploading test reports.
     9  
    10   - Downloads can be found under [releases][releases_url]
    11   - Documentation can be found [here][docs_url]
    12  
    13  
    14  ## Installation
    15  
    16  There are a few options for installing
    17  
    18  ### Recommended way:
    19  
    20  ```bash
    21  curl -fsSL https://get.testrecall.com/reporter | bash
    22  
    23  testrecall-reporter --version
    24  ```
    25  
    26  ### From the latest [releases][releases_url]:
    27  
    28  ```bash
    29  curl -fsSL -o testrecall-reporter \
    30    https://github.com/TestRecall/reporter/releases/download/v0.2.0/reporter_Linux_x86_64
    31  
    32  chmod +x testrecall-reporter
    33  
    34  ./testrecall-reporter --version
    35  ```
    36  
    37  ### From source:
    38  
    39  ```bash
    40  go get github.com/golangci/golangci-lint/cmd/golangci-lint@v0.2.0
    41  
    42  reporter --version
    43  ```
    44  
    45  ## Usage
    46  
    47  The TestRecall reporter uploads test results from your test suites. If your
    48  language can output a junit xml format test reports, running `testrecall-reporter`
    49  after your test results will upload the results.
    50  
    51  
    52  ```bash
    53  TR_UPLOAD_TOKEN=your_upload_token
    54  
    55  trap 'testrecall-reporter' EXIT
    56  
    57  npm run test # => output report.xml
    58  ```
    59  
    60  ### Configuration
    61  
    62  | flag  | environment | values | note
    63  |---    |---              |--- |---
    64  |`file`  |                 | \<glob\>      | file path or glob pattern for xml results, e.g. (`/tmp/report.xml`, or `build/*/junit*.xml`)
    65  |`multi` |                 | \<'before' \| 'multi' \| 'after'\>| enables multi-stage uploads, for suites that execute on multiple runners
    66  |       | `TR_UPLOAD_TOKEN` | \<string\>            | upload token for your test project
    67  
    68  The test reporter will pick up most configuration options by default, including common default locations for test reports.
    69  
    70  ## Compiling
    71  
    72  If you want to compile from source, you will need:
    73   - Go
    74   - Make
    75  
    76  
    77  To build, test, and compile a binary:
    78  ```bash
    79  make setup
    80  make test
    81  make build
    82  ```
    83  
    84  [releases_url]: https://github.com/TestRecall/reporter/releases
    85  [docs_url]: https://testrecall.com/docs