From fa5866b43b47ca31ac0745a8bde2247670beb9b1 Mon Sep 17 00:00:00 2001 From: Fernandez Ludovic Date: Mon, 24 Mar 2025 20:16:12 +0100 Subject: [PATCH] docs: add example of the field version --- docs/src/docs/product/migration-guide.mdx | 4 ++++ docs/src/docs/usage/configuration.mdx | 8 ++++++++ 2 files changed, 12 insertions(+) diff --git a/docs/src/docs/product/migration-guide.mdx b/docs/src/docs/product/migration-guide.mdx index 0b685ec20c74..963e1dd724fd 100644 --- a/docs/src/docs/product/migration-guide.mdx +++ b/docs/src/docs/product/migration-guide.mdx @@ -2007,6 +2007,10 @@ severity: The `version` property has been added to the configuration file. +```yaml +version: "2" +``` + ### Integration #### VSCode diff --git a/docs/src/docs/usage/configuration.mdx b/docs/src/docs/usage/configuration.mdx index 276480ad7d7c..17c1cb909f39 100644 --- a/docs/src/docs/usage/configuration.mdx +++ b/docs/src/docs/usage/configuration.mdx @@ -42,6 +42,14 @@ The configuration file can be validated with the JSON Schema: https://golangci-l { .ConfigurationExample } +### Configuration Version + +```yaml +# Defines the configuration version. +# The only possible value is "2". +version: "2" +``` + ## Command-Line Options ### run