How to specify Job DSL checkout timeout in Jenkins Git plugin?

Question

Clone timeout can be specified using:

git {
    ...
    cloneTimeout(60)
}

where 60 is timeout is minutes. I read that checkout timeout can also be specified but I cannot find details. Both checkoutTimeout(...) and timeout(...) give an error.

EDIT

I can set the checkout timeout via Jenkins GUI (Configuration --> SCM --> Git --> Additional Behaviors --> Advanced Checkout Behaviors --> Timeout). I'd like to do the same in a Groovy script that generates Docker configurations for Jenkins:

...
public class DockerJob {
...
    multiscm {
        git {
            remote {
                url(...)
                branch(...)
                ...
            }
            shallowClone()
            cloneTimeout(60)
            // Add "checkout timeout" here...
        }
        ...
    }
    ...
}
...

Are you asking how to do this in the Job Configuration through the Jenkins UI? — rgulia, Mar 10 '16 at 04:18

score 17 · Answer 1 · answered Aug 30 '17 at 14:36

I had to change it like this with the pipeline as the CheckoutOption was not working for me

extensions: [[$class: 'CloneOption', timeout: 120]]

Full checkout code

checkout([$class: 'GitSCM', branches: [[name: '*/master']],
            extensions: [[$class: 'CloneOption', timeout: 120]], gitTool: 'Default', 
            userRemoteConfigs: [[credentialsId: key, url: repo]]
        ])

score 8 · Accepted Answer · answered Apr 03 '16 at 10:23

After some experimentation, I found the solution shown below.

RECAP

Checkout timeout can be set via Jenkins GUI (Configuration --> SCM --> Git --> Additional Behaviors --> Advanced Checkout Behaviors --> Timeout). I'd like to do the same in a Groovy script that generates Docker configurations for Jenkins. The script already sets clone timeout.

...
public class DockerJob {
...
    multiscm {
        git {
            remote {
                url(...)
                branch(...)
                ...
            }
            shallowClone()
            cloneTimeout(60)
            // Add "checkout timeout" here...
        }
        ...
    }
    ...
}
...

The obvious

...
// "Checkout timeout"
checkoutTimeout(60)
...

did not work. Setting timeouts in general

...
// "Checkout timeout"
timeout(60)
...

also did not work. Then comment on a web page lead to:

...
// "Checkout timeout"
extensions {
    checkoutOptions {
        timeout(60)
    }
}
...

that also did not work. Finally...

SOLUTION

...
public class DockerJob {
...
    multiscm {
        git {
            remote {
                url(...)
                branch(...)
                ...
            }
            shallowClone()
            cloneTimeout(60)
            // "Checkout timeout"
            configure { node ->
                node / 'extensions' << 'hudson.plugins.git.extensions.impl.CheckoutOption' {
                    timeout 60
                }
            }
        }
        ...
    }
    ...
}
...

score 2 · Answer 3 · answered Mar 10 '16 at 09:31

2

How about using the workflow plugin and do something like this?

checkout([$class: 'GitSCM', branches: [[name: '*/master']], doGenerateSubmoduleConfigurations: false, extensions: [[$class: 'CheckoutOption', timeout: 100]], submoduleCfg: [], userRemoteConfigs: [[]]])

answered Mar 10 '16 at 09:31

OhadBasan

797
6
15

For simplicity, I'd like a solution (for checkout timeout) similar to what is already present for clone timeout. – Petr Vepřek Apr 03 '16 at 09:55

score 0 · Answer 4 · answered Dec 11 '19 at 09:33

Following checkout config works perfect for me in a jenkins pipeline script. We are using stash1 just like github as internal git server. Replace it with your own.

stage('Checkout') {
            steps {
                echo "Running checkout stage"
                checkout([$class: 'GitSCM', branches: [
                    [name: "*/${params.branch}"]
                ], doGenerateSubmoduleConfigurations: false, extensions: [
                    [$class: 'CleanCheckout'], [$class: 'CloneOption', timeout: 30, shallow: true]
                ], submoduleCfg: [], userRemoteConfigs: [
                    [credentialsId: 'ink_bot', url: "ssh://git@stash1.XYZ.com:7999/int_sparktp/${params.repo}.git"]
                ]])
            }
        }

score 0 · Answer 5 · answered Apr 01 '22 at 08:29

0

Adding this extension works for me.

extensions: [[$class: 'CloneOption', timeout: 60]]

answered Apr 01 '22 at 08:29

Neal

82
3

How to specify Job DSL checkout timeout in Jenkins Git plugin?

5 Answers5