buildnote collect

Collects events such as test results and build tool events

Usage

buildnote collect <options>

Options

--tag

Adds a tag to every collected event.

Example:

shell

--tag "Unit Tests"

To add several tags, repeat the option.

Example with several tags:

shell

--tag "Unit Tests" --tag "All Tests"

Values: value

--timeout

Maximum time, in seconds, to wait for the collection job to finish. If you don't set it, the command returns immediately without waiting.

Values: int

--org

Organisation identifier

Values: value

--project

Project identifier

Values: value

--module

Module identifier

Values: value

--build

Build identifier

Values: value

--sha

Commit SHA for the upload, such as 58e53b26ced5fffc72ba5427535e7b5867950b13

Values: value

--ref

Commit ref for the upload, such as refs/heads/main

Values: value

-h, --help

Show this message and exit

JUnit Collector

Options for the JUnit collector.

--junit-enabled

Turns the JUnit collector on or off.

Example:

shell

--junit-enabled true

This flag overrides the collect.junit.enabled value in the buildnote.json config file.

Values: [true|false]

--junit-include

Glob pattern for the files to include.

Example that includes nested files:

shell

--junit-include "**/file-*.xml"

Example with several patterns:

shell

--junit-include "**/file-*.xml" --junit-include "another-file.txt"

Patterns you pass here are added to the collect.junit.include values in the buildnote.json config file.

Values: text

--junit-exclude

Glob pattern for the files to exclude.

Example that excludes nested directories:

shell

--junit-exclude "**/out"

Example with several patterns:

shell

--junit-exclude "**/out" --junit-exclude "build"

Patterns you pass here are added to the collect.junit.exclude values in the buildnote.json config file.

Values: text

--junit-metadata

Extra metadata to attach to the collected events.

Example with several metadata items:

shell

--junit-metadata user="$USER" --junit-metadata host="$HOST"

Metadata you pass here is added to the collect.junit.metadata values in the buildnote.json config file.

Values: value

TestNG Collector

Options for the TestNG collector.

--testng-enabled

Turns the TestNG collector on or off.

Example:

shell

--testng-enabled true

This flag overrides the collect.testng.enabled value in the buildnote.json config file.

Values: [true|false]

--testng-include

Glob pattern for the files to include.

Example that includes nested files:

shell

--testng-include "**/file-*.xml"

Example with several patterns:

shell

--testng-include "**/file-*.xml" --testng-include "another-file.txt"

Patterns you pass here are added to the collect.testng.include values in the buildnote.json config file.

Values: text

--testng-exclude

Glob pattern for the files to exclude.

Example that excludes nested directories:

shell

--testng-exclude "**/out"

Example with several patterns:

shell

--testng-exclude "**/out" --testng-exclude "build"

Patterns you pass here are added to the collect.testng.exclude values in the buildnote.json config file.

Values: text

--testng-metadata

Extra metadata to attach to the collected events.

Example with several metadata items:

shell

--testng-metadata user="$USER" --testng-metadata host="$HOST"

Metadata you pass here is added to the collect.testng.metadata values in the buildnote.json config file.

Values: value

Cucumber Collector

Options for the Cucumber collector.

--cucumber-enabled

Turns the Cucumber collector on or off.

Example:

shell

--cucumber-enabled true

This flag overrides the collect.cucumber.enabled value in the buildnote.json config file.

Values: [true|false]

--cucumber-include

Glob pattern for the files to include.

Example that includes nested files:

shell

--cucumber-include "**/file-*.xml"

Example with several patterns:

shell

--cucumber-include "**/file-*.xml" --cucumber-include "another-file.txt"

Patterns you pass here are added to the collect.cucumber.include values in the buildnote.json config file.

Values: text

--cucumber-exclude

Glob pattern for the files to exclude.

Example that excludes nested directories:

shell

--cucumber-exclude "**/out"

Example with several patterns:

shell

--cucumber-exclude "**/out" --cucumber-exclude "build"

Patterns you pass here are added to the collect.cucumber.exclude values in the buildnote.json config file.

Values: text

--cucumber-metadata

Extra metadata to attach to the collected events.

Example with several metadata items:

shell

--cucumber-metadata user="$USER" --cucumber-metadata host="$HOST"

Metadata you pass here is added to the collect.cucumber.metadata values in the buildnote.json config file.

Values: value

Dart/Flutter Collector

Options for the Dart/Flutter collector.

--dart-enabled

Turns the Dart/Flutter collector on or off.

Example:

shell

--dart-enabled true

This flag overrides the collect.dart.enabled value in the buildnote.json config file.

Values: [true|false]

--dart-include

Glob pattern for the files to include.

Example that includes nested files:

shell

--dart-include "**/file-*.xml"

Example with several patterns:

shell

--dart-include "**/file-*.xml" --dart-include "another-file.txt"

Patterns you pass here are added to the collect.dart.include values in the buildnote.json config file.

Values: text

