Skip to content

docs: sync k6 docs with code [automated] - #2283

Draft
cursor[bot] wants to merge 4 commits into
mainfrom
cursor/k6-docs-synchronization-16f4
Draft

docs: sync k6 docs with code [automated]#2283
cursor[bot] wants to merge 4 commits into
mainfrom
cursor/k6-docs-synchronization-16f4

Conversation

@cursor

@cursor cursor Bot commented Jul 22, 2026

Copy link
Copy Markdown

Clone summary: ✅ grafana/k6 cloned successfully to /tmp/k6 at commit 82b9d626fabe9b98279c79d2c37166f23bcd0761 (k6 v2.1.0).

What?

The same corrections were applied to docs/sources/k6/next/ and docs/sources/k6/v2.1.x/. Each {next,v2.1.x} path below identifies both changed files.

  • docs/sources/k6/{next,v2.1.x}/examples/get-started-with-k6/test-for-performance.md — The threshold abort output said breached; source says crossed. Source: internal/metrics/engine/engine.go:181-183.
  • docs/sources/k6/{next,v2.1.x}/extensions/create/output-extensions.md — Examples used the removed --no-summary flag; they now use --summary-mode=disabled. Source: internal/cmd/runtime_options.go:33-35.
  • docs/sources/k6/{next,v2.1.x}/extensions/create/secret-source_extensions.md — Examples used the removed --no-summary flag; they now use --summary-mode=disabled. Source: internal/cmd/runtime_options.go:33-35.
  • docs/sources/k6/{next,v2.1.x}/javascript-api/jslib/k6chaijs/error-handling.md — The JSON parsing example reported character 2 instead of character 1. Source: js/modules/k6/http/response.go:29-37.
  • docs/sources/k6/{next,v2.1.x}/reference/archive.md — The archive tree still used obsolete files/ and scripts/ prefixes and stale metadata fields. It now uses file/ and https/ and reflects the v2.1 metadata schema. Source: lib/archive.go:47-79, lib/archive.go:270-360, and lib/options.go:232-350.
  • docs/sources/k6/{next,v2.1.x}/reference/k6-rest-api.md — Status fields were incomplete, live VU updates were incorrectly documented, Run Setup had the wrong method, Update Setup had the wrong request envelope, and POST /v1/teardown was missing. Source: api/v1/status.go:9-18, api/v1/status_routes.go:25-70, api/v1/routes.go:60-80, and api/v1/setup_teardown_routes.go:43-88.
  • docs/sources/k6/{next,v2.1.x}/release-notes/v2.1.0.md — Removed the description of the still-experimental native-histograms capability while preserving the feature-flag system release note. Source: internal/features/features.go:42-45.
  • docs/sources/k6/{next,v2.1.x}/results-output/end-of-test/_index.md — The page listed removed legacy and --no-summary choices instead of disabled. Source: internal/lib/summary/summary.go:15-27 and internal/cmd/runtime_options.go:33-35.
  • docs/sources/k6/{next,v2.1.x}/results-output/end-of-test/custom-summary.md — The new summary format was incorrectly described as becoming the v2 default, the legacy textSummary() layout was called the built-in default, and the machine-readable/legacy schemas were conflated. Source: internal/cmd/runtime_options.go:41-43, internal/js/summary-wrapper.js:36-77, and internal/lib/summary/machinereadable/types_gen.go:625-633.
  • docs/sources/k6/{next,v2.1.x}/results-output/grafana-dashboards.md — Removed the native-histogram dashboard path because the underlying k6 behavior remains feature-gated. Source: internal/features/features.go:42-45 and internal/output/prometheusrw/remotewrite/remotewrite.go:47-51.
  • docs/sources/k6/{next,v2.1.x}/results-output/real-time/prometheus-remote-write.md — Removed native-histogram setup, options, and dashboard guidance because the capability remains behind the experimental native-histograms flag. Source: internal/features/features.go:42-45 and internal/output/prometheusrw/remotewrite/remotewrite.go:47-51.
  • docs/sources/k6/{next,v2.1.x}/set-up/set-up-distributed-k6/troubleshooting.md — Removed a stale CSV-based --tag parsing error that no longer matches the StringArray parser. Source: internal/cmd/options.go:218-228 and internal/cmd/options.go:251-267.
  • docs/sources/k6/{next,v2.1.x}/testing-guides/api-load-testing.md — Replaced obsolete some thresholds have failed output with the current crossed-metrics message. Source: internal/cmd/run.go:357-366.
  • docs/sources/k6/{next,v2.1.x}/testing-guides/injecting-faults-with-xk6-disruptor/examples/inject-http-faults-into-pod.md — Commands used removed --summary-mode=legacy; they now use compact. Source: internal/lib/summary/summary.go:15-27.
  • docs/sources/k6/{next,v2.1.x}/testing-guides/running-large-tests.md — Commands used removed --no-summary; they now use --summary-mode=disabled. Source: internal/cmd/runtime_options.go:33-35.
  • docs/sources/k6/{next,v2.1.x}/using-k6/assertions.md — The command used removed --no-summary; it now uses --summary-mode=disabled. Source: internal/cmd/runtime_options.go:33-35.
  • docs/sources/k6/{next,v2.1.x}/using-k6/feature-flags.md — Removed descriptions and examples for concrete still-flagged capabilities while retaining generic flag discovery and configuration guidance. Source: internal/features/features.go:42-45.
  • docs/sources/k6/{next,v2.1.x}/using-k6/k6-options/reference.md — Replaced the concrete experimental feature example and added the missing --new-machine-readable-summary option, environment variable, and default. Source: internal/features/features.go:42-45 and internal/cmd/runtime_options.go:41-43,77-86,130-133.

