UNPKG

1.05 kBTypeScriptView Raw
1import { GitProject } from "@atomist/automation-client/lib/project/git/GitProject";
2import { RepoListenerInvocation, SdmListener } from "./Listener";
3/**
4 * Invocation for an event on a project
5 */
6export interface ProjectListenerInvocation extends RepoListenerInvocation {
7 /**
8 * The project to which this event relates. It will have been cloned
9 * prior to this invocation. Modifications made during listener invocation will
10 * not be committed back to the project (although they are acceptable if necessary, for
11 * example to run particular commands against the project).
12 * As well as working with
13 * project files using the Project superinterface, we can use git-related
14 * functionality fro the GitProject subinterface: For example to check
15 * for previous shas.
16 * We can also easily run shell commands against the project using its baseDir.
17 */
18 project: GitProject;
19}
20export declare type ProjectListener = SdmListener<ProjectListenerInvocation>;
21//# sourceMappingURL=ProjectListener.d.ts.map
\No newline at end of file