--dart-exclude

Glob pattern for the files to exclude.

Example that excludes nested directories:

shell

--dart-exclude "**/out"

Example with several patterns:

shell

--dart-exclude "**/out" --dart-exclude "build"

Patterns you pass here are added to the collect.dart.exclude values in the buildnote.json config file.

Values: text

--dart-metadata

Extra metadata to attach to the collected events.

Example with several metadata items:

shell

--dart-metadata user="$USER" --dart-metadata host="$HOST"

Metadata you pass here is added to the collect.dart.metadata values in the buildnote.json config file.

Values: value

NUnit Collector

Options for the NUnit collector.

--nunit-enabled

Turns the NUnit collector on or off.

Example:

shell

--nunit-enabled true

This flag overrides the collect.nunit.enabled value in the buildnote.json config file.

Values: [true|false]

--nunit-include

Glob pattern for the files to include.

Example that includes nested files:

shell

--nunit-include "**/file-*.xml"

Example with several patterns:

shell

--nunit-include "**/file-*.xml" --nunit-include "another-file.txt"

Patterns you pass here are added to the collect.nunit.include values in the buildnote.json config file.

Values: text

--nunit-exclude

Glob pattern for the files to exclude.

Example that excludes nested directories:

shell

--nunit-exclude "**/out"

Example with several patterns:

shell

--nunit-exclude "**/out" --nunit-exclude "build"

Patterns you pass here are added to the collect.nunit.exclude values in the buildnote.json config file.

Values: text

--nunit-metadata

Extra metadata to attach to the collected events.

Example with several metadata items:

shell

--nunit-metadata user="$USER" --nunit-metadata host="$HOST"

Metadata you pass here is added to the collect.nunit.metadata values in the buildnote.json config file.

Values: value

XUnit Collector

Options for the XUnit collector.

--xunit-enabled

Turns the XUnit collector on or off.

Example:

shell

--xunit-enabled true

This flag overrides the collect.xunit.enabled value in the buildnote.json config file.

Values: [true|false]

--xunit-include

Glob pattern for the files to include.

Example that includes nested files:

shell

--xunit-include "**/file-*.xml"

Example with several patterns:

shell

--xunit-include "**/file-*.xml" --xunit-include "another-file.txt"

Patterns you pass here are added to the collect.xunit.include values in the buildnote.json config file.

Values: text

--xunit-exclude

Glob pattern for the files to exclude.

Example that excludes nested directories:

shell

--xunit-exclude "**/out"

Example with several patterns:

shell

--xunit-exclude "**/out" --xunit-exclude "build"

Patterns you pass here are added to the collect.xunit.exclude values in the buildnote.json config file.

Values: text

--xunit-metadata

Extra metadata to attach to the collected events.

Example with several metadata items:

shell

--xunit-metadata user="$USER" --xunit-metadata host="$HOST"

Metadata you pass here is added to the collect.xunit.metadata values in the buildnote.json config file.

Values: value

CTRF Collector

Options for the CTRF collector.

--ctrf-enabled

Turns the CTRF collector on or off.

Example:

shell

--ctrf-enabled true

This flag overrides the collect.ctrf.enabled value in the buildnote.json config file.

Values: [true|false]

--ctrf-include

Glob pattern for the files to include.

Example that includes nested files:

shell

--ctrf-include "**/file-*.xml"

Example with several patterns:

shell

--ctrf-include "**/file-*.xml" --ctrf-include "another-file.txt"

Patterns you pass here are added to the collect.ctrf.include values in the buildnote.json config file.

Values: text

--ctrf-exclude

Glob pattern for the files to exclude.

Example that excludes nested directories:

shell

--ctrf-exclude "**/out"

Example with several patterns:

shell

--ctrf-exclude "**/out" --ctrf-exclude "build"

Patterns you pass here are added to the collect.ctrf.exclude values in the buildnote.json config file.

Values: text

--ctrf-metadata

Extra metadata to attach to the collected events.

Example with several metadata items:

shell

--ctrf-metadata user="$USER" --ctrf-metadata host="$HOST"

Metadata you pass here is added to the collect.ctrf.metadata values in the buildnote.json config file.

Values: value

TRX Collector

Options for the TRX collector.

--trx-enabled

Turns the TRX collector on or off.

Example:

shell

--trx-enabled true

This flag overrides the collect.trx.enabled value in the buildnote.json config file.

Values: [true|false]

--trx-include

Glob pattern for the files to include.

Example that includes nested files:

shell

--trx-include "**/file-*.xml"

Example with several patterns:

shell

--trx-include "**/file-*.xml" --trx-include "another-file.txt"

Patterns you pass here are added to the collect.trx.include values in the buildnote.json config file.

Values: text

--trx-exclude

Glob pattern for the files to exclude.

Example that excludes nested directories:

shell

--trx-exclude "**/out"

Example with several patterns:

shell

--trx-exclude "**/out" --trx-exclude "build"

