Pipeline linting and validation in Jenkins - Step-by-Step Execution

Process Flow - Pipeline linting and validation

Write Jenkinsfile

↓

Run Linter

↓

Check Syntax

↓

Run Validator

↓

Check Rules

↓

Pipeline Ready

↓

Repeat Validation

The Jenkins pipeline is written, then linted to check syntax. If syntax is OK, validation checks rules. Errors require fixing and repeating lint and validation.

Execution Sample

Jenkins

pipeline {
  agent any
  stages {
    stage('Build') {
      steps { echo 'Building...' }
    }
  }
}

A simple Jenkins pipeline script that defines a build stage with a step to print a message.

Process Table

Step	Action	Evaluation	Result
1	Run linter on Jenkinsfile	Check syntax correctness	Syntax OK
2	Run validator on Jenkinsfile	Check pipeline rules compliance	Rules OK
3	Pipeline ready for execution	No errors found	Success
4	If syntax error found	Report error	Fix syntax and rerun lint
5	If validation error found	Report rule violation	Fix rules and rerun validation

💡 Pipeline linting and validation stops when syntax and rules are both OK

Status Tracker

Variable	Start	After Lint	After Validation	Final
syntax_status	unknown	OK	OK	OK
validation_status	unknown	unknown	OK	OK
pipeline_ready	false	false	true	true

Key Moments - 3 Insights

Why does the pipeline fail even if the syntax is correct?

Because validation checks rules beyond syntax, like stage names or step usage. See execution_table row 2 where rules can fail even if syntax is OK.

What happens if the linter finds a syntax error?

The pipeline stops linting and reports the error. You must fix syntax before validation. Refer to execution_table row 4.

When is the pipeline considered ready to run?

Only after both linting and validation pass without errors, as shown in execution_table row 3.

Visual Quiz - 3 Questions

Look at the execution table, what is the result of step 1?

A Syntax OK

B Rules OK

C Fix syntax and rerun lint

D Pipeline ready

💡 Hint

Check the 'Result' column for step 1 in the execution_table

At which step does the pipeline become ready for execution?

A Step 1

B Step 2

C Step 3

D Step 4

💡 Hint

Look for 'Pipeline ready for execution' in the 'Action' column in execution_table

If a validation error occurs, what is the next action?

A Fix syntax and rerun lint

B Fix rules and rerun validation

C Pipeline ready

D Ignore and run pipeline

💡 Hint

See execution_table row 5 for validation error handling

Concept Snapshot

Pipeline linting and validation:
- Lint checks syntax correctness
- Validation checks pipeline rules
- Fix errors before proceeding
- Pipeline runs only if both pass
- Repeat lint/validation after fixes

Full Transcript

Pipeline linting and validation in Jenkins involves first writing the Jenkinsfile, then running a linter to check for syntax errors. If syntax is correct, a validator checks if the pipeline follows required rules. If any errors are found, they must be fixed and the linting and validation repeated. Only when both syntax and rules are OK is the pipeline ready to run.

Practice

1. What is the main purpose of pipeline linting in Jenkins?

easy

A. To create new Jenkins jobs automatically

B. To deploy the pipeline to production

C. To check Jenkinsfile syntax before running the pipeline

D. To monitor pipeline execution time

Solution

1. Step 1: Understand pipeline linting

   Pipeline linting checks the Jenkinsfile for syntax errors before execution.

2. Step 2: Identify the main goal

   This helps catch mistakes early, avoiding broken builds.

3. Final Answer:

   To check Jenkinsfile syntax before running the pipeline -> Option C

4. Quick Check:

   Pipeline linting = syntax check [OK]

Hint: Linting means syntax check before running [OK]

Common Mistakes:

• Confusing linting with deployment
• Thinking linting monitors runtime
• Assuming linting creates jobs

2. Which Jenkins CLI command is used to lint a Jenkinsfile?

easy

A. jenkins-cli lint-jenkinsfile

B. jenkins-cli pipeline-lint

C. jenkins-cli validate-pipeline

D. jenkins-cli pipeline-validate

Solution

1. Step 1: Recall Jenkins CLI lint command

   The correct command to lint Jenkinsfiles is pipeline-validate.

2. Step 2: Match exact command

   Among options, only jenkins-cli pipeline-validate is valid syntax.

3. Final Answer:

   jenkins-cli pipeline-validate -> Option D

4. Quick Check:

   CLI lint command = pipeline-validate [OK]

Hint: Use 'pipeline-validate' with Jenkins CLI to validate [OK]

Common Mistakes:

• Using incorrect command names
• Mixing validate and lint terms
• Adding extra words in command

3. What will be the output of this command if the Jenkinsfile has a syntax error?

jenkins-cli pipeline-validate Jenkinsfile

medium

A. Validation successful: No syntax errors found

B. Error: Syntax error found in Jenkinsfile

C. Pipeline executed successfully

D. No output is shown

Solution

1. Step 1: Understand pipeline-validate output

   If the Jenkinsfile has syntax errors, the validate command reports them as errors.

2. Step 2: Identify correct output message

   The command will output an error message indicating syntax problems.

3. Final Answer:

   Error: Syntax error found in Jenkinsfile -> Option B

4. Quick Check:

   Syntax error in Jenkinsfile = error output [OK]

Hint: Syntax errors cause error messages on lint command [OK]

Common Mistakes:

• Expecting success message despite errors
• Confusing lint with pipeline run output
• Assuming no output means error

4. You run jenkins-cli pipeline-validate Jenkinsfile but get a connection refused error. What is the likely cause?

medium

A. Jenkins server is not running or unreachable

B. Jenkinsfile has syntax errors

C. The pipeline-validate command is misspelled

D. The Jenkinsfile path is incorrect

Solution

1. Step 1: Analyze connection refused error

   This error means the CLI cannot connect to the Jenkins server.

2. Step 2: Rule out other causes

   Syntax errors or file path issues cause different errors, not connection refused.

3. Final Answer:

   Jenkins server is not running or unreachable -> Option A

4. Quick Check:

   Connection refused = server down/unreachable [OK]

Hint: Connection refused means Jenkins server unreachable [OK]

Common Mistakes:

• Blaming syntax errors for connection issues
• Assuming command typo causes connection refused
• Ignoring network/server status

5. You want to automate Jenkinsfile validation in a CI job before merging code. Which approach is best?

hard

A. Run jenkins-cli pipeline-validate command in the CI job script

B. Manually check Jenkinsfile syntax after merging

C. Run the pipeline and fix errors if it fails

D. Skip validation to save time

Solution

1. Step 1: Understand automation goal

   Automating validation before merging prevents broken pipelines early.

2. Step 2: Choose best method

   Running jenkins-cli pipeline-validate in CI script checks syntax automatically.

3. Final Answer:

   Run jenkins-cli pipeline-validate command in the CI job script -> Option A

4. Quick Check:

   Automate linting in CI = run pipeline-validate [OK]

Hint: Automate linting with CLI in CI jobs [OK]

Common Mistakes:

• Waiting to fix errors after merge
• Skipping validation to save time
• Relying on manual checks