Archiving artifacts in Jenkins - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of archiving artifacts in Jenkins?

Archiving artifacts in Jenkins saves important files from a build so you can access them later, like logs, reports, or compiled programs.

beginner

How do you specify which files to archive in a Jenkins job?

You use a file pattern (like **/*.jar) in the 'Archive the artifacts' post-build action to tell Jenkins which files to save.

intermediate

What happens if you archive artifacts with the pattern target/*.jar but no files match?

Jenkins will mark the build as failed or unstable depending on settings, because it expects files to archive but found none.

beginner

Can archived artifacts be downloaded after the build completes?

Yes, archived artifacts are stored with the build and can be downloaded anytime from the build's page in Jenkins.

beginner

Why is archiving artifacts useful in continuous integration?

It helps keep important build outputs safe, share them with others, and use them in later steps like deployment or testing.

In Jenkins, which post-build action is used to save build files for later use?

A Archive the artifacts

B Publish JUnit test result report

C Trigger parameterized build

D Clean workspace

The 'Archive the artifacts' action saves specified files from the build for later access.

What file pattern would you use to archive all .zip files in any folder of the workspace?

A **/*.zip

B *.zip

C zip/**

D */zip

The pattern '**/*.zip' matches all .zip files in any folder recursively.

If no files match the archive pattern, what is a possible Jenkins build result?

A Not built

B Success

C Aborted

D Failure or unstable

Jenkins may mark the build as failed or unstable if expected artifacts are missing.

Where can you find archived artifacts after a Jenkins build finishes?

A In the Jenkins system logs

B In the workspace folder only

C On the build's page in Jenkins UI

D In the Jenkins global configuration

Archived artifacts are accessible from the build's page in the Jenkins web interface.

Why should you archive artifacts in a CI/CD pipeline?

A To delete build files automatically

B To keep important build outputs for later use

C To speed up the build process

D To prevent builds from running

Archiving artifacts preserves important files like executables or reports for sharing or deployment.

Explain how to configure artifact archiving in a Jenkins freestyle job.

Think about the steps after the build completes.

Describe why archiving artifacts is important in continuous integration and deployment.

Consider what happens after a build finishes.

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