Package com.atlassian.bamboo.vcs.runtime

Interface VcsBuildWarningsUpdater

All Superinterfaces:
IdentifyingExecutor<VcsBuildWarningsUpdater>
All Known Implementing Classes:
BitbucketServerBuildWarningsUpdater
public interface VcsBuildWarningsUpdater extends IdentifyingExecutor<VcsBuildWarningsUpdater>
Executor responsible for updating a repository host with build warnings. Used on server-side. Implementation should be stateless.
Since:
6.7

  • Method Details

    • supportsBuildWarnings

      boolean supportsBuildWarnings(@NotNull @NotNull VcsRepositoryData repository)
      Returns true if build warnings are supported by the given repository.

    • sendBuildWarnings

      boolean sendBuildWarnings(@NotNull @NotNull VcsRepositoryData repository, @NotNull @NotNull String changesetId, @NotNull @NotNull ImmutableChainResultsSummary resultsSummary, @NotNull @NotNull BuildWarningSummary warningSummary, @NotNull @NotNull Iterable<WarningAnnotation> warnings) throws RepositoryException
      Sends build warnings for the given repository used in a build.

      This method can be called multiple times to send warnings incrementally, to allow external data batching.

      Parameters:
      repository - repository for which to send code warnings
      changesetId - commit identifier
      resultsSummary - summary of the build result which generated the warnings
      warningSummary - summary of the warnings
      warnings - batch of warnings to send
      Returns:
      true if annotations have been successfully sent, false otherwise. When false is returned, no further calls to this method should be performed for the same repository and result.
      Throws:
      RepositoryException - if for any reason the build warnings could not have been sent.

    • deleteBuildWarnings

      void deleteBuildWarnings(@NotNull @NotNull VcsRepositoryData repository, @NotNull @NotNull String changeSetId, @NotNull @NotNull ImmutableChainResultsSummary resultsSummary) throws RepositoryException
      Removes all warnings previously sent by Bamboo for the given repository used in a build.
      Parameters:
      repository - repository for which to delete code warnings
      changeSetId - commit identifier
      resultsSummary - summary of the build result which generated the warnings
      Throws:
      RepositoryException - if for any reason the build warnings could not have been deleted.