SIGN IN SIGN UP

docs(vrl): Automatically generate VRL function documentation (#24719)

* Add generation of cue files from vrl Function

* Use __mock_return_values_for_tests to show mocked examples

* Handle kind::any

* Replace generate-component-docs with generate-docs

* Bump VRL

* chore(vrl): Bump vrl and add return_kind to functions

* Enable all features for vector-vrl-functions

* Add stubs and implement new params

* Bump vrl and unstub pure

* Bump vrl and unstub notices

* Trim strings

* chore(vrl): Bump VRL and implement category for functions

* Use .category()

* chore(vrl): bump VRL and use Parameter builder

* Add .enum_variants to aggregate_vector_metrics

* Add missing import

* Add support for enum_variants

* Add Raises block to remap rendering

* Bump vrl

* Fix clippy

* Install protoc when compiling vdev

* Add generated files

* Format json using 4 spaces instead of 2

* Ignore VRL generated docs from cue fmt

* Revert "Format json using 4 spaces instead of 2"

This reverts commit ad2a14b72f3f0a9a1c2e63660126e098bf2cbd39.

* Push newline at the end of generated json

* Bump VRL

* Add preserve_order to keep doc generation consistent

* Render input

* Regenerate docs

* Use IndexMap to preserve enum ordering

* Regenerate docs with enum ordering

* Fix cue schema

* Remove .log when rendering VRL examples' input

* Fix clippy

* Format cue

* Add base64 encoded letters to spellcheck ignore

* Add all unrecognized words to expect.txt

* Update input to json value

* Use branch VRL and use VRL generation code

* Bump branch sha

* Add generate-vrl-docs to check-docs

* Add amplify.yml

* Use __doc_paths

* Bump version

* Update licenses

* Use . appRoot

* Bump VRL

* Generate docs to docs/generated

* Generate docs

* Rename vrl-docs to vector-vrl-docs

* Generate Vector VRL and VRL docs using make generate-vrl-docs

* Revert to prod amplify.yml

* Add VECTOR_SHA override

* Download latest vdev in amplify.yml

* Install vdev from source

* All in one compilation/copy

* Add check_type_only: false

* Compile debug instead of release

* Format

* Fix check-docs check

* Revert changes to expect.txt

* Update changes.yml

* Add sticky comment workflow

* Update docs/generated/README.md

Co-authored-by: Bryce Eadie <bryce.eadie@datadoghq.com>

* Regenerate docs

* Make check-generated-vrl-docs always run

* Use needs.*.result and check for failure/cancelled

* Revert "Regenerate docs"

This reverts commit 896918e1cbc239b63f113b7bb386d34db682f0f8.

* Use --vector-sha inside CI to ensure docs freshness

* Revert "Use --vector-sha inside CI to ensure docs freshness"

This reverts commit cc1d474f1c8ba062579186f58c5b6f43c08f74b7.

* Add --vector-sha to generate-vector-vrl-docs step

* Revert "Add --vector-sha to generate-vector-vrl-docs step"

This reverts commit 88c939ed22a4dbe1725539d1076e93bc5727fc54.

* Use --vector-sha when deploying the website

* Fix non CI make generate-vrl-docs

* Move sparse_checkout_docs to vdev/src/utils/git.rs

* Recompile vdev when there are changes to 'lib/vector-vrl/**'

* chore(dev): move VRL-specific crates under lib/vector-vrl/ (#24854)

* Update generated VRL docs

* Format

* Remove `_*_explainer`s

* Fix generated docs filters

* Add test doc change

* Update generated VRL docs

* Revert "Update generated VRL docs"

This reverts commit 6e359f70ec1ef8f14a56be9d2e8e66b59b4ffc59.

* Reapply "Update generated VRL docs"

This reverts commit f6517dac2bb4c6ed0cc2c5820acbbbfaeb0d7247.

* Delete amplify.yml

* Revert "Reapply "Update generated VRL docs""

This reverts commit a445e037e0534021053c7eff90ea989900009c59.

* Update generated VRL docs

* remove Hello from source code once and for all

* Optimize setup action

* Update generated VRL docs

* Fix potential head_ref injection

* Update generated VRL docs

* GHA trigger

* Fail check when out of date

* Update generated VRL docs

* ci-test: add foo-bar to find_enrichment_table_records example

* ci-test: make docs incorrect

* Update generated VRL docs

* Update vdev cache keys

* Update generated VRL docs

* Revert mock changes

* Update generated VRL docs

* GHA trigger

* Update warning comment

---------

Co-authored-by: Bryce Eadie <bryce.eadie@datadoghq.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
T
Thomas committed
b519edd97252ae1dab8210cfc3d164dadee16c9e
Parent: 2debb99
Committed by GitHub <noreply@github.com> on 3/7/2026, 6:41:20 PM