Artifact fingerprinting in Jenkins - Step-by-Step Execution

Process Flow - Artifact fingerprinting

Build Artifact Created

↓

Generate Fingerprint (hash)

↓

Store Fingerprint in Jenkins

↓

Use Fingerprint to Track Artifact

↓

Identify Artifact Usage Across Jobs

This flow shows how Jenkins creates a unique fingerprint for each artifact, stores it, and tracks its usage across builds.

Execution Sample

Jenkins

fingerprint('myapp.jar')
archiveArtifacts('myapp.jar')

This Jenkins pipeline snippet fingerprints the artifact 'myapp.jar' and archives it for tracking.

Process Table

Step	Action	Input	Output	System State Change
1	Build completes	myapp.jar created	Artifact file ready	Artifact file 'myapp.jar' exists in workspace
2	Generate fingerprint	myapp.jar	MD5 hash generated	Fingerprint stored in Jenkins fingerprint database
3	Archive artifact	myapp.jar	Artifact archived	Artifact archived and linked with fingerprint
4	Track usage	Fingerprint	Usage recorded	Fingerprint linked to current build and downstream jobs
5	End	N/A	N/A	Fingerprint tracking ready for queries

💡 Fingerprinting and archiving complete; artifact usage can now be tracked across builds.

Status Tracker

Variable	Start	After Step 2	After Step 3	Final
artifact_file	none	myapp.jar	myapp.jar	myapp.jar archived
fingerprint_hash	none	md5:abc123...	md5:abc123...	md5:abc123... linked
fingerprint_db	empty	contains md5:abc123...	contains md5:abc123...	contains md5:abc123... with usage

Key Moments - 3 Insights

Why do we generate a fingerprint for the artifact?

The fingerprint uniquely identifies the artifact by its content, allowing Jenkins to track it across different builds and jobs, as shown in step 2 of the execution table.

Does fingerprinting change the artifact file itself?

No, fingerprinting only reads the artifact to generate a hash; the artifact file remains unchanged, as seen in the variable 'artifact_file' staying the same after step 2.

How does Jenkins use the fingerprint after archiving?

Jenkins links the fingerprint to the archived artifact and records its usage in builds and downstream jobs, enabling traceability, as shown in steps 3 and 4.

Visual Quiz - 3 Questions

Look at the execution table, what is the output of step 2?

A MD5 hash generated

B Artifact archived

C Build completes

D Usage recorded

💡 Hint

Check the 'Output' column for step 2 in the execution table.

At which step does Jenkins link the fingerprint to the current build?

A Step 1

B Step 4

C Step 3

D Step 5

💡 Hint

Look at the 'System State Change' column for step 4.

If the artifact file changes, what happens to the fingerprint?

A Fingerprint is deleted

B Fingerprint stays the same

C Fingerprint is regenerated with a new hash

D Fingerprint is ignored

💡 Hint

Recall that fingerprint is a hash of the artifact content, so changes cause a new hash.

Concept Snapshot

Artifact fingerprinting in Jenkins:
- Generates a unique hash (fingerprint) for each artifact
- Fingerprint tracks artifact usage across builds
- Does not modify the artifact file
- Used with archiveArtifacts step
- Enables traceability and impact analysis

Full Transcript

Artifact fingerprinting in Jenkins means creating a unique hash for each build artifact. When a build finishes, Jenkins generates a fingerprint by hashing the artifact file content. This fingerprint is stored in Jenkins and linked to the artifact when archived. Jenkins then tracks where this artifact is used in other builds or jobs. This helps teams know which builds used or produced a specific artifact. The fingerprint does not change the artifact file itself. It is a way to identify and trace artifacts easily across the pipeline.

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