com.atlassian.bamboo.vcs.runtime

Interface VcsCommitCommenter

All Superinterfaces:

IdentifyingExecutor<VcsCommitCommenter>

All Known Implementing Classes:

BitbucketCloudCommitCommenter, GitHubCommitCommenter

@ExperimentalApi
public interface VcsCommitCommenter
extends IdentifyingExecutor<VcsCommitCommenter>

Executor responsible for leaving commit level comments. Used by server-side. Implementation should be stateless.

Since:

6.5

Method Summary

Modifier and Type	Method and Description
boolean	publishComment(VcsRepositoryData repositoryData, String commitId, String payload) Publish comment to repository commit.
boolean	publishRssStatus(VcsRepositoryData repositoryData, String commitId, com.atlassian.event.Event event) Publish Bamboo Specs execution status to repository commit.

Methods inherited from interface com.atlassian.bamboo.vcs.runtime.IdentifyingExecutor

getVcsIdForExecutor

Method Detail

publishRssStatus

boolean publishRssStatus(@NotNull
                         VcsRepositoryData repositoryData,
                         @NotNull
                         String commitId,
                         @NotNull
                         com.atlassian.event.Event event)
                  throws RepositoryException

Publish Bamboo Specs execution status to repository commit.

Parameters:

commitId - identifier of commit which should receive comment. For git-based repos it's SHA.

event - is RssEvent from bamboo-core.

Returns:

true if published comment successfully.

Throws:

RepositoryException - when commit not found or credentials are wrong

publishComment

boolean publishComment(@NotNull
                       VcsRepositoryData repositoryData,
                       @NotNull
                       String commitId,
                       @NotNull
                       String payload)
                throws RepositoryException

Publish comment to repository commit.

Parameters:

commitId - identifier of commit which should receive comment. For git-based repos it's SHA.

payload - content of comment

Returns:

true if published comment successfully.

Throws:

RepositoryException - when commit not found or credentials are wrong