Archiving artifacts in Jenkins - Step-by-Step Execution

Process Flow - Archiving artifacts

Build completes

↓

Identify artifacts

↓

Archive artifacts step

↓

Artifacts saved in Jenkins

↓

Artifacts available for download or later stages

After a build finishes, Jenkins identifies files to save, archives them, and makes them available for later use.

Execution Sample

Jenkins

pipeline {
  agent any
  stages {
    stage('Build') {
      steps {
        sh 'echo Hello > output.txt'
      }
    }
    stage('Archive') {
      steps {
        archiveArtifacts artifacts: 'output.txt'
      }
    }
  }
}

This Jenkins pipeline creates a file and archives it as a build artifact.

Process Table

Step	Action	File Created	Archive Step	Artifacts Stored
1	Start build	No	No	No
2	Run shell command: echo Hello > output.txt	output.txt created	No	No
3	Archive artifacts: output.txt	output.txt exists	Archive triggered	output.txt saved
4	Build complete	output.txt exists	Archived	Artifacts available

💡 Build finishes with output.txt archived as artifact

Status Tracker

Variable	Start	After Step 2	After Step 3	Final
output.txt file	Not present	Created	Archived	Archived and available

Key Moments - 2 Insights

Why do we need to archive artifacts after the build?

Archiving saves important files like logs or binaries so they can be accessed later, as shown in step 3 of the execution_table.

What happens if the file to archive does not exist?

The archive step will fail because Jenkins cannot find the file, so ensure the file is created before archiving, as seen between steps 2 and 3.

Visual Quiz - 3 Questions

Look at the execution table, at which step is the artifact actually saved?

A Step 1

B Step 2

C Step 3

D Step 4

💡 Hint

Check the 'Archive Step' and 'Artifacts Stored' columns in the execution_table at step 3.

According to variable_tracker, what is the state of output.txt after step 2?

A Not present

B Created

C Archived

D Deleted

💡 Hint

Look at the 'After Step 2' column for output.txt file in variable_tracker.

If the shell command did not create output.txt, what would happen at step 3?

A Archive step would fail

B Archive step would succeed anyway

C Build would skip archive step

D File would be created automatically

💡 Hint

Refer to key_moments about missing files before archiving.

Concept Snapshot

Jenkins archiving artifacts:
- After build, specify files to save
- Use archiveArtifacts step with file pattern
- Files saved with build for download or later use
- Fails if files missing
- Helps keep build outputs safe

Full Transcript

In Jenkins, archiving artifacts means saving files created during a build so they can be accessed later. The process starts after the build finishes. Jenkins looks for files you specify, like output.txt, and saves them with the build record. This is done using the archiveArtifacts step in the pipeline. If the file does not exist, the archive step will fail. Archiving is useful to keep logs, binaries, or reports safe and available for download or use in later pipeline stages.

Practice

1. What is the main purpose of using archiveArtifacts in a Jenkins pipeline?

easy

A. To delete old build files automatically

B. To save build output files for later use or sharing

C. To trigger another build job

D. To send email notifications after a build

Solution

1. Step 1: Understand the role of archiveArtifacts

   This command is used to save files generated by a build so they can be accessed later.

2. Step 2: Compare with other options

   Deleting files, triggering builds, or sending emails are different Jenkins features, not related to archiving artifacts.

3. Final Answer:

   To save build output files for later use or sharing -> Option B

4. Quick Check:

   Archiving = Saving build files [OK]

Hint: Archiving means saving build files for future use [OK]

Common Mistakes:

• Confusing archiving with deleting files
• Thinking it triggers other jobs
• Assuming it sends notifications

2. Which of the following is the correct syntax to archive all .jar files in a Jenkins pipeline script?

easy

A. archiveArtifacts '*.jar'

B. archiveArtifacts '*.jar;'

C. archiveArtifacts '*.jar' {}

D. archiveArtifacts '*.jar'()

