forked from newrelic/.github
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathnew-relic-one-catalog-project.json
217 lines (217 loc) · 10.9 KB
/
new-relic-one-catalog-project.json
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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
{
"$schema": "https://raw.githubusercontent.com/newrelic-forks/repolinter/master/rulesets/schema.json",
"version": 2,
"axioms": {},
"rules": {
"license-file-exists": {
"level": "error",
"rule": {
"type": "file-existence",
"options": {
"globsAny": ["LICENSE*", "COPYING*"],
"nocase": true
}
},
"fix": {
"type": "file-create",
"options": {
"file": "LICENSE",
"replace": true,
"text": { "url": "https://www.apache.org/licenses/LICENSE-2.0.txt" }
}
},
"policyInfo": "New Relic requires that all open source projects have an associated license contained within the project. This license must be permissive (e.g. non-viral or copyleft), and we recommend Apache 2.0 for most use cases",
"policyUrl": "https://docs.google.com/document/d/1vML4aY_czsY0URu2yiP3xLAKYufNrKsc7o4kjuegpDw/edit"
},
"readme-file-exists": {
"level": "error",
"rule": {
"type": "file-existence",
"options": {
"globsAny": ["README*"],
"nocase": true
}
},
"fix": {
"type": "file-create",
"options": {
"file": "README.md",
"text": { "url": "https://raw.githubusercontent.com/newrelic/open-source-tools/master/nerdpacks/oss-template/README.md" }
}
},
"policyInfo": "New Relic requires a README file in all projects. This README should give a general overview of the project, and should point to additional resources (security, contributing, etc.) where developers and users can learn further",
"policyUrl": "https://github.com/newrelic/open-source-tools/tree/master/javascript/oss-template"
},
"readme-starts-with-nr1-catalog-header": {
"level": "error",
"rule": {
"type": "file-starts-with",
"options": {
"globsAll": ["README*"],
"nocase": true,
"lineCount": 1,
"patterns": ["\\[\\s*\\!\\[[a-z0-9\\s]+\\]\\(\\s*https:\\/\\/github\\.com\\/newrelic\\/opensource-website\\/raw\\/master\\/src\\/images\\/categories\\/New_Relic_One_Catalog_Project\\.png\\s*\\)\\s*\\]\\(\\s*https:\\/\\/opensource\\.newrelic\\.com\\/oss-category\\/#new-relic-one-catalog-project\\s*\\)"],
"human-readable-pattern": "Open source NR1 Catalog header (see https://opensource.newrelic.com/oss-category)",
"flags": "i",
"succeed-on-non-existent": false
}
},
"fix": {
"type": "file-modify",
"options": {
"text": "[](https://opensource.newrelic.com/oss-category/#new-relic-one-catalog-project)",
"write_mode": "prepend",
"newlines": { "end": 2 }
}
},
"policyInfo": "The README of a community plus project should have a NR1 Catalog header at the start of the README. If you already have a NR1 Catalog header and this rule is failing, your header may be out of date, and you should update your header with the suggested one below",
"policyUrl": "https://opensource.newrelic.com/oss-category/"
},
"readme-contains-security-section": {
"level": "error",
"rule": {
"type": "file-contents",
"options": {
"globsAll": ["README*"],
"fail-on-non-exist": true,
"flags": "mi",
"content": "^#+\\s*security[\\w\\s]*$",
"human-readable-content": "a security section"
}
},
"policyInfo": "New Relic recommends having a Security section in your README to address concerns such as vulnerability reporting. This security section should also contain a link to the security policy (found under the \"Security\" tab of the repository). For an example of this section, please see the [NR1 Catalog Template](https://github.com/newrelic/template-nerdpack#security)",
"policyUrl": "https://nerdlife.datanerd.us/new-relic/security-guidelines-for-publishing-source-code"
},
"readme-contains-link-to-security-policy": {
"level": "error",
"rule": {
"type": "file-contents",
"options": {
"globsAll": ["README*"],
"fail-on-non-exist": true,
"flags": "i",
"content": "(?:(?:https:\\/\\/github\\.com\\/newrelic\\/[^\\/]+)|(?:\\.\\.\\/\\.\\.))\\/security\\/policy",
"human-readable-content": "a link to the security policy for this repository"
}
},
"policyInfo": "New Relic recommends referencing the open source security policy (`https://github.com/newrelic/<repo-name>/security/policy` or `../../security/policy`) in a Security section in the README. For an example of this, please see the [NR1 Catalog Template](https://github.com/newrelic/template-nerdpack#security)",
"policyUrl": "https://nerdlife.datanerd.us/new-relic/security-guidelines-for-publishing-source-code"
},
"readme-contains-discuss-topic": {
"level": "error",
"rule": {
"type": "file-contents",
"options": {
"globsAll": ["README*"],
"fail-on-non-exist": true,
"flags": "i",
"content": "discuss\\.newrelic\\.com",
"human-readable-content": "a link to the appropriate discuss.newrelic.com topic"
}
},
"policyInfo": "New Relic recommends directly linking the your appropriate discuss.newrelic.com topic in the README, allowing developer an alternate method of getting support",
"policyUrl": "https://nerdlife.datanerd.us/new-relic/security-guidelines-for-publishing-source-code"
},
"third-party-notices-file-exists": {
"level": "error",
"rule": {
"type": "file-existence",
"options": {
"globsAny": [
"THIRD_PARTY_NOTICES*",
"THIRD-PARTY-NOTICES*",
"THIRDPARTYNOTICES*"
],
"nocase": true
}
},
"policyInfo": "A THIRD_PARTY_NOTICES.md file must be present to grant attribution to all dependencies being used by this project. For JavaScript projects, you can generate this file using the [oss-cli](https://github.com/newrelic/newrelic-oss-cli)",
"policyUrl": "https://docs.google.com/document/d/1y644Pwi82kasNP5VPVjDV8rsmkBKclQVHFkz8pwRUtE/view"
},
"code-of-conduct-file-does-not-exist": {
"level": "error",
"rule": {
"type": "file-not-exists",
"options": {
"globsAll": [
"CODE_OF_CONDUCT*",
"CODE-OF-CONDUCT*",
"CODEOFCODUCT"
],
"nocase": true
}
},
"fix": {
"type": "file-remove",
"options": {}
},
"policyInfo": "New Relic has moved the `CODE_OF_CONDUCT` file to a [centralized location](https://github.com/newrelic/.github/blob/main/CODE_OF_CONDUCT.md) where it is referenced automatically by every repository in the New Relic organization. Because of this change, any other `CODE_OF_CONDUCT` file in a repository is now redundant and should be removed",
"policyUrl": "https://docs.google.com/document/d/1y644Pwi82kasNP5VPVjDV8rsmkBKclQVHFkz8pwRUtE/view"
},
"github-actions-workflow-file-exists": {
"level": "error",
"rule": {
"type": "file-existence",
"options": {
"globsAny": [
".github/workflows/*.yml",
".github/workflows/*.yaml"
],
"nocase": true
}
},
"policyInfo": "Any Community Plus project must integrate with GitHub actions",
"policyUrl": "https://docs.google.com/document/d/1y644Pwi82kasNP5VPVjDV8rsmkBKclQVHFkz8pwRUtE/view"
},
"nr1-catalog-config-file-exists": {
"level": "error",
"rule": {
"type": "file-existence",
"options": {
"globsAny": ["catalog/config.json"]
}
}
},
"nr1-catalog-screenshots-directory-exists": {
"level": "error",
"rule": {
"type": "directory-existence",
"options": {
"globsAny": ["catalog/screenshots"]
}
}
},
"nr1-catalog-documentation-file-exists": {
"level": "error",
"rule": {
"type": "file-existence",
"options": {
"globsAny": ["catalog/documentation.md"]
}
}
},
"package-scripts-present": {
"level": "error",
"rule": {
"type": "json-schema-passes",
"options": {
"glob": "package.json",
"human-readable-message": "An `eslint-check` and `eslint-fix` npm script",
"schema": {
"properties": {
"scripts": {
"type": "object",
"required": ["eslint-check", "eslint-fix"]
}
},
"required": ["scripts"]
}
}
},
"policyInfo": "NPM scripts for ESLint (`eslint-check` and `eslint-fix`) are required to properly integrate with the nerdpack system"
}
},
"formatOptions": {
"disclaimer": "🤖*This issue was automatically generated by [repolinter-action](https://github.com/newrelic/repolinter-action), developed by the Open Source and Developer Advocacy team at New Relic. This issue will be automatically updated or closed when changes are pushed. If you have any problems with this tool, please feel free to open a GitHub issue or give us a ping in #help-opensource.*"
}
}