In Jenkins how to checkout a project into a specific directory using GIT

Question

Sorry for the  svn  style - we are in a process of migration from SVN to GIT  including our CI Jenkins environment    What we need is to be able to make Jenkins to checkout  or should I say clone   the GIT project  repository   into a specific directory  We ve tried some refspecs magic but it wasn t too obvious to understand and use successfully   Furthermore  if in the same Jenkins project we need to checkout several private GitHub repositories into several separate dirs under a project root  how can we do it please   We have GitHub plugin installed  Hope we ve phrased the things right

User · Accepted Answer

The default git plugin for Jenkins does the job quite nicely.

After adding a new git repository (project configuration > Source Code Management > check the GIT option) to the project navigate to the bottom of the plugin settings, just above Repository browser region. There should be an Advanced button. After clicking it a new form should appear, with a value described as Local subdirectory for repo (optional). Setting this to folder will make the plugin to check out the repository into the folder relative to your workspace. This way you can have as many repositories in your project as you need, all in separate locations.

Alternatively, if the project you're using will allow that, you can use GIT sub modules, which are similar to external paths in SVN. In the GIT Book there is a section on that very topic. If that will not be against some policy, submodules are fairly simple to use, giving you powerful way to control the locations, versions/tags/branches that will be imported AND it will be available on your local repository as well giving you better portability.

Obviously the GIT plugin supports checking out submodules, so Jenkins can work with them quite effectively.

User · Answer

I do not use github plugin  but from the introduction page  it is more or less like gerrit-trigger plugin   You can install git plugin  which can help you checkout your projects  if you want to include multi-projects in one jenkins job  just add Repository into your job

User · Answer

Furthermore  if in the same Jenkins project we need to checkout several private GitHub repositories into several separate dirs under a project root  How can we do it please    The Jenkin s Multiple SCMs Plugin has solved the several repositories problem for me very nicely  I have just got working a project build that checks out four different git repos under a common folder   I m a bit reluctant to use git super-projects as suggested previously by Lukasz Rzanek  as git is complex enough without submodules

User · Answer

In the new Jenkins 2 0 pipeline  previously named the Workflow Plugin   this is done differently for    The main repository Other additional repositories   Here I am specifically referring to the Multibranch Pipeline version 2 9   Main repository  This is the repository that contains your Jenkinsfile   In the Configure screen for your pipeline project  enter your repository name  etc   Do not use Additional Behaviors   Check out to a sub-directory   This will put your Jenkinsfile in the sub-directory where Jenkins cannot find it   In Jenkinsfile  check out the main repository in the subdirectory using dir     dir  subDir         checkout scm     Additional repositories  If you want to check out more repositories  use the Pipeline Syntax generator to automatically generate a Groovy code snippet   In the Configure screen for your pipeline project    Select Pipeline Syntax  In the Sample Step drop down menu  choose checkout  General SCM  Select your SCM system  such as Git   Fill in the usual information about your repository or depot  Note that in the Multibranch Pipeline  environment variable env BRANCH NAME contains the branch name of the main repository  In the Additional Behaviors drop down menu  select Check out to a sub-directory Click Generate Groovy  Jenkins will display the Groovy code snippet corresponding to the SCM checkout that you specified  Copy this code into your pipeline script or Jenkinsfile

User · Answer

It s worth investigating the Pipeline plugin  With the plugin you can checkout multiple VCS projects into relative directory paths  Beforehand creating a directory per VCS checkout  Then issue commands to the newly checked out VCS workspace  In my case I am using git  But you should get the idea   node      def exists   fileExists  foo      if   exists           new File  foo   mkdir             dir   foo             git branch    lt ref spec gt    changelog  false  poll  false  url    lt clone url gt                            def exists   fileExists  bar      if   exists           new File  bar   mkdir             dir   bar             git branch    lt ref spec gt    changelog  false  poll  false  url    lt clone url gt                            def exists   fileExists  baz      if   exists           new File  baz   mkdir             dir   baz             git branch    lt ref spec gt    changelog  false  poll  false  url    lt clone url gt

User · Answer

In the new Pipeline flow  following image may help

User · Answer

Find repoName from the url  and then checkout to the specified directory  String url    https   github com foo bar git   String   res   url split       String repoName   res res length-1   if  repoName endsWith   git    repoName repoName substring 0  repoName length  -4    checkout      class   GitSCM      branches    name   refs heads   env BRANCH NAME      doGenerateSubmoduleConfigurations  false    extensions          class   RelativeTargetDirectory   relativeTargetDir  repoName         class   GitLFSPull          class   CheckoutOption   timeout  20         class   CloneOption           depth  3          noTags  false          reference    other optional local reference clone           shallow  true          timeout  120         class   SubmoduleOption   depth  5  disableSubmodules  false  parentCredentials  true  recursiveSubmodules  true  reference      shallow  true  trackingSubmodules  true         submoduleCfg        userRemoteConfigs         credentialsId   foobar       url  url

User · Answer

I agree with  Lukasz Rzanek that we can use git plugin   But  I use option  checkout to a sub-direction what is enable as follow   In Source Code Management  tick Git  click add button  choose checkout to a sub-directory

[git] In Jenkins, how to checkout a project into a specific directory (using GIT)

Examples related to git

Examples related to github

Examples related to hudson

Examples related to jenkins

Examples related to jenkins-plugins