From 6ec9f069930e3261288c8eb2ea57ee6d612502c7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Iv=C3=A1n=20SZKIBA?= Date: Fri, 30 Aug 2024 14:44:55 +0200 Subject: [PATCH] docs: fix example.json --- CONTRIBUTING.md | 1 + README.md | 379 +++++++++++++++++++++++++++++++++++++++++++++- docs/example.json | 378 +++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 757 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 179153e..23752b7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -53,6 +53,7 @@ go-jsonschema --capitalization URL --capitalization OSS -p k6registry --only-mod The example registry can be found in [example.yaml] file, the documentation ([registry.md], [README.md]) must be updated after modification. ```bash +go run ./cmd/k6registry --lint -o docs/example.json go run ./cmd/k6registry --lint -o docs/example.json --api docs/example-api docs/example.yaml tree -n --noreport --filesfirst -o docs/example-api.txt docs/example-api mdcode update docs/registry.md diff --git a/README.md b/README.md index 0351e39..5bc6cea 100644 --- a/README.md +++ b/README.md @@ -56,7 +56,384 @@ Check [k6 Extension Registry Concept](docs/registry.md) for information on desig Registry generated from the source above. ```json file=docs/example.json -``` +[ + { + "categories": [ + "reporting", + "observability" + ], + "compliance": { + "grade": "C", + "level": 80 + }, + "description": "Web-based metrics dashboard for k6", + "module": "github.com/grafana/xk6-dashboard", + "outputs": [ + "dashboard" + ], + "products": [ + "oss" + ], + "repo": { + "clone_url": "https://github.com/grafana/xk6-dashboard.git", + "description": "A k6 extension that makes k6 metrics available on a web-based dashboard.", + "homepage": "https://github.com/grafana/xk6-dashboard", + "license": "AGPL-3.0", + "name": "xk6-dashboard", + "owner": "grafana", + "public": true, + "stars": 327, + "timestamp": 1719907965, + "topics": [ + "xk6", + "xk6-official", + "xk6-output-dashboard" + ], + "url": "https://github.com/grafana/xk6-dashboard", + "versions": [ + "v0.7.5", + "v0.7.4", + "v0.7.3", + "v0.7.3-alpha.1", + "v0.7.2", + "v0.7.1", + "v0.7.0", + "v0.7.0-apha.3", + "v0.7.0-alpha.5", + "v0.7.0-alpha.4", + "v0.7.0-alpha.3", + "v0.7.0-alpha.2", + "v0.7.0-alpha.1", + "v0.6.1", + "v0.6.0", + "v0.5.5", + "v0.5.4", + "v0.5.3", + "v0.5.2", + "v0.5.1", + "v0.5.0", + "v0.4.4", + "v0.4.3", + "v0.4.2", + "v0.4.1", + "v0.4.0", + "v0.3.2", + "v0.3.1", + "v0.3.0", + "v0.2.0", + "v0.1.3", + "v0.1.2", + "v0.1.1", + "v0.1.0" + ] + }, + "tier": "official" + }, + { + "categories": [ + "data" + ], + "compliance": { + "grade": "A", + "level": 100 + }, + "description": "Load test SQL Servers", + "imports": [ + "k6/x/sql" + ], + "module": "github.com/grafana/xk6-sql", + "products": [ + "cloud", + "oss" + ], + "repo": { + "clone_url": "https://github.com/grafana/xk6-sql.git", + "description": "k6 extension to load test RDBMSs (PostgreSQL, MySQL, MS SQL and SQLite3)", + "homepage": "https://github.com/grafana/xk6-sql", + "license": "Apache-2.0", + "name": "xk6-sql", + "owner": "grafana", + "public": true, + "stars": 106, + "timestamp": 1721400602, + "topics": [ + "k6", + "sql", + "xk6" + ], + "url": "https://github.com/grafana/xk6-sql", + "versions": [ + "v0.4.0", + "v0.3.0", + "v0.2.1", + "v0.2.0", + "v0.1.1", + "v0.1.0", + "v0.0.1" + ] + }, + "tier": "official" + }, + { + "categories": [ + "kubernetes" + ], + "compliance": { + "grade": "C", + "level": 80 + }, + "description": "Inject faults to test", + "imports": [ + "k6/x/disruptor" + ], + "module": "github.com/grafana/xk6-disruptor", + "products": [ + "oss" + ], + "repo": { + "clone_url": "https://github.com/grafana/xk6-disruptor.git", + "description": "Extension for injecting faults into k6 tests", + "homepage": "https://k6.io/docs/javascript-api/xk6-disruptor/", + "license": "AGPL-3.0", + "name": "xk6-disruptor", + "owner": "grafana", + "public": true, + "stars": 88, + "timestamp": 1724358828, + "topics": [ + "chaos-engineering", + "fault-injection", + "k6", + "testing", + "xk6" + ], + "url": "https://github.com/grafana/xk6-disruptor", + "versions": [ + "v0.3.11", + "v0.3.10", + "v0.3.9", + "v0.3.8", + "v0.3.7", + "v0.3.6", + "v0.3.5", + "v0.3.5-rc2", + "v0.3.5-rc1", + "v0.3.4", + "v0.3.3", + "v0.3.2", + "v0.3.1", + "v0.3.0", + "v0.2.1", + "v0.2.0", + "v0.1.3", + "v0.1.2", + "v0.1.1", + "v0.1.0" + ] + }, + "tier": "official" + }, + { + "categories": [ + "data" + ], + "compliance": { + "grade": "A", + "level": 100 + }, + "description": "Generate random fake data", + "imports": [ + "k6/x/faker" + ], + "module": "github.com/szkiba/xk6-faker", + "products": [ + "oss" + ], + "repo": { + "clone_url": "https://github.com/szkiba/xk6-faker.git", + "description": "Random fake data generator for k6.", + "homepage": "http://ivan.szkiba.hu/xk6-faker/", + "license": "AGPL-3.0", + "name": "xk6-faker", + "owner": "szkiba", + "public": true, + "stars": 49, + "timestamp": 1719935566, + "topics": [ + "xk6", + "xk6-javascript-k6-x-faker" + ], + "url": "https://github.com/szkiba/xk6-faker", + "versions": [ + "v0.3.0", + "v0.3.0-alpha.1", + "v0.2.2", + "v0.2.1", + "v0.2.0", + "v0.1.0" + ] + }, + "tier": "community" + }, + { + "categories": [ + "misc" + ], + "compliance": { + "grade": "A", + "level": 100 + }, + "description": "Print ASCII art banner from k6 test", + "imports": [ + "k6/x/banner" + ], + "module": "gitlab.com/szkiba/xk6-banner", + "products": [ + "oss" + ], + "repo": { + "clone_url": "https://gitlab.com/szkiba/xk6-banner.git", + "description": "Print ASCII art banner from k6 test.", + "homepage": "https://gitlab.com/szkiba/xk6-banner", + "license": "MIT", + "name": "xk6-banner", + "owner": "szkiba", + "public": true, + "timestamp": 1724312566, + "topics": [ + "xk6" + ], + "url": "https://gitlab.com/szkiba/xk6-banner", + "versions": [ + "v0.1.0" + ] + }, + "tier": "community" + }, + { + "categories": [ + "misc" + ], + "description": "A modern load testing tool, using Go and JavaScript", + "module": "go.k6.io/k6", + "products": [ + "cloud", + "oss" + ], + "repo": { + "description": "A modern load testing tool, using Go and JavaScript - https://k6.io", + "homepage": "https://github.com/grafana/k6", + "license": "AGPL-3.0", + "name": "k6", + "owner": "grafana", + "public": true, + "topics": [ + "es6", + "go", + "golang", + "hacktoberfest", + "javascript", + "load-generator", + "load-testing", + "performance" + ], + "url": "https://github.com/grafana/k6", + "versions": [ + "v0.53.0", + "v0.52.0", + "v0.51.0", + "v0.50.0", + "v0.49.0", + "v0.48.0", + "v0.47.0", + "v0.46.0", + "v0.45.1", + "v0.45.0", + "v0.44.1", + "v0.44.0", + "v0.43.1", + "v0.43.0", + "v0.42.0", + "v0.41.0", + "v0.40.0", + "v0.39.0", + "v0.38.3", + "v0.38.2", + "v0.38.1", + "v0.38.0", + "v0.37.0", + "v0.36.0", + "v0.35.0", + "v0.34.1", + "v0.34.0", + "v0.33.0", + "v0.32.0", + "v0.31.1", + "v0.31.0", + "v0.30.0", + "v0.29.0", + "v0.28.0", + "v0.27.1", + "v0.27.0", + "v0.26.2", + "v0.26.1", + "v0.26.0", + "v0.25.1", + "v0.25.0", + "v0.24.0", + "v0.23.1", + "v0.23.0", + "v0.22.1", + "v0.22.0", + "v0.21.1", + "v0.21.0", + "v0.20.0", + "v0.19.0", + "v0.18.2", + "v0.18.1", + "v0.18.0", + "v0.17.2", + "v0.17.1", + "v0.17.0", + "v0.16.0", + "v0.15.0", + "v0.14.0", + "v0.13.0", + "v0.12.2", + "v0.12.1", + "v0.11.0", + "v0.10.0", + "v0.9.3", + "v0.9.2", + "v0.9.1", + "v0.9.0", + "v0.8.5", + "v0.8.4", + "v0.8.3", + "v0.8.2", + "v0.8.1", + "v0.8.0", + "v0.7.0", + "v0.6.0", + "v0.5.2", + "v0.5.1", + "v0.5.0", + "v0.4.5", + "v0.4.4", + "v0.4.3", + "v0.4.2", + "v0.4.1", + "v0.4.0", + "v0.3.0", + "v0.2.1", + "v0.2.0", + "v0.0.2", + "v0.0.1" + ] + }, + "tier": "official" + } +]``` diff --git a/docs/example.json b/docs/example.json index e69de29..70fb3e1 100644 --- a/docs/example.json +++ b/docs/example.json @@ -0,0 +1,378 @@ +[ + { + "categories": [ + "reporting", + "observability" + ], + "compliance": { + "grade": "C", + "level": 80 + }, + "description": "Web-based metrics dashboard for k6", + "module": "github.com/grafana/xk6-dashboard", + "outputs": [ + "dashboard" + ], + "products": [ + "oss" + ], + "repo": { + "clone_url": "https://github.com/grafana/xk6-dashboard.git", + "description": "A k6 extension that makes k6 metrics available on a web-based dashboard.", + "homepage": "https://github.com/grafana/xk6-dashboard", + "license": "AGPL-3.0", + "name": "xk6-dashboard", + "owner": "grafana", + "public": true, + "stars": 327, + "timestamp": 1719907965, + "topics": [ + "xk6", + "xk6-official", + "xk6-output-dashboard" + ], + "url": "https://github.com/grafana/xk6-dashboard", + "versions": [ + "v0.7.5", + "v0.7.4", + "v0.7.3", + "v0.7.3-alpha.1", + "v0.7.2", + "v0.7.1", + "v0.7.0", + "v0.7.0-apha.3", + "v0.7.0-alpha.5", + "v0.7.0-alpha.4", + "v0.7.0-alpha.3", + "v0.7.0-alpha.2", + "v0.7.0-alpha.1", + "v0.6.1", + "v0.6.0", + "v0.5.5", + "v0.5.4", + "v0.5.3", + "v0.5.2", + "v0.5.1", + "v0.5.0", + "v0.4.4", + "v0.4.3", + "v0.4.2", + "v0.4.1", + "v0.4.0", + "v0.3.2", + "v0.3.1", + "v0.3.0", + "v0.2.0", + "v0.1.3", + "v0.1.2", + "v0.1.1", + "v0.1.0" + ] + }, + "tier": "official" + }, + { + "categories": [ + "data" + ], + "compliance": { + "grade": "A", + "level": 100 + }, + "description": "Load test SQL Servers", + "imports": [ + "k6/x/sql" + ], + "module": "github.com/grafana/xk6-sql", + "products": [ + "cloud", + "oss" + ], + "repo": { + "clone_url": "https://github.com/grafana/xk6-sql.git", + "description": "k6 extension to load test RDBMSs (PostgreSQL, MySQL, MS SQL and SQLite3)", + "homepage": "https://github.com/grafana/xk6-sql", + "license": "Apache-2.0", + "name": "xk6-sql", + "owner": "grafana", + "public": true, + "stars": 106, + "timestamp": 1721400602, + "topics": [ + "k6", + "sql", + "xk6" + ], + "url": "https://github.com/grafana/xk6-sql", + "versions": [ + "v0.4.0", + "v0.3.0", + "v0.2.1", + "v0.2.0", + "v0.1.1", + "v0.1.0", + "v0.0.1" + ] + }, + "tier": "official" + }, + { + "categories": [ + "kubernetes" + ], + "compliance": { + "grade": "C", + "level": 80 + }, + "description": "Inject faults to test", + "imports": [ + "k6/x/disruptor" + ], + "module": "github.com/grafana/xk6-disruptor", + "products": [ + "oss" + ], + "repo": { + "clone_url": "https://github.com/grafana/xk6-disruptor.git", + "description": "Extension for injecting faults into k6 tests", + "homepage": "https://k6.io/docs/javascript-api/xk6-disruptor/", + "license": "AGPL-3.0", + "name": "xk6-disruptor", + "owner": "grafana", + "public": true, + "stars": 88, + "timestamp": 1724358828, + "topics": [ + "chaos-engineering", + "fault-injection", + "k6", + "testing", + "xk6" + ], + "url": "https://github.com/grafana/xk6-disruptor", + "versions": [ + "v0.3.11", + "v0.3.10", + "v0.3.9", + "v0.3.8", + "v0.3.7", + "v0.3.6", + "v0.3.5", + "v0.3.5-rc2", + "v0.3.5-rc1", + "v0.3.4", + "v0.3.3", + "v0.3.2", + "v0.3.1", + "v0.3.0", + "v0.2.1", + "v0.2.0", + "v0.1.3", + "v0.1.2", + "v0.1.1", + "v0.1.0" + ] + }, + "tier": "official" + }, + { + "categories": [ + "data" + ], + "compliance": { + "grade": "A", + "level": 100 + }, + "description": "Generate random fake data", + "imports": [ + "k6/x/faker" + ], + "module": "github.com/szkiba/xk6-faker", + "products": [ + "oss" + ], + "repo": { + "clone_url": "https://github.com/szkiba/xk6-faker.git", + "description": "Random fake data generator for k6.", + "homepage": "http://ivan.szkiba.hu/xk6-faker/", + "license": "AGPL-3.0", + "name": "xk6-faker", + "owner": "szkiba", + "public": true, + "stars": 49, + "timestamp": 1719935566, + "topics": [ + "xk6", + "xk6-javascript-k6-x-faker" + ], + "url": "https://github.com/szkiba/xk6-faker", + "versions": [ + "v0.3.0", + "v0.3.0-alpha.1", + "v0.2.2", + "v0.2.1", + "v0.2.0", + "v0.1.0" + ] + }, + "tier": "community" + }, + { + "categories": [ + "misc" + ], + "compliance": { + "grade": "A", + "level": 100 + }, + "description": "Print ASCII art banner from k6 test", + "imports": [ + "k6/x/banner" + ], + "module": "gitlab.com/szkiba/xk6-banner", + "products": [ + "oss" + ], + "repo": { + "clone_url": "https://gitlab.com/szkiba/xk6-banner.git", + "description": "Print ASCII art banner from k6 test.", + "homepage": "https://gitlab.com/szkiba/xk6-banner", + "license": "MIT", + "name": "xk6-banner", + "owner": "szkiba", + "public": true, + "timestamp": 1724312566, + "topics": [ + "xk6" + ], + "url": "https://gitlab.com/szkiba/xk6-banner", + "versions": [ + "v0.1.0" + ] + }, + "tier": "community" + }, + { + "categories": [ + "misc" + ], + "description": "A modern load testing tool, using Go and JavaScript", + "module": "go.k6.io/k6", + "products": [ + "cloud", + "oss" + ], + "repo": { + "description": "A modern load testing tool, using Go and JavaScript - https://k6.io", + "homepage": "https://github.com/grafana/k6", + "license": "AGPL-3.0", + "name": "k6", + "owner": "grafana", + "public": true, + "topics": [ + "es6", + "go", + "golang", + "hacktoberfest", + "javascript", + "load-generator", + "load-testing", + "performance" + ], + "url": "https://github.com/grafana/k6", + "versions": [ + "v0.53.0", + "v0.52.0", + "v0.51.0", + "v0.50.0", + "v0.49.0", + "v0.48.0", + "v0.47.0", + "v0.46.0", + "v0.45.1", + "v0.45.0", + "v0.44.1", + "v0.44.0", + "v0.43.1", + "v0.43.0", + "v0.42.0", + "v0.41.0", + "v0.40.0", + "v0.39.0", + "v0.38.3", + "v0.38.2", + "v0.38.1", + "v0.38.0", + "v0.37.0", + "v0.36.0", + "v0.35.0", + "v0.34.1", + "v0.34.0", + "v0.33.0", + "v0.32.0", + "v0.31.1", + "v0.31.0", + "v0.30.0", + "v0.29.0", + "v0.28.0", + "v0.27.1", + "v0.27.0", + "v0.26.2", + "v0.26.1", + "v0.26.0", + "v0.25.1", + "v0.25.0", + "v0.24.0", + "v0.23.1", + "v0.23.0", + "v0.22.1", + "v0.22.0", + "v0.21.1", + "v0.21.0", + "v0.20.0", + "v0.19.0", + "v0.18.2", + "v0.18.1", + "v0.18.0", + "v0.17.2", + "v0.17.1", + "v0.17.0", + "v0.16.0", + "v0.15.0", + "v0.14.0", + "v0.13.0", + "v0.12.2", + "v0.12.1", + "v0.11.0", + "v0.10.0", + "v0.9.3", + "v0.9.2", + "v0.9.1", + "v0.9.0", + "v0.8.5", + "v0.8.4", + "v0.8.3", + "v0.8.2", + "v0.8.1", + "v0.8.0", + "v0.7.0", + "v0.6.0", + "v0.5.2", + "v0.5.1", + "v0.5.0", + "v0.4.5", + "v0.4.4", + "v0.4.3", + "v0.4.2", + "v0.4.1", + "v0.4.0", + "v0.3.0", + "v0.2.1", + "v0.2.0", + "v0.0.2", + "v0.0.1" + ] + }, + "tier": "official" + } +] \ No newline at end of file