Skip to content

Latest commit

 

History

History
130 lines (90 loc) · 4.3 KB

README.md

File metadata and controls

130 lines (90 loc) · 4.3 KB
Raw

k6registry

Data model and tooling for the k6 extension registry

This repository contains the JSON schema of the k6 extension registry and the k6registry command line tool for registry processing. The command line tool can also be used as a GitHub Action.

Check k6 Extension Registry Concept for information on design considerations.

Example registry

- module: github.com/grafana/xk6-dashboard
  description: Web-based metrics dashboard for k6
  outputs:
    - dashboard
  official: true

- module: github.com/grafana/xk6-sql
  description: Load test SQL Servers
  imports:
    - k6/x/sql
  cloud: true
  official: true

- module: github.com/grafana/xk6-disruptor
  description: Inject faults to test
  imports:
    - k6/x/disruptor
  official: true

- module: github.com/szkiba/xk6-faker
  description: Generate random fake data
  imports:
    - k6/x/faker

A legacy extension registry converted to the new format is also a good example.

Install

Precompiled binaries can be downloaded and installed from the Releases page.

If you have a go development environment, the installation can also be done with the following command:

go install github.com/grafana/k6registry/cmd/k6registry@latest

GitHub Action

grafana/k6registry is a GitHub Action that enables k6 extension registry processing and the generation of customized JSON output for different applications. Processing is based on popular jq expressions using an embedded jq implementation.

The jq filter expression can be specified in the filter parameter.

The extension registry is read from the YAML format file specified in the in parameter.

Repository metadata is collected using the repository manager APIs. Currently only the GitHub API is supported.

The output of the processing will be written to the standard output by default. The output can be saved to a file using the out parameter.

Parameters

name reqired default description
filter no . jq compatible filter
in yes input file name
out no stdout output file name
mute no false no output, only validation
loose no false skip JSON schema validation
lint no false enable built-in linter
compact no false compact instead of pretty-printed output
raw no false output raw strings, not JSON texts
yaml no false output YAML instead of JSON

Example usage

- name: Generate registry in JSON format
  uses: grafana/[email protected]
  with:
    in: "registry.yaml"
    out: "registry.json"
    filter: "."

CLI

k6registry

k6 extension registry processor

Synopsis

Command line k6 extension registry processor.

k6registry is a command line tool that enables k6 extension registry processing and the generation of customized JSON output for different applications. Processing is based on popular jq expressions using an embedded jq implementation.

The first argument is the jq filter expression. This is the basis for processing.

The extension registry is read from the YAML format file specified in the second argument. If it is missing, the extension registry is read from the standard input.

Repository metadata is collected using the repository manager APIs. Currently only the GitHub API is supported.

The output of the processing will be written to the standard output by default. The output can be saved to a file using the -o/--out flag.

k6registry [flags] <jq filter> [file]

Flags

  -o, --out string   write output to file instead of stdout
  -m, --mute         no output, only validation
      --loose        skip JSON schema validation
      --lint         enable built-in linter
  -c, --compact      compact instead of pretty-printed output
  -r, --raw          output raw strings, not JSON texts
  -y, --yaml         output YAML instead of JSON
  -V, --version      print version
  -h, --help         help for k6registry

Contribure

If you want to contribute, start by reading CONTRIBUTING.md.