Package jetbrains.buildServer.serverSide.impl

Interface CommitMessageProducer

All Superinterfaces:

ServerExtension, TeamCityExtension

All Known Implementing Classes:

YamlPipelineCommitMessageProducer

public interface CommitMessageProducer
extends ServerExtension

A server extension providing commit messages for config action, e.g. for versioned settings.

Method Summary

Modifier and Type	Method	Description
String	getCommitMessage(ConfigAction configAction)	Returns config action commit message with human-readable affected entity, e.g.
boolean	isApplicable(ConfigAction configAction)	Returns whether this CommitMessageProduces can generate a commit message for given cause (config action).

Method Detail

getCommitMessage

@NotNull
String getCommitMessage(@NotNull
                        ConfigAction configAction)

Returns config action commit message with human-readable affected entity, e.g. "'My Project' project" or "pipeline 'My Pipeline'".

Returns:

see above

Since:

2023.03

isApplicable

boolean isApplicable(@NotNull
                     ConfigAction configAction)

Returns whether this CommitMessageProduces can generate a commit message for given cause (config action).

Returns:

see above

Since:

2023.03