generate_changelog.pipeline.Action

Action

class generate_changelog.pipeline.Action

An action to perform in a pipeline.

__init__(action, id_=None, args=None, kwargs=None, commit_metadata_func=None, version_metadata_func=None)

Parameters:

• action (str) –

• id_ (str | None) –

• args (list | None) –

• kwargs (dict | None) –

• commit_metadata_func (Callable | None) –

• version_metadata_func (Callable | None) –

id: Optional[str] = None

Identifier for the action.

commit_metadata_func: Optional[Callable]

Function the action can call to set metadata about the commit.

version_metadata_func: Optional[Callable]

Function the action can call to set metadata about the version a commit belongs to.

run(context, input_value)

Perform the action on the input.

Parameters:

• context (dict) – The current pipeline context for rendering args and kwargs

• input_value (Any) – The value to processes

Return type:

str

Returns:

The processed string