Skip to content

Instantly share code, notes, and snippets.

@blaisep
Created October 20, 2016 23:33
Show Gist options
  • Star 35 You must be signed in to star a gist
  • Fork 8 You must be signed in to fork a gist
  • Save blaisep/eb8aa720b06eff4f095e4b64326961b5 to your computer and use it in GitHub Desktop.
Save blaisep/eb8aa720b06eff4f095e4b64326961b5 to your computer and use it in GitHub Desktop.
Insert git credentials into Jenkins Pipeline Script projects

Suppose you want to inject a credential into a Pipeline script. The cloudbees note does not include Pipeline script examples. https://support.cloudbees.com/hc/en-us/articles/203802500-Injecting-Secrets-into-Jenkins-Build-Jobs

The Jenkins Pipeline Docs' description of the git pushmethod doesn't have an example using injected credentials. (https://jenkins.io/doc/pipeline/examples/#push-git-repo)

The Snippet generator is helpful, but not not if you try to follow the instructions at: https://wiki.jenkins-ci.org/display/JENKINS/Credentials+Binding+Plugin

If you have associated a credential with your Git repo, use the Snippet Generator to select the plain Git option and it will return a snippet with this gem.

stage('Checkout') {
       git branch: 'lts-1.532', credentialsId: '82aa2d26-ef4b-4a6a-a05f-2e1090b9ce17', url: 'git@github.com:jenkinsci/maven-plugin.git'
   }

Note that the credentialsID is a cryptic string and not at all like the display name I originally expected.

@mramanathan
Copy link

Cool tip!!! 👍

@denisdbell
Copy link

denisdbell commented Jun 14, 2017

Very good tip. Saved me a great deal of time

@vishveshv
Copy link

Thanks for the tip 👍

@ajeetrai7
Copy link

it did not worked in my case.

@ajeetrai7
Copy link

my issue is how to configure and user git clone,git commit,git add ,in jenkinsfile and also by passing git credentials in jenkinsfile.

@dldude
Copy link

dldude commented May 14, 2019

Awesome tip 👍

@kanwal-tq
Copy link

You have NO idea how much this helped me! Spent 2 days figuring out keys and credentials! Thanks a lot!!

@falcon68
Copy link

Thank you so much. With this tip I needed just 10 min. to set up. Thanks

@aadityao1
Copy link

is credentialid some kind of private or security credentials
which should not be publically available for everyone

@blaisep
Copy link
Author

blaisep commented Feb 2, 2020

is credentialid some kind of private or security credentials
which should not be publically available for everyone

I don't remember... I think that string is some kind of identifier that makes sense to the Jenkins server.

@sadokbani
Copy link

how i can find my credentialsId of my repository !

@zeejafri
Copy link

zeejafri commented Jul 5, 2021

This will only clone the repository in your pipeline. It does not works for scenarios where you need to auto commit.

@codebind26
Copy link

Thanks this helped me to set it up in few mins!

@Anuradha1992Dasari
Copy link

thank you ( 🥇

@pmoros
Copy link

pmoros commented Mar 29, 2023

Thank you! This was pretty useful :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment