This repository was archived by the owner on Jul 19, 2025. It is now read-only.
File tree Expand file tree Collapse file tree 1 file changed +17
-3
lines changed Expand file tree Collapse file tree 1 file changed +17
-3
lines changed Original file line number Diff line number Diff line change 1
1
# Code Climate Services
2
2
3
+ A collection of classes, each responsible for integrating one external service
4
+ with the Code Climate system.
5
+
6
+ ## Overview
7
+
8
+ Services define ` #receive_<event> ` methods for any events they are interested
9
+ in. These methods will be invoked with ` @payload ` set to a hash of data about
10
+ the event being handled.
11
+
12
+ The structure of this data is described below. Note that there may be additional
13
+ keys not listed here.
14
+
3
15
## Events
4
16
5
17
Attributes common to all event types:
@@ -61,6 +73,10 @@ Event-specific attributes:
61
73
}
62
74
```
63
75
76
+ * Note* : The reason for the top-level ` warning_type ` attribute is for when the
77
+ list of vulnerabilities are of mixed warning types. In this case, the top-level
78
+ attribute can be used in any messaging.
79
+
64
80
### Pull Request
65
81
66
82
Event name: ` pull_request `
@@ -80,9 +96,7 @@ Event-specific attributes:
80
96
81
97
The following are not fully implemented yet.
82
98
83
- * : issue
84
- * : unit
85
- * : snapshot
99
+ * ` snapshot `
86
100
87
101
## License
88
102
You can’t perform that action at this time.
0 commit comments