Options
All
  • Public
  • Public/Protected
  • All
Menu

Invocation object used by most listeners that react to code changes. Provides fuller information about the impact of the push.

Hierarchy

Index

Properties

addressChannels

addressChannels: AddressChannels

Provides a way to address the channel(s) related to this action: usually, an event or command invocation. In an event handler, these are usually the channel(s) linked to a repo. In a command handler, the behavior will be the same as that of MessageClient.respond. In some cases, such as repo creation or a push to a repo where there is no linked channel, addressChannels will go to dev/null without error.

commit

commit: Commits

Head commit on push

configuration

configuration: Configuration

context

context: HandlerContext

Context of the Atomist EventHandler invocation. Use to run GraphQL queries, use the messageClient directly and find the team and correlation id

credentials

credentials: ProjectOperationCredentials

Credentials for use with source control hosts such as GitHub

filesChanged

filesChanged: string[] | undefined

Paths of the files changed in this push. Undefined if it is unknown how many files have changed.

id

id: RemoteRepoRef

The repo this relates to

impactedSubProject

impactedSubProject: Project

Project of affected files. May be the same as project, if we can't tell which files were affected.

preferences

preferences: PreferenceStore

Store and retrieve preferences for this SDM or team

project

project: GitProject

The project to which this event relates. It will have been cloned prior to this invocation. Modifications made during listener invocation will not be committed back to the project (although they are acceptable if necessary, for example to run particular commands against the project). As well as working with project files using the Project superinterface, we can use git-related functionality fro the GitProject subinterface: For example to check for previous shas. We can also easily run shell commands against the project using its baseDir.

push

push: Push

Information about the push, including repo and commit

Generated using TypeDoc