Patterns you pass here are added to the collect.trx.exclude values in the buildnote.json config file.

Values: text

--trx-metadata

Extra metadata to attach to the collected events.

Example with several metadata items:

shell

--trx-metadata user="$USER" --trx-metadata host="$HOST"

Metadata you pass here is added to the collect.trx.metadata values in the buildnote.json config file.

Values: value

Robot Framework Collector

Options for the Robot Framework collector.

--robot-enabled

Turns the Robot Framework collector on or off.

Example:

shell

--robot-enabled true

This flag overrides the collect.robot.enabled value in the buildnote.json config file.

Values: [true|false]

--robot-include

Glob pattern for the files to include.

Example that includes nested files:

shell

--robot-include "**/file-*.xml"

Example with several patterns:

shell

--robot-include "**/file-*.xml" --robot-include "another-file.txt"

Patterns you pass here are added to the collect.robot.include values in the buildnote.json config file.

Values: text

--robot-exclude

Glob pattern for the files to exclude.

Example that excludes nested directories:

shell

--robot-exclude "**/out"

Example with several patterns:

shell

--robot-exclude "**/out" --robot-exclude "build"

Patterns you pass here are added to the collect.robot.exclude values in the buildnote.json config file.

Values: text

--robot-metadata

Extra metadata to attach to the collected events.

Example with several metadata items:

shell

--robot-metadata user="$USER" --robot-metadata host="$HOST"

Metadata you pass here is added to the collect.robot.metadata values in the buildnote.json config file.

Values: value

QT Test Collector

Options for the QT Test collector.

--qt-enabled

Turns the QT Test collector on or off.

Example:

shell

--qt-enabled true

This flag overrides the collect.qt.enabled value in the buildnote.json config file.

Values: [true|false]

--qt-include

Glob pattern for the files to include.

Example that includes nested files:

shell

--qt-include "**/file-*.xml"

Example with several patterns:

shell

--qt-include "**/file-*.xml" --qt-include "another-file.txt"

Patterns you pass here are added to the collect.qt.include values in the buildnote.json config file.

Values: text

--qt-exclude

Glob pattern for the files to exclude.

Example that excludes nested directories:

shell

--qt-exclude "**/out"

Example with several patterns:

shell

--qt-exclude "**/out" --qt-exclude "build"

Patterns you pass here are added to the collect.qt.exclude values in the buildnote.json config file.

Values: text

--qt-metadata

Extra metadata to attach to the collected events.

Example with several metadata items:

shell

--qt-metadata user="$USER" --qt-metadata host="$HOST"

Metadata you pass here is added to the collect.qt.metadata values in the buildnote.json config file.

Values: value

Open Test Reporting Collector

Options for the Open Test Reporting collector.

--otr-enabled

Turns the Open Test Reporting collector on or off.

Example:

shell

--otr-enabled true

This flag overrides the collect.otr.enabled value in the buildnote.json config file.

Values: [true|false]

--otr-include

Glob pattern for the files to include.

Example that includes nested files:

shell

--otr-include "**/file-*.xml"

Example with several patterns:

shell

--otr-include "**/file-*.xml" --otr-include "another-file.txt"

Patterns you pass here are added to the collect.otr.include values in the buildnote.json config file.

Values: text

--otr-exclude

Glob pattern for the files to exclude.

Example that excludes nested directories:

shell

--otr-exclude "**/out"

Example with several patterns:

shell

--otr-exclude "**/out" --otr-exclude "build"

Patterns you pass here are added to the collect.otr.exclude values in the buildnote.json config file.

Values: text

--otr-metadata

Extra metadata to attach to the collected events.

Example with several metadata items:

shell

--otr-metadata user="$USER" --otr-metadata host="$HOST"

Metadata you pass here is added to the collect.otr.metadata values in the buildnote.json config file.

Values: value

Files Collector

Options for the Files collector.

--files-enabled

Turns the Files collector on or off.

Example:

shell

--files-enabled true

This flag overrides the collect.files.enabled value in the buildnote.json config file.

Values: [true|false]

--files-include

Glob pattern for the files to include.

Example that includes nested files:

shell

--files-include "**/file-*.xml"

Example with several patterns:

shell

--files-include "**/file-*.xml" --files-include "another-file.txt"

Patterns you pass here are added to the collect.files.include values in the buildnote.json config file.

Values: text

--files-exclude

Glob pattern for the files to exclude.

Example that excludes nested directories:

shell

--files-exclude "**/out"

Example with several patterns:

shell

--files-exclude "**/out" --files-exclude "build"

Patterns you pass here are added to the collect.files.exclude values in the buildnote.json config file.

Values: text

--files-metadata

Extra metadata to attach to the collected events.

Example with several metadata items:

shell

--files-metadata user="$USER" --files-metadata host="$HOST"

Metadata you pass here is added to the collect.files.metadata values in the buildnote.json config file.

Values: value