getAffected

getAffected is the first step of a package deploy. It works out what deploying a package would change in your workspace.

It does two things:

• It checks that everything the package depends on, but does not carry itself, already exists in the workspace.
• It lists the processes, datastores and integrations in the package that already exist in the workspace, so deploying would update them. Resources that are new to the workspace are not listed: creating them needs no sign-off.

The list is handed to getSignoffs, which finds out who has to approve those updates.

Configuration

Package

Package is the package to deploy. When you deploy from Resources, metamorphOS fills it in.

Return Values

Updates lists the existing resources the deploy would update, grouped by type.

Runtime behavior

getAffected runs automatically and changes nothing in the workspace. It only looks.

• When the package and all its dependencies are found, the step returns Updates and the deploy moves on to getSignoffs.
• When the package cannot be found, the step fails and the deploy stops.
• When something the package depends on is missing from the workspace, the step fails and the deploy stops. The error names each missing resource. Create or import the missing resources, then deploy again.

Because the check runs before anyone is asked to sign off, a package that cannot deploy fails straight away.

Works well with

• getSignoffs, the next step, which turns Updates into the list of people who must approve.
• deploy, the step that applies the changes.
• Resources, where packages are deployed.