Skip to content

Commit 8857b05

Browse files
committed
update Testream documentation
1 parent 2d69536 commit 8857b05

14 files changed

Lines changed: 146 additions & 22 deletions

File tree

docs/intro.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,18 @@
11
---
22
sidebar_position: 1
3+
title: Introduction
4+
description: Learn how Testream sends automated test results from CI/CD into Jira with reporters, CTRF uploads, artifacts, and release visibility.
5+
keywords:
6+
- jira test reporting docs
7+
- automated test reporting jira
8+
- ci cd test results jira
39
---
410

511
# Introduction
612

713
Welcome to **Testream**, code-first automated test reporting for Jira teams.
814

9-
Testream brings automated test evidence from your codebase and CI/CD pipeline into Jira, without requiring teams to recreate every automated test as a manual Jira test case.
15+
Testream brings automated test results from CI/CD into Jira so teams can review pass rate, failures, artifacts, branch and commit context, suite changes, and release readiness without creating a separate manual test-case layer.
1016

1117
## What is Testream?
1218

docs/reporters/cli.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,18 @@
11
---
22
sidebar_position: 6
3+
title: 'CLI Reporter'
4+
description: 'Upload CTRF test reports to Testream and Jira from GitHub Actions, CircleCI, Bitbucket Pipelines, Jenkins, GitLab, or any custom CI.'
5+
keywords:
6+
- ctrf upload jira
7+
- cli test reporting jira
8+
- upload test results to jira from ci
39
---
410

511
# CLI Reporter
612

