Checkout Jenkins Pipeline Git SCM with credentials

Question

I was following this tutorial   node     git url   https   github com joe user simple-maven-project-with-tests git            However it doesn t tell how to add credentials  Jenkins does have specific  Credentials  section where you define user user amp pass  and then get ID for that to use in jobs  but how do I use that in Pipeline instructions   I tried with   git  url   git bitbucket org company repo git   branch   master   credentialsId   12345-1234-4696-af25-123455      no luck   stderr  Host key verification failed  fatal  Could not read from remote repository   Please make sure you have the correct access rights and the repository exists    Is there a way configure the creds in pipeline  or do I have to put SSH-keys to Jenkin s Linux user s  ssh authorized keys file   In ideal world I d like to have a repository for pipeline jobs and repo-keys  then launch Docker Jenkins  and dynamically add these jobs and keys there without having to configure anything in Jenkins Console

User · Answer

To explicitly checkout using a specific credentials

    stage('Checkout external proj') {
        steps {
            git branch: 'my_specific_branch',
                credentialsId: 'my_cred_id',
                url: 'ssh://[email protected]/proj/test_proj.git'

            sh "ls -lat"
        }
    }

To checkout based on the configred credentials in the current Jenkins Job

    stage('Checkout code') {
        steps {
            checkout scm
        }
    }

You can use both of the stages within a single Jenkins file.

User · Answer

You can use the following in a pipeline   git branch   master       credentialsId   12345-1234-4696-af25-123455       url   ssh   git bitbucket org company repo git    If you re using the ssh url then your credentials must be username   private key  If you re using the https clone url instead of the ssh one  then your credentials should be username   password

User · Answer

If you want to use ssh credentials     git         url   git github com lt repo name gt  git          credentialsId   xpc          branch     branch           if you want to use username and password credentials  you need to use http clone as  Serban mentioned       git         url   https   github com  lt repo name gt  git          credentialsId   xpc          branch     branch

User · Answer

It solved for me using   checkout scm                          class   GitSCM                       userRemoteConfigs    credentialsId           url    project url                         branches    name   refs tags   project tag

User · Answer

For what it s worth adding to the discussion    what I did that ended up helping me    Since the pipeline is run within a workspace within a docker image that is cleaned up each time it runs  I grabbed the credentials needed to perform necessary operations on the repo within my pipeline and stored them in a  netrc file  this allowed me to authorize the git repo operations successfully   withCredentials  usernamePassword credentialsId    lt credentials-id gt    passwordVariable   GIT PASSWORD   usernameVariable   GIT USERNAME           sh             printf  machine github com nlogin  GIT USERNAME n password  GIT PASSWORD   gt  gt     netrc            continue script as necessary working with git repo

User · Answer

Adding you a quick example using git plugin GitSCM       checkout            class   GitSCM            branches    name     master              doGenerateSubmoduleConfigurations  false           extensions     class   CleanCheckout              submoduleCfg               userRemoteConfigs    credentialsId    lt gitCredentials gt    url    lt gitRepoURL gt              in your pipeline  stage  checkout        steps          script              checkout

[git] Checkout Jenkins Pipeline Git SCM with credentials?

Examples related to git

Examples related to jenkins

Examples related to ssh

Examples related to jenkins-pipeline