Branch selection and branch specifier in Jenkins - Commands & Configuration

Introduction

When you want Jenkins to build code from a specific branch in your source control, you use branch selection and branch specifiers. This tells Jenkins exactly which branch to use for building and testing your project.

When you want to build the main branch to deploy the latest stable code.

When you want to test a feature branch before merging it into the main branch.

When you want to build a release branch for preparing a new version.

When you want Jenkins to automatically build pull requests from contributors.

When you want to run different jobs for different branches in the same repository.

Commands

This command updates the Jenkins job configuration with the specified YAML file that includes branch specifier settings.

Terminal

jenkins-jobs --conf jenkins.ini update my-job.yaml

Expected Output

Job my-job updated successfully

→

--conf - Specifies the Jenkins configuration file to use

Clones the repository locally to check available branches and verify branch names.

Terminal

git clone https://github.com/example/my-app.git

Expected Output

Cloning into 'my-app'...

remote: Enumerating objects: 10, done.

remote: Counting objects: 100% (10/10), done.

remote: Compressing objects: 100% (8/8), done.

remote: Total 10 (delta 1), reused 10 (delta 1), pack-reused 0

Receiving objects: 100% (10/10), done.

Lists all local and remote branches to find the exact branch name to specify in Jenkins.

Terminal

git branch -a

Expected Output

  main

  feature/login

  remotes/origin/HEAD -> origin/main

  remotes/origin/main

  remotes/origin/feature/login

Triggers a Jenkins job build specifying the branch 'feature/login' to build that branch's code.

Terminal

jenkins-cli build my-job -p BRANCH=feature/login

Expected Output

Started build #15 for job my-job with parameter BRANCH=feature/login

→

-p - Passes parameters to the Jenkins job

Key Concept

If you remember nothing else from this pattern, remember: the branch specifier tells Jenkins exactly which branch to build from your source code repository.

Common Mistakes

Using an incorrect or misspelled branch name in the branch specifier.

Jenkins will fail to find the branch and the build will not start or will error out.

Always verify branch names with 'git branch -a' or your source control UI before specifying them in Jenkins.

Not updating the Jenkins job configuration after changing branch specifiers.

Jenkins will continue building the old branch and ignore your changes.

Update the Jenkins job configuration and reload or restart the job to apply new branch specifiers.

Summary

Use branch specifiers in Jenkins to tell it which branch to build from your repository.

Verify branch names with git commands before specifying them in Jenkins.

Trigger builds with parameters to select branches dynamically.

Practice

1. What does the Branch Specifier field in Jenkins do?

easy

A. It tells Jenkins which branch or branches to build.

B. It specifies the build timeout duration.

C. It defines the build environment variables.

D. It sets the Jenkins user permissions.

Solution

1. Step 1: Understand the purpose of Branch Specifier

   The Branch Specifier is used to tell Jenkins which branch or branches to build from the source code repository.

2. Step 2: Eliminate unrelated options

   Timeout, environment variables, and user permissions are unrelated to branch selection.

3. Final Answer:

   It tells Jenkins which branch or branches to build. -> Option A

4. Quick Check:

   Branch Specifier = Select branch to build [OK]

Hint: Branch Specifier selects branches to build in Jenkins [OK]

Common Mistakes:

• Confusing branch specifier with build timeout
• Thinking it sets environment variables
• Assuming it controls user permissions

2. Which of the following is the correct syntax to specify the master branch in Jenkins Branch Specifier?

easy

A. refs/remotes/master

B. refs/tags/master

C. refs/heads/master

D. refs/branches/master

Solution

1. Step 1: Recall Git reference format for branches

   Branches in Git are referenced as refs/heads/branch-name. So the master branch is refs/heads/master.

2. Step 2: Identify incorrect references

   refs/tags/ is for tags, refs/remotes/ is for remote tracking branches, and refs/branches/ is not a valid Git ref.

3. Final Answer:

   refs/heads/master -> Option C

4. Quick Check:

   Branch refs start with refs/heads/ [OK]

Hint: Use refs/heads/branch-name for branch specifier [OK]

Common Mistakes:

• Using refs/tags/ instead of refs/heads/
• Confusing remote refs with local branch refs
• Using invalid refs/branches/ prefix

3. Given the branch specifier refs/heads/feature/*, which branches will Jenkins build?

medium

A. Only the branch named exactly 'feature/*'.

B. Only the 'master' branch.

C. All branches except those starting with 'feature/'.

D. All branches starting with 'feature/', like 'feature/login' and 'feature/ui'.

Solution

1. Step 1: Understand wildcard usage in branch specifier

   The asterisk (*) acts as a wildcard matching any characters after 'feature/'. So it matches all branches starting with 'feature/'.

2. Step 2: Analyze each option

   Only the branch named exactly 'feature/*'. is incorrect because it treats '*' literally. All branches except those starting with 'feature/'. is opposite meaning. Only the 'master' branch. is unrelated.

3. Final Answer:

   All branches starting with 'feature/', like 'feature/login' and 'feature/ui'. -> Option D

4. Quick Check:

   Wildcard * matches multiple branches [OK]

Hint: Use * wildcard to match multiple branches [OK]

Common Mistakes:

• Treating * as a literal character
• Assuming it excludes matching branches
• Confusing branch names with tags

4. You set the branch specifier to refs/heads/release but Jenkins builds no branches. What is the likely problem?

medium

A. The branch name is incorrect or does not exist in the repo.

B. The Jenkins server is offline.

C. The build script has syntax errors.

D. The workspace is full.

Solution

1. Step 1: Check branch existence

   If Jenkins builds no branches, the specified branch refs/heads/release might not exist in the repository.

2. Step 2: Rule out unrelated issues

   Server offline, build script errors, or workspace full would cause different errors or failures, not silent no build.

3. Final Answer:

   The branch name is incorrect or does not exist in the repo. -> Option A

4. Quick Check:

   Branch specifier must match existing branch [OK]

Hint: Verify branch exists before setting specifier [OK]

Common Mistakes:

• Assuming Jenkins server status causes no build
• Blaming build script syntax for branch selection
• Ignoring branch existence check

5. You want Jenkins to build all branches except those starting with hotfix/. Which branch specifier pattern should you use?

hard

A. !refs/heads/*

B. refs/heads/*, !refs/heads/hotfix/*

C. refs/heads/*

D. refs/heads/hotfix/*

Solution

1. Step 1: Understand inclusion and exclusion patterns

   Jenkins supports including all branches with refs/heads/* and excluding specific branches with !refs/heads/hotfix/*.

2. Step 2: Analyze options

   refs/heads/*, !refs/heads/hotfix/* includes all branches but excludes hotfix branches. refs/heads/hotfix/* only includes hotfix branches. refs/heads/* includes all branches without exclusion. !refs/heads/* excludes all branches.

3. Final Answer:

   refs/heads/*, !refs/heads/hotfix/* -> Option B

4. Quick Check:

   Use ! to exclude branches in specifier [OK]

Hint: Use ! prefix to exclude branches in specifier [OK]

Common Mistakes:

• Not using exclusion pattern with !
• Only specifying excluded branches
• Excluding all branches accidentally