Merge pull request #304 from grafana/303-bug-xk6-lint-exit-code-is-always-0-on-failure

Correct exit code for xk6 lint command

Author: szkiba

docs/workflows/README.md

@@ -271,7 +271,9 @@ The **Extension Validate** ([`extension-validate.yml`](../../.github/workflows/e
       xk6-lint-disable:
         description: xk6 lint checks to disable.
         required: false
-        default: "security,vulnerability" # disable because they are run in a separate job
+        # disable security and vulnerability checks because they are run in a separate job
+        # disable versions check because versions will be created in the release workflow
+        default: "security,vulnerability,versions"
         type: string
       xk6-lint-enable-only:
         description: xk6 lint checks to enable exclusively (disables the preset).

examples/README.md

@@ -9,7 +9,7 @@ xk6 new -d "Experimenting with k6 extensions" example.com/user/xk6-demo
 ## Run the linter
 
 ```bash file=lint.sh
-xk6 lint
+xk6 lint --preset private
 ```
 
 ## Build k6 with extensions

examples/lint.sh

@@ -1 +1 @@
-xk6 lint
+xk6 lint --preset private

internal/cmd/lint.go

@@ -29,6 +29,8 @@ var (
 
 	//go:embed help/presets.md
 	presetsHelp string
+
+	errLintingFailed = errors.New("linting failed")
 )
 
 func validPresetIDs() []string {
@@ -238,17 +240,30 @@ func lintRunE(ctx context.Context, args []string, opts *options) (result error)
 		return err
 	}
 
+	if !compliance.Passed {
+		result = errLintingFailed
+	}
+
 	if opts.quiet {
-		return nil
+		return result
 	}
 
-	if opts.json {
-		return jsonOutput(compliance, output, opts.compact)
+	err = lintOutput(opts.json, compliance, output, opts.compact)
+	if err != nil {
+		return err
 	}
 
-	textOutput(compliance, output)
+	return result
+}
 
-	return nil
+func lintOutput(json bool, compliance *lint.Compliance, output io.Writer, compact bool) error {
+	if !json {
+		textOutput(compliance, output)
+
+		return nil
+	}
+
+	return jsonOutput(compliance, output, compact)
 }
 
 func jsonOutput(compliance any, output io.Writer, compact bool) error {

it

@@ -0,0 +1,7 @@
+Grafana **xk6** `v1.2.2` is here! 🎉
+
+This small patch release fixes a critical issue with the exit code of the `xk6 lint` command. This bug was introduced in `v1.2.0`.
+
+### Bug Fix
+
+* **Corrected `xk6 lint` Exit Code:** The `xk6 lint` command now correctly returns a **non-zero exit code (e.g., `1`)** when one or more lint checks fail. Previously, the command always returned `0`, making it impossible for CI/CD pipelines (like GitHub Actions) to correctly detect linting failures and fail the build.