Skip to content

Commit 6ec9f06

Browse files
committed
docs: fix example.json
1 parent 1405091 commit 6ec9f06

File tree

3 files changed

+757
-1
lines changed

3 files changed

+757
-1
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ go-jsonschema --capitalization URL --capitalization OSS -p k6registry --only-mod
5353
The example registry can be found in [example.yaml] file, the documentation ([registry.md], [README.md]) must be updated after modification.
5454

5555
```bash
56+
go run ./cmd/k6registry --lint -o docs/example.json
5657
go run ./cmd/k6registry --lint -o docs/example.json --api docs/example-api docs/example.yaml
5758
tree -n --noreport --filesfirst -o docs/example-api.txt docs/example-api
5859
mdcode update docs/registry.md

README.md

Lines changed: 378 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,384 @@ Check [k6 Extension Registry Concept](docs/registry.md) for information on desig
5656
Registry generated from the source above.
5757
5858
```json file=docs/example.json
59-
```
59+
[
60+
{
61+
"categories": [
62+
"reporting",
63+
"observability"
64+
],
65+
"compliance": {
66+
"grade": "C",
67+
"level": 80
68+
},
69+
"description": "Web-based metrics dashboard for k6",
70+
"module": "github.com/grafana/xk6-dashboard",
71+
"outputs": [
72+
"dashboard"
73+
],
74+
"products": [
75+
"oss"
76+
],
77+
"repo": {
78+
"clone_url": "https://github.com/grafana/xk6-dashboard.git",
79+
"description": "A k6 extension that makes k6 metrics available on a web-based dashboard.",
80+
"homepage": "https://github.com/grafana/xk6-dashboard",
81+
"license": "AGPL-3.0",
82+
"name": "xk6-dashboard",
83+
"owner": "grafana",
84+
"public": true,
85+
"stars": 327,
86+
"timestamp": 1719907965,
87+
"topics": [
88+
"xk6",
89+
"xk6-official",
90+
"xk6-output-dashboard"
91+
],
92+
"url": "https://github.com/grafana/xk6-dashboard",
93+
"versions": [
94+
"v0.7.5",
95+
"v0.7.4",
96+
"v0.7.3",
97+
"v0.7.3-alpha.1",
98+
"v0.7.2",
99+
"v0.7.1",
100+
"v0.7.0",
101+
"v0.7.0-apha.3",
102+
"v0.7.0-alpha.5",
103+
"v0.7.0-alpha.4",
104+
"v0.7.0-alpha.3",
105+
"v0.7.0-alpha.2",
106+
"v0.7.0-alpha.1",
107+
"v0.6.1",
108+
"v0.6.0",
109+
"v0.5.5",
110+
"v0.5.4",
111+
"v0.5.3",
112+
"v0.5.2",
113+
"v0.5.1",
114+
"v0.5.0",
115+
"v0.4.4",
116+
"v0.4.3",
117+
"v0.4.2",
118+
"v0.4.1",
119+
"v0.4.0",
120+
"v0.3.2",
121+
"v0.3.1",
122+
"v0.3.0",
123+
"v0.2.0",
124+
"v0.1.3",
125+
"v0.1.2",
126+
"v0.1.1",
127+
"v0.1.0"
128+
]
129+
},
130+
"tier": "official"
131+
},
132+
{
133+
"categories": [
134+
"data"
135+
],
136+
"compliance": {
137+
"grade": "A",
138+
"level": 100
139+
},
140+
"description": "Load test SQL Servers",
141+
"imports": [
142+
"k6/x/sql"
143+
],
144+
"module": "github.com/grafana/xk6-sql",
145+
"products": [
146+
"cloud",
147+
"oss"
148+
],
149+
"repo": {
150+
"clone_url": "https://github.com/grafana/xk6-sql.git",
151+
"description": "k6 extension to load test RDBMSs (PostgreSQL, MySQL, MS SQL and SQLite3)",
152+
"homepage": "https://github.com/grafana/xk6-sql",
153+
"license": "Apache-2.0",
154+
"name": "xk6-sql",
155+
"owner": "grafana",
156+
"public": true,
157+
"stars": 106,
158+
"timestamp": 1721400602,
159+
"topics": [
160+
"k6",
161+
"sql",
162+
"xk6"
163+
],
164+
"url": "https://github.com/grafana/xk6-sql",
165+
"versions": [
166+
"v0.4.0",
167+
"v0.3.0",
168+
"v0.2.1",
169+
"v0.2.0",
170+
"v0.1.1",
171+
"v0.1.0",
172+
"v0.0.1"
173+
]
174+
},
175+
"tier": "official"
176+
},
177+
{
178+
"categories": [
179+
"kubernetes"
180+
],
181+
"compliance": {
182+
"grade": "C",
183+
"level": 80
184+
},
185+
"description": "Inject faults to test",
186+
"imports": [
187+
"k6/x/disruptor"
188+
],
189+
"module": "github.com/grafana/xk6-disruptor",
190+
"products": [
191+
"oss"
192+
],
193+
"repo": {
194+
"clone_url": "https://github.com/grafana/xk6-disruptor.git",
195+
"description": "Extension for injecting faults into k6 tests",
196+
"homepage": "https://k6.io/docs/javascript-api/xk6-disruptor/",
197+
"license": "AGPL-3.0",
198+
"name": "xk6-disruptor",
199+
"owner": "grafana",
200+
"public": true,
201+
"stars": 88,
202+
"timestamp": 1724358828,
203+
"topics": [
204+
"chaos-engineering",
205+
"fault-injection",
206+
"k6",
207+
"testing",
208+
"xk6"
209+
],
210+
"url": "https://github.com/grafana/xk6-disruptor",
211+
"versions": [
212+
"v0.3.11",
213+
"v0.3.10",
214+
"v0.3.9",
215+
"v0.3.8",
216+
"v0.3.7",
217+
"v0.3.6",
218+
"v0.3.5",
219+
"v0.3.5-rc2",
220+
"v0.3.5-rc1",
221+
"v0.3.4",
222+
"v0.3.3",
223+
"v0.3.2",
224+
"v0.3.1",
225+
"v0.3.0",
226+
"v0.2.1",
227+
"v0.2.0",
228+
"v0.1.3",
229+
"v0.1.2",
230+
"v0.1.1",
231+
"v0.1.0"
232+
]
233+
},
234+
"tier": "official"
235+
},
236+
{
237+
"categories": [
238+
"data"
239+
],
240+
"compliance": {
241+
"grade": "A",
242+
"level": 100
243+
},
244+
"description": "Generate random fake data",
245+
"imports": [
246+
"k6/x/faker"
247+
],
248+
"module": "github.com/szkiba/xk6-faker",
249+
"products": [
250+
"oss"
251+
],
252+
"repo": {
253+
"clone_url": "https://github.com/szkiba/xk6-faker.git",
254+
"description": "Random fake data generator for k6.",
255+
"homepage": "http://ivan.szkiba.hu/xk6-faker/",
256+
"license": "AGPL-3.0",
257+
"name": "xk6-faker",
258+
"owner": "szkiba",
259+
"public": true,
260+
"stars": 49,
261+
"timestamp": 1719935566,
262+
"topics": [
263+
"xk6",
264+
"xk6-javascript-k6-x-faker"
265+
],
266+
"url": "https://github.com/szkiba/xk6-faker",
267+
"versions": [
268+
"v0.3.0",
269+
"v0.3.0-alpha.1",
270+
"v0.2.2",
271+
"v0.2.1",
272+
"v0.2.0",
273+
"v0.1.0"
274+
]
275+
},
276+
"tier": "community"
277+
},
278+
{
279+
"categories": [
280+
"misc"
281+
],
282+
"compliance": {
283+
"grade": "A",
284+
"level": 100
285+
},
286+
"description": "Print ASCII art banner from k6 test",
287+
"imports": [
288+
"k6/x/banner"
289+
],
290+
"module": "gitlab.com/szkiba/xk6-banner",
291+
"products": [
292+
"oss"
293+
],
294+
"repo": {
295+
"clone_url": "https://gitlab.com/szkiba/xk6-banner.git",
296+
"description": "Print ASCII art banner from k6 test.",
297+
"homepage": "https://gitlab.com/szkiba/xk6-banner",
298+
"license": "MIT",
299+
"name": "xk6-banner",
300+
"owner": "szkiba",
301+
"public": true,
302+
"timestamp": 1724312566,
303+
"topics": [
304+
"xk6"
305+
],
306+
"url": "https://gitlab.com/szkiba/xk6-banner",
307+
"versions": [
308+
"v0.1.0"
309+
]
310+
},
311+
"tier": "community"
312+
},
313+
{
314+
"categories": [
315+
"misc"
316+
],
317+
"description": "A modern load testing tool, using Go and JavaScript",
318+
"module": "go.k6.io/k6",
319+
"products": [
320+
"cloud",
321+
"oss"
322+
],
323+
"repo": {
324+
"description": "A modern load testing tool, using Go and JavaScript - https://k6.io",
325+
"homepage": "https://github.com/grafana/k6",
326+
"license": "AGPL-3.0",
327+
"name": "k6",
328+
"owner": "grafana",
329+
"public": true,
330+
"topics": [
331+
"es6",
332+
"go",
333+
"golang",
334+
"hacktoberfest",
335+
"javascript",
336+
"load-generator",
337+
"load-testing",
338+
"performance"
339+
],
340+
"url": "https://github.com/grafana/k6",
341+
"versions": [
342+
"v0.53.0",
343+
"v0.52.0",
344+
"v0.51.0",
345+
"v0.50.0",
346+
"v0.49.0",
347+
"v0.48.0",
348+
"v0.47.0",
349+
"v0.46.0",
350+
"v0.45.1",
351+
"v0.45.0",
352+
"v0.44.1",
353+
"v0.44.0",
354+
"v0.43.1",
355+
"v0.43.0",
356+
"v0.42.0",
357+
"v0.41.0",
358+
"v0.40.0",
359+
"v0.39.0",
360+
"v0.38.3",
361+
"v0.38.2",
362+
"v0.38.1",
363+
"v0.38.0",
364+
"v0.37.0",
365+
"v0.36.0",
366+
"v0.35.0",
367+
"v0.34.1",
368+
"v0.34.0",
369+
"v0.33.0",
370+
"v0.32.0",
371+
"v0.31.1",
372+
"v0.31.0",
373+
"v0.30.0",
374+
"v0.29.0",
375+
"v0.28.0",
376+
"v0.27.1",
377+
"v0.27.0",
378+
"v0.26.2",
379+
"v0.26.1",
380+
"v0.26.0",
381+
"v0.25.1",
382+
"v0.25.0",
383+
"v0.24.0",
384+
"v0.23.1",
385+
"v0.23.0",
386+
"v0.22.1",
387+
"v0.22.0",
388+
"v0.21.1",
389+
"v0.21.0",
390+
"v0.20.0",
391+
"v0.19.0",
392+
"v0.18.2",
393+
"v0.18.1",
394+
"v0.18.0",
395+
"v0.17.2",
396+
"v0.17.1",
397+
"v0.17.0",
398+
"v0.16.0",
399+
"v0.15.0",
400+
"v0.14.0",
401+
"v0.13.0",
402+
"v0.12.2",
403+
"v0.12.1",
404+
"v0.11.0",
405+
"v0.10.0",
406+
"v0.9.3",
407+
"v0.9.2",
408+
"v0.9.1",
409+
"v0.9.0",
410+
"v0.8.5",
411+
"v0.8.4",
412+
"v0.8.3",
413+
"v0.8.2",
414+
"v0.8.1",
415+
"v0.8.0",
416+
"v0.7.0",
417+
"v0.6.0",
418+
"v0.5.2",
419+
"v0.5.1",
420+
"v0.5.0",
421+
"v0.4.5",
422+
"v0.4.4",
423+
"v0.4.3",
424+
"v0.4.2",
425+
"v0.4.1",
426+
"v0.4.0",
427+
"v0.3.0",
428+
"v0.2.1",
429+
"v0.2.0",
430+
"v0.0.2",
431+
"v0.0.1"
432+
]
433+
},
434+
"tier": "official"
435+
}
436+
]```
60437

61438
</details>
62439

0 commit comments

Comments
 (0)