Armory Docs – Common Objects

Plugins: artifacts

Mon, 01 Jan 0001 00:00:00 +0000

An artifact is an object that references an external resource.

The objects and endpoints found in:

artifacts,
boundArtifact,
createdArtifacts,
expectedArtifacts,
matchArtifact,
optionalArtifacts,
and resolvedExpectedArtifacts,

are the same. Additionally:

boundArtifact,
defaultArtifact,
and matchArtifact

can be found as sub-arrays of expectedArtifacts resolvedExpectedArtifacts.

The table below continues the path from the artifact array:

Key	Type	Description
`artifactAccount`	`string`	If your artifact either was not supplied from a trigger, or it was not found in a prior execution, this account provides a default artifact.
`customKind`	`boolean`
`location`
`metadata.account`	`string`
`metadata.id`	`string`	The unique ID of the default artifact
`name`	`string`	The display name of the default artifact
`provenance`
`reference`	`string`
`type`	`string`
`version`	`string`	what version/branch of the artifact should be read from the account.
`id`	`string`
`useDefaultArtifact`	`boolean`	If your artifact either was not supplied from a trigger, or it was not found in a prior execution, the artifact specified below ends up in your pipeline’s execution context.
`usePriorArtifact`	`boolean`	Attempt to match against an artifact in the prior pipeline execution’s context. This ensures that you always be using the most recently supplied artifact to this pipeline and is generally a safe choice.
`uuid`

Plugins: input.pipeline.trigger

Mon, 01 Jan 0001 00:00:00 +0000

Keys

Key	Type	Description
`input.pipeline.trigger.artifacts[]`	`[array]`	See artifacts for more information.
`input.pipeline.trigger.correlationId`
`input.pipeline.trigger.dryRun`	`boolean`
`input.pipeline.trigger.enabled`	`boolean`	True if the trigger is enabled.
`input.pipeline.trigger.eventId`	`string`
`input.pipeline.trigger.executionId`	`string`
`input.pipeline.trigger.expectedArtifacts[]`	`[array]`	See artifacts for more information.
`input.pipeline.trigger.isDryRun`	`boolean`
`input.pipeline.trigger.isRebake`	`boolean`
`input.pipeline.trigger.isStrategy`	`boolean`
`input.pipeline.trigger.other.artifacts[]`	`[array]`	See artifacts for more information.
`input.pipeline.trigger.other.dryRun`	`boolean`
`input.pipeline.trigger.other.enabled`	`boolean`
`input.pipeline.trigger.other.eventId`	`string`
`input.pipeline.trigger.other.executionId`	`string`
`input.pipeline.trigger.other.expectedArtifacts[]`	`[array]`	See artifacts for more information.
`input.pipeline.trigger.other.preferred`	`boolean`
`input.pipeline.trigger.other.rebake`	`boolean`
`input.pipeline.trigger.other.resolvedExpectedArtifacts[]`	`[array]`	See artifacts for more information.
`input.pipeline.trigger.other.strategy`	`boolean`
`input.pipeline.trigger.other.type`	`string`
`input.pipeline.trigger.other.user`	`string`
`input.pipeline.trigger.parameters.<parameterName>`	`string`	The value specified for the parameter when triggering the pipeline.
`input.pipeline.trigger.preferred`	`boolean`
`input.pipeline.trigger.rebake`	`boolean`
`input.pipeline.trigger.resolvedExpectedArtifacts[]`	`[array]`	See artifacts for more information.
`input.pipeline.trigger.type`	`string`	The type of trigger. See Triggering Pipelines - Overview for more information.
`input.pipeline.trigger.user`	`string`	For triggers of type `git`, the user or organization associated with the git repository.
`input.pipeline.triggers[].branch`	`string`	Which branch of the git repository triggers this pipeline.
`input.pipeline.triggers[].dryRun`	`boolean`
`input.pipeline.triggers[].enabled`	`boolean`	True if the trigger is enabled.
`input.pipeline.triggers[].expectedArtifactIds[]`	`string`
`input.pipeline.triggers[].id`	`string`
`input.pipeline.triggers[].preferred`	`boolean`
`input.pipeline.triggers[].project`	`string`	A change in what project triggers this pipeline.
`input.pipeline.triggers[].rebake`	`boolean`	True if all baked artifacts should be rebaked, even if their inputs have not changed.
`input.pipeline.triggers[].secret`	`string`	The secret that the trigger uses to authenticate with Armory Continuous Deployment.
`input.pipeline.triggers[].slug`	`string`	The trigger’s slug. For example, with a GitHub trigger this is the project name.
`input.pipeline.triggers[].source`	`string`	The type of the source for the trigger. For some trigger types this can be used to disambiguate amongst multiple trigger invokers.
`input.pipeline.triggers[].type`	`string`	The configured type of the trigger.

Plugins: input.user

Mon, 01 Jan 0001 00:00:00 +0000

The following function can be used in your policies to determine if a user has a particular role assigned to it:

hasRole(role){
 input.user.roles[_].name=role
}

Key	Type	Description
`input.user.isAdmin`	`boolean`	Is the user who started this pipeline an admin user
`input.user.username`	`string`	What is the user ID of the user that started this pipeline.
`input.user.role[]`	`string`	The names of the roles assigned to the user. This only shows up if FIAT is configured to provide roles.