7-
Upload CTRF test reports to Testream from any CI provider using the CLI.
13+
Upload CTRF test reports to Testream from any CI provider with the CLI, then review the results in Jira with branch, commit, build, environment, and artifact context.
14+
15+
If you are evaluating the product path first, start with the website page for [CI/CD test results in Jira](https://testream.app/ci-test-results-jira).
816

917
## What you need
1018

docs/reporters/cypress.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,18 @@
11
---
22
sidebar_position: 3
3+
title: 'Cypress Reporter'
4+
description: 'Send Cypress test results, screenshots, videos, and end-to-end artifacts into Jira with the Testream Cypress Reporter.'
5+
keywords:
6+
- cypress jira reporter
7+
- cypress test reporting jira
8+
- cypress component testing jira
39
---
410

511
# Cypress Reporter
612

7-
The Testream Cypress Reporter runs your Cypress tests and automatically uploads test results to Testream. You can use it as a CLI tool or integrate it directly into your Cypress configuration.
13+
Use the Testream Cypress Reporter to send Cypress test results, screenshots, videos, and CI/CD run context into Testream and Jira.
14+
15+
Looking for the commercial overview first? Read the website page for [Cypress Jira integration](https://testream.app/cypress-jira-integration).
816

917
## Installation
1018

@@ -25,7 +33,7 @@ npx @testream/cypress-reporter -k $TESTREAM_API_KEY
2533
This single command will:
2634

2735
1. Run your Cypress tests
28-
2. Generate a CTRF report automatically
36+
2. Prepare uploadable results automatically
2937
3. Upload results to Testream (project key inferred from API key)
3038

3139
### Option 2: Programmatic Configuration

docs/reporters/dotnet.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,20 @@
11
---
22
sidebar_position: 2
3+
title: '.NET Reporter'
4+
description: 'Send xUnit, NUnit, MSTest, and TRX-based test results from CI/CD into Jira with the Testream .NET Reporter.'
5+
keywords:
6+
- dotnet jira reporter
7+
- xunit jira reporting
8+
- nunit jira reporting
9+
- mstest jira reporting
10+
- trx jira reporting
311
---
412

513
# .NET Reporter
614

7-
The Testream .NET Reporter runs your tests (or reads existing TRX files), converts results to CTRF, and uploads them to Testream.
15+
Use the Testream .NET Reporter to send xUnit, NUnit, MSTest, and TRX-based test results from CI/CD into Testream and Jira.
16+
17+
Looking for the higher-level product fit first? Read the website page for [.NET Jira integration](https://testream.app/dotnet-jira-integration).
818

919
## Installation
1020

@@ -25,7 +35,7 @@ npx @testream/dotnet-reporter -k $TESTREAM_API_KEY
2535
This single command will:
2636

2737
1. Run `dotnet test`
28-
2. Generate a CTRF report
38+
2. Convert the results automatically
2939
3. Upload to Testream (project key inferred from API key)
3040

3141
## CLI Options

docs/reporters/jest.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,18 @@
11
---
22
sidebar_position: 4
3+
title: 'Jest Reporter'
4+
description: 'Send Jest test results from CI/CD into Jira with the Testream Jest Reporter and review failures and trends in Testream.'
5+
keywords:
6+
- jest jira reporter
7+
- jest test reporting jira
8+
- jest ci results jira
39
---
410

511
# Jest Reporter
612

7-
The Testream Jest Reporter generates and uploads Jest test results to Testream from your existing Jest configuration.
13+
Use the Testream Jest Reporter to send Jest unit and integration test results from CI/CD into Testream and Jira.
14+
15+
Looking for the higher-level product fit first? Read the website page for [Jest Jira integration](https://testream.app/jest-jira-integration).
816

917
## Installation
1018

docs/reporters/junit.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,19 @@
11
---
22
sidebar_position: 7
3+
title: 'JUnit Reporter'
4+
description: 'Upload JUnit XML test results from Java CI/CD pipelines into Jira with the Testream JUnit Reporter.'
5+
keywords:
6+
- junit jira reporter
7+
- java junit jira
8+
- maven surefire jira reporting
9+
- gradle junit jira
310
---
411

512
# JUnit Reporter
613

7-
The Testream JUnit Reporter converts JUnit XML into a CTRF report and uploads the results to Testream.
14+
Use the Testream JUnit Reporter to convert JUnit XML output from CI/CD and send Java test results into Testream and Jira.
15+
16+
Looking for the commercial overview first? Read the website page for [JUnit Jira integration](https://testream.app/junit-jira-integration).
817

918
## Installation
1019

docs/reporters/mocha.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,18 @@
11
---
22
sidebar_position: 9
3+
title: 'Mocha Reporter'
4+
description: 'Send Mocha test results from CI/CD into Jira with the Testream Mocha Reporter and built-in upload support.'
5+
keywords:
6+
- mocha jira reporter
7+
- mocha test reporting jira
8+
- node mocha jira
39
---
410

511
# Mocha Reporter
612

7-
The Testream Mocha Reporter generates CTRF test reports from Mocha and uploads them to Testream.
13+
Use the Testream Mocha Reporter to send Mocha test results from CI/CD into Testream and Jira with built-in upload support.
14+
15+
Looking for the commercial overview first? Read the website page for [Mocha Jira integration](https://testream.app/mocha-jira-integration).
816

917
## Installation
1018

docs/reporters/playwright.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,18 @@
11
---
22
sidebar_position: 1
3+
title: 'Playwright Reporter'
4+
description: 'Send Playwright test results, traces, screenshots, and videos into Jira with the Testream Playwright Reporter.'
5+
keywords:
6+
- playwright jira reporter
7+
- playwright test reporting jira
8+
- playwright ci results jira
39
---
410

511
# Playwright Reporter
612

7-
The Testream Playwright Reporter generates CTRF reports and uploads test results (plus artifacts) to Testream.
13+
Use the Testream Playwright Reporter to send Playwright test results, screenshots, videos, and traces into Testream and Jira.
14+
15+
Looking for the commercial overview first? Read the website page for [Playwright Jira integration](https://testream.app/playwright-jira-integration).
816

917
## Installation
1018

docs/reporters/pytest.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,19 @@
11
---
22
sidebar_position: 10
3+
title: 'Pytest Reporter'
4+
description: 'Send Pytest and JUnit-based Python test results from CI/CD into Jira with the Testream Pytest Reporter.'
5+
keywords:
6+
- pytest jira reporter
7+
- python pytest jira
8+
- django pytest jira
9+
- fastapi pytest jira
310
---
411

512
# Pytest Reporter
613

7-
The Testream Pytest Reporter runs your Pytest suite (or ingests existing JUnit XML), converts results to CTRF, and uploads them to Testream.
14+
Use the Testream Pytest Reporter to send Pytest and JUnit-based Python test results from CI/CD into Testream and Jira.
15+
16+
Looking for the commercial overview first? Read the website page for [Pytest Jira integration](https://testream.app/pytest-jira-integration).
817

918
## Installation
1019

@@ -26,7 +35,7 @@ This single command will:
2635

2736
1. Run `pytest`
2837
2. Write JUnit XML to `junit/pytest-junit.xml`
29-
3. Convert to CTRF and upload to Testream
38+
3. Convert the results automatically and upload to Testream
3039

3140
For a full end-to-end repository example (project layout, intentional failures, and CI setup), see the **Sample Project** section below.
3241

docs/reporters/vitest.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,18 @@
11
---
22
sidebar_position: 8
3+
title: 'Vitest Reporter'
4+
description: 'Send Vitest test results from CI/CD into Jira with the Testream Vitest Reporter and run metadata.'
5+
keywords:
6+
- vitest jira reporter
7+
- vitest test reporting jira
8+
- vitest ci results jira
39
---
410

511
# Vitest Reporter
612

7-
The Testream Vitest Reporter generates a CTRF report from your Vitest test run and uploads the results to Testream.
13+
Use the Testream Vitest Reporter to send Vitest test results from CI/CD into Testream and Jira with run metadata and CI-friendly uploads.
14+
15+
Looking for the broader use case? Read the website page for [Vitest Jira integration](https://testream.app/vitest-jira-integration).
816

917
## Installation
1018

0 commit comments

Comments
 (0)