deploy_tools.snapshot

Members

SnapshotError	Raised when a deployment snapshot is missing or in an unexpected state.
create_snapshot	Create a snapshot file for the deployment configuration.
load_snapshot	Load snapshot of the Deployment configuration taken at start of Deploy step.
load_snapshot_from_ref	Load the deployment snapshot from the given git ref of the deployment area.

exception deploy_tools.snapshot.SnapshotError

Raised when a deployment snapshot is missing or in an unexpected state.

deploy_tools.snapshot.create_snapshot(deployment: Deployment, layout: Layout) → None

Create a snapshot file for the deployment configuration.

This snapshot can then be used to compare the previous and current deployment configuration when a compare, validate or sync process is run.

deploy_tools.snapshot.load_snapshot(layout: Layout, from_scratch: bool = False) → Deployment

Load snapshot of the Deployment configuration taken at start of Deploy step.

Parameters:

• layout – The Layout representing the Deployment Area.

• from_scratch – If True, this will return the default Deployment configuration in order to work with an empty Deployment Area.

deploy_tools.snapshot.load_snapshot_from_ref(layout: Layout, ref: str) → Deployment

Load the deployment snapshot from the given git ref of the deployment area.