Comment Actions (autotransform.step.action.comments)

All Actions associated with a Change’s comments.

class autotransform.step.action.comments.CommentAction(*, body: str)

Bases: Action

Adds a comment to an existing Change.

body

The body of the comment.

Type:

str

name

The name of the component.

Type:

ClassVar[ActionName]

body: str

classmethod body_must_be_non_empty(v: str) → str

Validates the body is not empty.

Parameters:

v (str) – The body of the comment.

Raises:

ValueError – Raises an error when the body is empty.

Returns:

The unmodified body of the comment.

Return type:

str

name: ClassVar[ActionName] = 'comment'

run(change: Change) → bool

Adds a comment to the specified Change.

Parameters:

change (Change) – The Change to comment on.

Returns:

Whether the comment was successful.

Return type:

bool