Solution

1. Step 1: Recall the syntax of archiveArtifacts

   The correct syntax uses the command followed by the file pattern in quotes without extra characters.

2. Step 2: Identify incorrect syntax

   Options with semicolon, braces, or parentheses after the pattern are invalid in Jenkins pipeline syntax.

3. Final Answer:

   archiveArtifacts '*.jar' -> Option A

4. Quick Check:

   Correct syntax = archiveArtifacts 'pattern' [OK]

Hint: Use single quotes and no extra symbols after pattern [OK]

Common Mistakes:

• Adding semicolons inside the pattern string
• Using braces or parentheses incorrectly
• Missing quotes around the pattern

3. Given this Jenkins pipeline snippet:

stage('Build') {
  steps {
    sh 'echo Hello > output.txt'
    archiveArtifacts 'output.txt'
  }
}

What will Jenkins do after this stage completes?

medium

A. Send output.txt as an email attachment

B. Delete the file output.txt immediately

C. Fail the build because output.txt is not found

D. Save the file output.txt as a build artifact

Solution

1. Step 1: Understand the shell command

   The command creates a file named output.txt with the text 'Hello'.

2. Step 2: Analyze archiveArtifacts usage

   This command archives the specified file so it is saved with the build for later access.

3. Final Answer:

   Save the file output.txt as a build artifact -> Option D

4. Quick Check:

   archiveArtifacts saves files [OK]

Hint: archiveArtifacts saves files created in the build [OK]

Common Mistakes:

• Assuming the file is deleted after archiving
• Thinking the build fails if file exists
• Confusing archiving with emailing files

4. You wrote this Jenkins pipeline snippet:

archiveArtifacts '*.log'

But no files are archived after the build. What is the most likely reason?

medium

A. No .log files were created in the workspace

B. The syntax of archiveArtifacts is incorrect

C. Jenkins does not support archiving .log files

D. The build failed before reaching the archive step

Solution

1. Step 1: Check the file pattern and workspace

   If no .log files exist in the workspace, nothing will be archived.

2. Step 2: Verify syntax and Jenkins support

   The syntax is correct and Jenkins supports archiving any file type.

3. Step 3: Consider build status

   If the build failed before this step, archiving wouldn't run, but the question implies the step ran.

4. Final Answer:

   No .log files were created in the workspace -> Option A

5. Quick Check:

   Files must exist to be archived [OK]

Hint: Check if files exist before archiving [OK]

Common Mistakes:

• Assuming Jenkins can't archive certain file types
• Blaming syntax without checking files
• Ignoring build step execution order

5. You want to archive all .jar files in the build/libs folder and also keep the build logs named build.log. Which archiveArtifacts usage is correct?

hard

A. archiveArtifacts 'build/libs/*.jar', build.log

B. archiveArtifacts 'build/libs/*.jar build.log'

C. archiveArtifacts artifacts: 'build/libs/*.jar, build.log'

D. archiveArtifacts artifacts: 'build/libs/*.jar', 'build.log'

Solution

1. Step 1: Understand multiple file patterns in archiveArtifacts

   To archive multiple patterns, use the named parameter artifacts with a comma-separated string.

2. Step 2: Analyze each option

   archiveArtifacts 'build/libs/*.jar', build.log passes two positional arguments (invalid), archiveArtifacts 'build/libs/*.jar build.log' lacks comma separator, archiveArtifacts artifacts: 'build/libs/*.jar', 'build.log' has invalid syntax with two strings.

3. Final Answer:

   archiveArtifacts artifacts: 'build/libs/*.jar, build.log' -> Option C

4. Quick Check:

   Use artifacts: 'pattern1, pattern2' for multiple files [OK]

Hint: Use artifacts: 'pattern1, pattern2' to archive multiple files [OK]

Common Mistakes:

• Omitting the artifacts: parameter
• Separating patterns without commas
• Passing multiple strings instead of one