Artifact fingerprinting in Jenkins - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is artifact fingerprinting in Jenkins?

Artifact fingerprinting is a process Jenkins uses to track files (artifacts) across builds by creating a unique identifier (fingerprint) for each file. This helps trace where files are used or produced.

beginner

How does Jenkins create a fingerprint for an artifact?

Jenkins creates a fingerprint by calculating a hash (like MD5) of the artifact file's content. This hash uniquely identifies the file regardless of its name or location.

intermediate

Why is artifact fingerprinting useful in a CI/CD pipeline?

It helps track which builds produced or used a specific artifact, enabling traceability, debugging, and ensuring the right versions of files are deployed.

beginner

How do you enable artifact fingerprinting in a Jenkins job?

In the Jenkins job configuration, under 'Post-build Actions', select 'Record fingerprints of files to track' and specify the files or patterns to fingerprint.

intermediate

What information can you find from a fingerprint record in Jenkins?

You can see which builds produced or used the artifact, the file's hash, and its history across jobs, helping to understand artifact flow.

What does Jenkins use to uniquely identify an artifact file?

A The file size

B The file name only

C A hash of the file content

D The build number

Jenkins uses a hash (like MD5) of the file content to create a unique fingerprint.

Where do you configure artifact fingerprinting in a Jenkins job?

A Post-build Actions

B Build Triggers

C Source Code Management

D Build Environment

Artifact fingerprinting is set up in the Post-build Actions section of the job configuration.

What is a main benefit of artifact fingerprinting?

A Speeding up build time

B Tracking artifact usage across builds

C Compressing artifacts

D Changing artifact names automatically

Fingerprinting helps track where artifacts are produced and used across builds.

Which of these is NOT true about artifact fingerprints?

A They depend on the file's location on disk

B They are based on file content

C They help trace artifact history

D They are stored in Jenkins for tracking

Fingerprints depend on file content, not location.

If two files have the same fingerprint, what does it mean?

A They are stored in the same folder

B They have the same file name

C They were created in the same build

D They have identical content

Same fingerprint means the files have identical content.

Explain how artifact fingerprinting helps in tracking files across Jenkins builds.

Think about how Jenkins knows which build created or used a file.

Describe the steps to enable artifact fingerprinting in a Jenkins job.

Where in the job settings do you add fingerprinting?

Practice

1. What is the main purpose of artifact fingerprinting in Jenkins?

easy

A. To uniquely track files across different builds

B. To speed up the build process

C. To automatically deploy artifacts to servers

D. To create backups of build logs

Solution

1. Step 1: Understand artifact fingerprinting concept

   Artifact fingerprinting is used to track files uniquely across Jenkins builds.

2. Step 2: Identify the main purpose

   Its main purpose is to know where files come from and where they are used, not speeding builds or deployment.

3. Final Answer:

   To uniquely track files across different builds -> Option A

4. Quick Check:

   Artifact fingerprinting = Unique file tracking [OK]

Hint: Fingerprinting tracks files uniquely across builds [OK]

Common Mistakes:

• Confusing fingerprinting with deployment
• Thinking it speeds up builds
• Assuming it backs up logs

2. Which Jenkins pipeline step is used to enable artifact fingerprinting for a file?

easy

A. archiveArtifacts 'file.txt'

B. publish 'file.txt'

C. stash 'file.txt'

D. fingerprint 'file.txt'

Solution

1. Step 1: Recall Jenkins pipeline steps for artifacts

   Common steps include archiveArtifacts, stash, fingerprint, and publish.

2. Step 2: Identify the step for fingerprinting

   The fingerprint step is specifically used to enable artifact fingerprinting on files.

3. Final Answer:

   fingerprint 'file.txt' -> Option D

4. Quick Check:

   Use fingerprint step to track files [OK]

Hint: Use fingerprint step with file path to track [OK]

Common Mistakes:

• Using archiveArtifacts instead of fingerprint
• Confusing stash with fingerprint
• Using publish which is unrelated

3. Given this Jenkins pipeline snippet:

pipeline {
  agent any
  stages {
    stage('Build') {
      steps {
        sh 'echo Hello > output.txt'
        fingerprint 'output.txt'
      }
    }
  }
}

What does the fingerprint 'output.txt' step do here?

medium

A. Deletes output.txt after the build

B. Creates a unique hash for output.txt to track it across builds

C. Copies output.txt to the workspace

D. Uploads output.txt to a remote server

Solution

1. Step 1: Analyze the pipeline snippet

   The pipeline creates a file output.txt and then fingerprints it.

2. Step 2: Understand fingerprint step effect

   The fingerprint step creates a unique hash for the file to track it across builds, not deleting or copying it.

3. Final Answer:

   Creates a unique hash for output.txt to track it across builds -> Option B

4. Quick Check:

   Fingerprint = unique hash tracking [OK]

Hint: Fingerprint creates unique hash for file tracking [OK]

Common Mistakes:

• Thinking fingerprint deletes files
• Assuming it copies files
• Confusing fingerprint with upload

4. You added fingerprint 'app.jar' in your Jenkins pipeline, but fingerprints are not generated. What is a likely cause?

medium

A. You must archive artifacts before fingerprinting

B. Fingerprinting requires a separate plugin installation

C. The file path 'app.jar' is incorrect or file does not exist

D. Fingerprinting only works on text files

Solution

1. Step 1: Check file existence for fingerprinting

   Fingerprinting requires the file to exist at the specified path during the build.

2. Step 2: Identify common causes for no fingerprints

   If the file path is wrong or file missing, fingerprinting won't generate fingerprints.

3. Final Answer:

   The file path 'app.jar' is incorrect or file does not exist -> Option C

4. Quick Check:

   File must exist for fingerprinting [OK]

Hint: Ensure file exists at path before fingerprinting [OK]

Common Mistakes:

• Assuming fingerprint needs extra plugin
• Thinking archiveArtifacts is mandatory before fingerprint
• Believing fingerprint only works on text files

5. In a Jenkins pipeline, you want to track multiple artifacts and find all builds that used them. Which approach correctly uses artifact fingerprinting for this?

hard

A. Use fingerprint '**/*.jar' after building all jar files

B. Archive artifacts first, then fingerprint only one file manually

C. Use stash for all files and fingerprint none

D. Fingerprint files only in the first build, skip others

Solution

1. Step 1: Understand tracking multiple artifacts

   To track multiple files, fingerprinting should be applied to all relevant files, e.g., using a pattern.

2. Step 2: Evaluate options for multiple files

   Using fingerprint '**/*.jar' fingerprints all jar files, enabling tracking across builds.

3. Final Answer:

   Use fingerprint '**/*.jar' after building all jar files -> Option A

4. Quick Check:

   Fingerprint all files with pattern for tracking [OK]

Hint: Fingerprint all files with a pattern to track multiple artifacts [OK]

Common Mistakes:

• Fingerprinting only one file when multiple exist
• Confusing stash with fingerprinting
• Skipping fingerprinting in later builds