Source Control Actions (autotransform.step.action.source)

All Actions associated with handling source control options for a Change.

class autotransform.step.action.source.AbandonAction

Bases: Action

Abandons an outstanding Change.

name

The name of the component.

Type:: ClassVar[ActionName]

model_config: ClassVar[ConfigDict] = {}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: ClassVar[ActionName] = 'abandon'

run(change: Change) → bool

Abandons a specified Change.

Parameters:: change (Change) – The Change to abandon.
Returns:: Whether the Change was abandoned successfully.
Return type:: bool

class autotransform.step.action.source.MergeAction

Bases: Action

Merges an outstanding Change.

name

The name of the component.

Type:: ClassVar[ActionName]

model_config: ClassVar[ConfigDict] = {}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: ClassVar[ActionName] = 'merge'

run(change: Change) → bool

Merges a specified Change.

Parameters:: change (Change) – The Change to merge.
Returns:: Whether the Change was merged successfully.
Return type:: bool

class autotransform.step.action.source.NoneAction

Bases: Action

Performs no task.

name

The name of the component.

Type:: ClassVar[ActionName]

model_config: ClassVar[ConfigDict] = {}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: ClassVar[ActionName] = 'none'

run(change: Change) → bool

Performs no action.

Parameters:: change (Change) – The Change to having no action taken on it
Returns:: Always returns True.
Return type:: bool

class autotransform.step.action.source.UpdateAction

Bases: Action

Updates an outstanding Change.

_runner

The runner to use for updating

Type:: ClassVar[Runner]

name

The name of the component.

Type:: ClassVar[ActionName]

model_config: ClassVar[ConfigDict] = {}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: ClassVar[ActionName] = 'update'

run(change: Change) → bool

Updates a specified Change.

Parameters:: change (Change) – The Change to update.
Returns:: Whether the Change was updated successfully.
Return type:: bool

static set_runner(runner: Runner) → None

Sets the runner for the Action to use.

Parameters:: runner (Runner) – The Runner to use to update Changes.