/
ExtensionPack.ts
64 lines (55 loc) · 1.87 KB
/
ExtensionPack.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
/*
* Copyright © 2018 Atomist, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { GoalSetter } from "../mapping/GoalSetter";
import { ConfigurationValues } from "./ConfigurationValues";
import { MachineConfigurer } from "./MachineConfigurer";
export interface ExtensionPackMetadata {
/**
* Name of the extension pack
*/
name: string;
/**
* Vendor or author of this extension pack
*/
vendor: string;
/**
* Version of extension pack
*/
version: string;
/**
* Optional tags of extension pack
*/
tags?: string | string[];
}
/**
* Primary unit of extensibility in SDMs.
* Implemented to expose a capability that can be added to a
* software delivery machine in a consistent manner.
* Facilitates modularity at a higher level than FunctionUnit or handlers.
* For example, a Node module can export an ExtensionPack.
* ExtensionPacks can optional contribute goal setting, which will be added to existing goal setting.
*/
export interface ExtensionPack extends MachineConfigurer, ExtensionPackMetadata, ConfigurationValues {
/**
* Human-readable description of this extension pack
*/
description?: string;
/**
* Optional goal setting contributions that will be added into SDM goal setting.
* Decorates other goal setting behavior.
*/
goalContributions?: GoalSetter;
}