Validation:

  • git diff --check main...HEAD
  • ESLint on every changed Markdown file: 0 errors (release-note files are ignored by the repository configuration)
  • Generated and inspected an archive with the cloned v2.1 source to verify its tar layout and metadata.json
  • Built the cloned source and verified --summary-mode=disabled in a test run
  • Verified all changed next files match their v2.1.x counterparts

md-k6.py was also attempted. It reached unchanged assertion examples, then stopped because the existing {{< param "JSLIB_TESTING_VERSION" >}} shortcode wasn't resolved by the standalone runner.

Checklist

  • I have used a meaningful title for the PR.
  • I have described the changes I've made in the "What?" section above.
  • I have performed a self-review of my changes.
  • I have run the npm start command locally and verified that the changes look good.
  • I have made my changes in the docs/sources/k6/next folder of the documentation.
  • I have reflected my changes in the docs/sources/k6/v2.1.x folder of the documentation.
  • I have reflected my changes in the relevant folders of the two previous k6 versions (not applicable to this v2.1 source synchronization).

Related PR(s)/Issue(s)

Automated weekly source synchronization.

Open in Web View Automation 

cursoragent and others added 3 commits July 22, 2026 20:58
Co-authored-by: Heitor Tashiro Sergent <heitortsergent@gmail.com>
Co-authored-by: Heitor Tashiro Sergent <heitortsergent@gmail.com>
Co-authored-by: Heitor Tashiro Sergent <heitortsergent@gmail.com>
@cla-assistant

cla-assistant Bot commented Jul 22, 2026

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

1 similar comment
@cla-assistant

cla-assistant Bot commented Jul 22, 2026

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@github-actions

github-actions Bot commented Jul 22, 2026

Copy link
Copy Markdown
Contributor

🔴 🔴 🔴 This PR introduces the following broken links: 🔴 🔴 🔴

File Broken link
docs/sources/k6/v2.1.x/set-up/set-up-distributed-k6/troubleshooting.md /docs/k6/latest/set-up/set-up-distributed-k6/usage/executing-k6-scripts-with-testrun-crd/
docs/sources/k6/v2.1.x/set-up/set-up-distributed-k6/troubleshooting.md /docs/k6/latest/set-up/set-up-distributed-k6/usage/k6-operator-to-gck6/

Questions? Ask in #docs-platform. (eb4dba7)

@github-actions

github-actions Bot commented Jul 22, 2026

Copy link
Copy Markdown
Contributor

Co-authored-by: Heitor Tashiro Sergent <heitortsergent@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant