buildnote collect

Collects all events (e.g. test results, build tool events)

Usage

buildnote collect <options>

Options

--enabled

Specifies a list of enabled collection types

Values: (all|none|junit|nunit|xunit|testng|robot|cucumber|ctrf|trx|dart|qt|events|files|githubAction)

---

--tag

All collected events will be tagged with specified tags.

Example:

--tag "Unit Tests"

You can also specify multiple tags by repeating this option.

Example of multiple tags:

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

Values: text

---

--org

Organisation identifier

Values: value

---

--project

Project identifier

Values: value

---

--module

Module identifier

Values: value

---

--build

Build identifier

Values: value

---

--sha

Commit SHA associated with the upload (e.g: 58e53b26ced5fffc72ba5427535e7b5867950b13

Values: value

---

--ref

Commit Ref associated with the upload (e.g:refs/heads/main)

Values: value

---

-h, --help

Show this message and exit

---

JUnit Collector

Options for collecting junit events.

---

--junit-enabled

Enable or disable junit collector.

Example:

--junit-enabled true

This flag will replace collect.junit.enabled value set in buildnote.json config file.

Values: [true|false]

---

--junit-include

Glob pattern for files to include.

Example of including nested files:

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

Example of multiple includes:

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

This option will merge with collect.junit.include values set in buildnote.json config file.

Values: text

---

--junit-exclude

Glob pattern for files to exclude.

Example of excluding nested directories:

--junit-exclude "**/out"

Example of multiple excludes:

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

This option will merge with collect.junit.exclude values set in buildnote.json config file.

Values: text

---

--junit-metadata

Additional metadata associated with events.

Example of multiple metadata items:

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

This option will merge with collect.junit.metadata values set in buildnote.json config file.

Values: value

---

TestNG Collector

Options for collecting testng events.

---

--testng-enabled

Enable or disable testng collector.

Example:

--testng-enabled true

This flag will replace collect.testng.enabled value set in buildnote.json config file.

Values: [true|false]

---

--testng-include

Glob pattern for files to include.

Example of including nested files:

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

Example of multiple includes:

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

This option will merge with collect.testng.include values set in buildnote.json config file.

Values: text

---

--testng-exclude

Glob pattern for files to exclude.

Example of excluding nested directories:

--testng-exclude "**/out"

Example of multiple excludes:

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

This option will merge with collect.testng.exclude values set in buildnote.json config file.

Values: text

---

--testng-metadata

Additional metadata associated with events.

Example of multiple metadata items:

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

This option will merge with collect.testng.metadata values set in buildnote.json config file.

Values: value

---

Cucumber Collector

Options for collecting cucumber events.

---

--cucumber-enabled

Enable or disable cucumber collector.

Example:

--cucumber-enabled true

This flag will replace collect.cucumber.enabled value set in buildnote.json config file.

Values: [true|false]

---

--cucumber-include

Glob pattern for files to include.

Example of including nested files:

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

Example of multiple includes:

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

This option will merge with collect.cucumber.include values set in buildnote.json config file.

Values: text

---

--cucumber-exclude

Glob pattern for files to exclude.

Example of excluding nested directories:

--cucumber-exclude "**/out"

Example of multiple excludes:

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

This option will merge with collect.cucumber.exclude values set in buildnote.json config file.

Values: text

---

--cucumber-metadata

Additional metadata associated with events.

Example of multiple metadata items:

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

This option will merge with collect.cucumber.metadata values set in buildnote.json config file.

Values: value

---

Dart/Flutter Collector

Options for collecting dart/flutter events.

---

--dart-enabled

Enable or disable dart/flutter collector.

Example:

--dart-enabled true

This flag will replace collect.dart.enabled value set in buildnote.json config file.

Values: [true|false]

---

--dart-include

Glob pattern for files to include.

Example of including nested files:

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

Example of multiple includes:

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

This option will merge with collect.dart.include values set in buildnote.json config file.

Values: text

---

--dart-exclude

Glob pattern for files to exclude.

Example of excluding nested directories:

--dart-exclude "**/out"

Example of multiple excludes:

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

This option will merge with collect.dart.exclude values set in buildnote.json config file.

Values: text

---

--dart-metadata

Additional metadata associated with events.

Example of multiple metadata items:

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

This option will merge with collect.dart.metadata values set in buildnote.json config file.

Values: value

---

NUnit Collector

Options for collecting nunit events.

---

--nunit-enabled

Enable or disable nunit collector.

Example:

--nunit-enabled true

This flag will replace collect.nunit.enabled value set in buildnote.json config file.

Values: [true|false]

---

--nunit-include

Glob pattern for files to include.

Example of including nested files:

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

Example of multiple includes:

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

This option will merge with collect.nunit.include values set in buildnote.json config file.

Values: text

---

--nunit-exclude

Glob pattern for files to exclude.

Example of excluding nested directories:

--nunit-exclude "**/out"

Example of multiple excludes:

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

This option will merge with collect.nunit.exclude values set in buildnote.json config file.

Values: text

---

--nunit-metadata

Additional metadata associated with events.

Example of multiple metadata items:

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

This option will merge with collect.nunit.metadata values set in buildnote.json config file.

Values: value

---

XUnit Collector

Options for collecting xunit events.

---

--xunit-enabled

Enable or disable xunit collector.

Example:

--xunit-enabled true

This flag will replace collect.xunit.enabled value set in buildnote.json config file.

Values: [true|false]

---

--xunit-include

Glob pattern for files to include.

Example of including nested files:

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

Example of multiple includes:

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

This option will merge with collect.xunit.include values set in buildnote.json config file.

Values: text

---

--xunit-exclude

Glob pattern for files to exclude.

Example of excluding nested directories:

--xunit-exclude "**/out"

Example of multiple excludes:

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

This option will merge with collect.xunit.exclude values set in buildnote.json config file.

Values: text

---

--xunit-metadata

Additional metadata associated with events.

Example of multiple metadata items:

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

This option will merge with collect.xunit.metadata values set in buildnote.json config file.

Values: value

---

CTRF Collector

Options for collecting ctrf events.

---

--ctrf-enabled

Enable or disable ctrf collector.

Example:

--ctrf-enabled true

This flag will replace collect.ctrf.enabled value set in buildnote.json config file.

Values: [true|false]

---

--ctrf-include

Glob pattern for files to include.

Example of including nested files:

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

Example of multiple includes:

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

This option will merge with collect.ctrf.include values set in buildnote.json config file.

Values: text

---

--ctrf-exclude

Glob pattern for files to exclude.

Example of excluding nested directories:

--ctrf-exclude "**/out"

Example of multiple excludes:

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

This option will merge with collect.ctrf.exclude values set in buildnote.json config file.

Values: text

---

--ctrf-metadata

Additional metadata associated with events.

Example of multiple metadata items:

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

This option will merge with collect.ctrf.metadata values set in buildnote.json config file.

Values: value

---

TRX Collector

Options for collecting trx events.

---

--trx-enabled

Enable or disable trx collector.

Example:

--trx-enabled true

This flag will replace collect.trx.enabled value set in buildnote.json config file.

Values: [true|false]

---

--trx-include

Glob pattern for files to include.

Example of including nested files:

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

Example of multiple includes:

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

This option will merge with collect.trx.include values set in buildnote.json config file.

Values: text

---

--trx-exclude

Glob pattern for files to exclude.

Example of excluding nested directories:

--trx-exclude "**/out"

Example of multiple excludes:

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

This option will merge with collect.trx.exclude values set in buildnote.json config file.

Values: text

---

--trx-metadata

Additional metadata associated with events.

Example of multiple metadata items:

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

This option will merge with collect.trx.metadata values set in buildnote.json config file.

Values: value

---

Robot Framework Collector

Options for collecting robot framework events.

---

--robot-enabled

Enable or disable robot framework collector.

Example:

--robot-enabled true

This flag will replace collect.robot.enabled value set in buildnote.json config file.

Values: [true|false]

---

--robot-include

Glob pattern for files to include.

Example of including nested files:

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

Example of multiple includes:

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

This option will merge with collect.robot.include values set in buildnote.json config file.

Values: text

---

--robot-exclude

Glob pattern for files to exclude.

Example of excluding nested directories:

--robot-exclude "**/out"

Example of multiple excludes:

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

This option will merge with collect.robot.exclude values set in buildnote.json config file.

Values: text

---

--robot-metadata

Additional metadata associated with events.

Example of multiple metadata items:

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

This option will merge with collect.robot.metadata values set in buildnote.json config file.

Values: value

---

QT Test Collector

Options for collecting qt test events.

---

--qt-enabled

Enable or disable qt test collector.

Example:

--qt-enabled true

This flag will replace collect.qt.enabled value set in buildnote.json config file.

Values: [true|false]

---

--qt-include

Glob pattern for files to include.

Example of including nested files:

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

Example of multiple includes:

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

This option will merge with collect.qt.include values set in buildnote.json config file.

Values: text

---

--qt-exclude

Glob pattern for files to exclude.

Example of excluding nested directories:

--qt-exclude "**/out"

Example of multiple excludes:

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

This option will merge with collect.qt.exclude values set in buildnote.json config file.

Values: text

---

--qt-metadata

Additional metadata associated with events.

Example of multiple metadata items:

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

This option will merge with collect.qt.metadata values set in buildnote.json config file.

Values: value

---

Files Collector

Options for collecting files events.

---

--files-enabled

Enable or disable files collector.

Example:

--files-enabled true

This flag will replace collect.files.enabled value set in buildnote.json config file.

Values: [true|false]

---

--files-include

Glob pattern for files to include.

Example of including nested files:

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

Example of multiple includes:

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

This option will merge with collect.files.include values set in buildnote.json config file.

Values: text

---

--files-exclude

Glob pattern for files to exclude.

Example of excluding nested directories:

--files-exclude "**/out"

Example of multiple excludes:

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

This option will merge with collect.files.exclude values set in buildnote.json config file.

Values: text

---

--files-metadata

Additional metadata associated with events.

Example of multiple metadata items:

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

This option will merge with collect.files.metadata values set in buildnote.json config file.

Values: value

---

Buildnote Collector

Options for collecting buildnote events.

---

--events-enabled

Enable or disable buildnote collector.

Example:

--events-enabled true

This flag will replace collect.events.enabled value set in buildnote.json config file.

Values: [true|false]

---

--events-include

Glob pattern for files to include.

Example of including nested files:

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

Example of multiple includes:

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

This option will merge with collect.events.include values set in buildnote.json config file.

Values: text

---

--events-exclude

Glob pattern for files to exclude.

Example of excluding nested directories:

--events-exclude "**/out"

Example of multiple excludes:

--events-exclude "**/out" --events-exclude "build"

This option will merge with collect.events.exclude values set in buildnote.json config file.

Values: text

---

--events-metadata

Additional metadata associated with events.

Example of multiple metadata items:

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

This option will merge with collect.events.metadata values set in buildnote.json config file.

Values: value

---