Skip to content

Latest commit

 

History

History
54 lines (41 loc) · 1.71 KB

index.rst

File metadata and controls

54 lines (41 loc) · 1.71 KB
Raw

Report Generators

build build_start_end buildset worker formatter formatter_function formatter_renderable formatter_missing_worker

Report generators abstract the conditions of when a message is sent by a Reporter <Reporters> and the content of the message.

Multiple report generators can be registered to a reporter.

At this moment, only the following reporters support report generators:

  • :bbBitbucketServerPRCommentPush
  • :bbBitbucketStatusPush
  • :bbGitHubStatusPush
  • :bbGitHubCommentPush
  • :bbGitLabStatusPush
  • :bbHttpStatusPush
  • :bbMailNotifier
  • :bbPushjetNotifier
  • :bbPushoverNotifier

Eventually, report generator support will be added to the rest of the reporters as well.

The following report generators are available:

  • Reportgen-BuildStatusGenerator
  • Reportgen-BuildStartEndStatusGenerator
  • Reportgen-BuildSetStatusGenerator
  • Reportgen-WorkerMissingGenerator

The report generators may customize the reports using message formatters. The following message formatter classes are provided:

  • MessageFormatter (used in BuildStatusGenerator, BuildStartEndStatusGenerator and BuildSetStatusGenerator)
  • MessageFormatterRenderable (used in BuildStatusGenerator and BuildStartEndStatusGenerator)
  • MessageFormatterFunction (used in BuildStatusGenerator and BuildStartEndStatusGenerator)
  • MessageFormatterMissingWorkers (used in WorkerMissingGenerator)