Package com.atlassian.bamboo.build.warning

Interface BuildWarningSummaryCollationService

All Known Implementing Classes:

BuildWarningSummaryCollationServiceImpl

@ExperimentalApi
public interface BuildWarningSummaryCollationService

Collates build warnings.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	WARNINGS_ARTIFACT	Key of artifact name in job build result which holds build warnings details.

Method Summary

Modifier and Type	Method	Description
@NotNull File	aggregationFileForCommonContext(@NotNull CommonContext commonContext)	Returns the file containing collected warnings for a given CommonContext.
void	appendWarningAnnotations(@NotNull TaskContext taskContext, @NotNull Iterable<WarningAnnotation> annotations, @NotNull Long associatedRepositoryId)	Adds warnings to a warnings file and updates the warnings summary for a build result.
void	publishCollectedWarnings(@NotNull BuildContext commonContext)	Ends collection of warnings and publishes them as a build artifact.

Field Details

WARNINGS_ARTIFACT

static final String WARNINGS_ARTIFACT

Key of artifact name in job build result which holds build warnings details.

Method Details

appendWarningAnnotations

void appendWarningAnnotations(@NotNull
 @NotNull TaskContext taskContext,
 @NotNull
 @NotNull Iterable<WarningAnnotation> annotations,
 @NotNull
 @NotNull Long associatedRepositoryId)
                       throws IOException

Adds warnings to a warnings file and updates the warnings summary for a build result.

Throws:

IOException

publishCollectedWarnings

void publishCollectedWarnings(@NotNull
 @NotNull BuildContext commonContext)
                       throws IOException

Ends collection of warnings and publishes them as a build artifact.

Throws:

IOException

aggregationFileForCommonContext

@NotNull
@NotNull File aggregationFileForCommonContext(@NotNull
 @NotNull CommonContext commonContext)

Returns the file containing collected warnings for a given CommonContext.