Jenkins Pipeline Wipe Out Workspace

Question

We are running Jenkins 2 x and love the new Pipeline plugin   However  with so many branches in a repository  disk space fills up quickly     Is there any plugin that s compatible with Pipeline that I can wipe out the workspace on a successful build

User · Answer

In fact the deleteDir function recursively deletes the current directory and its contents. Symbolic links and junctions will not be followed but will be removed.

To delete a specific directory of a workspace wrap the deleteDir step in a dir step.

dir('directoryToDelete') {
    deleteDir()
}

User · Answer

We make sure we are working with a clean workspace by using a feature of the git plugin  You can add additional behaviors like  Clean before checkout   We use this as well for  Prune stale remote-tracking branches

User · Answer

Using the  WipeWorkspace  extension seems to work as well   It requires the longer form   checkout       class   GitSCM      branches  scm branches     extensions  scm extensions      class   WipeWorkspace        userRemoteConfigs  scm userRemoteConfigs      More details here  https   support cloudbees com hc en-us articles 226122247-How-to-Customize-Checkout-for-Pipeline-Multibranch-  Available GitSCM extensions here  https   github com jenkinsci git-plugin tree master src main java hudson plugins git extensions impl

User · Answer

The mentioned solutions deleteDir   and cleanWs    if using the workspace cleanup plugin  both work  but the recommendation to use it in an extra build step is usually not the desired solution   If the build fails and the pipeline is aborted  this cleanup-stage is never reached and therefore the workspace is not cleaned on failed builds      In most cases you should probably put it in a post-built-step condition like always   pipeline       agent any     stages           stage  Example                 steps                   echo  Hello World                                    post            always                cleanWs

User · Answer

For Jenkins 2 190 1 this works for sure       post           always               cleanWs deleteDirs  true  notFailBuild  true

User · Answer

Currently both deletedir   and cleanWs   do not work properly when using Jenkins kubernetes plugin  the pod workspace is deleted but the master workspace persists   it should not be a problem for persistant branches  when you have a step to clean the workspace prior to checkout scam  It will basically reuse the same workspace over and over again  but when using multibranch pipelines the master keeps the whole workspace and git directory   I believe this should be an issue with Jenkins   any enlightenment here

User · Answer

I used deleteDir   as follows     post           always               deleteDir      clean up our workspace                      However  I then had to also run a Success or Failure AFTER always but you cannot order the post conditions   The  current order is always  changed  aborted  failure  success and then unstable   However  there is a very useful post condition  cleanup which always runs last  see https   jenkins io doc book pipeline syntax   So in the end my post was as follows    post       always              success             failure              cleanup          deleteDir             Hopefully this may be helpful for some corner cases

User · Answer

Cleaning up   Since the post section of a Pipeline is guaranteed to run at the end of a Pipeline   s execution  we can add some notification or other steps to perform finalization  notification  or other end-of-Pipeline tasks   pipeline       agent any     stages           stage  No-op                 steps                   sh  ls                                    post           cleanup               echo  One way or another  I have finished              deleteDir      clean up our workspace

User · Answer

Using the following pipeline script   pipeline       agent   label  master        options   skipDefaultCheckout         stages           stage  CleanWorkspace                 steps                   cleanWs                                     Follow these steps    Navigate to the latest build of the pipeline job you would like to clean the workspace of  Click the Replay link in the LHS menu  Paste the above script in the text box and click Run

User · Answer

In my case  I want to clear out old files at the beginning of the build  but this is problematic since the source code has been checked out   My solution is to ask git to clean out any files  from the last build  that it doesn t know about       sh  git clean -x -f    That way I can start the build out clean  and if it fails  the workspace isn t cleaned out and therefore easily debuggable

User · Answer

If you have used custom workspace in Jenkins then deleteDir   will not delete  tmp folder    So to delete  tmp along with workspace use following  pipeline       agent           node               customWorkspace   home jenkins jenkins workspace   JOB NAME    BUILD NUMBER                       post           cleanup                  clean up our workspace                deleteDir                  clean up tmp directory                dir    workspace  tmp                     deleteDir                                clean up script directory                dir    workspace  script                     deleteDir                                     This snippet will work for default workspace also

User · Answer

Like  gotgenes pointed out with Jenkins Version  2 74  the below works  not sure since when  maybe if some one can edit and add the version above  cleanWs       With  Jenkins Version 2 16 and the Workspace Cleanup Plugin  that I have  I use   step   class   WsCleanup      to delete the workspace   You can view it by going to  JENKINS URL job  lt any Pipeline project gt  pipeline-syntax   Then selecting  step  General Build Step  from Sample step and then selecting  Delete workspace when build is done  from Build step

User · Answer

You can use deleteDir   as the last step of the pipeline Jenkinsfile  assuming you didn t change the working directory

[jenkins] Jenkins Pipeline Wipe Out Workspace

Examples related to jenkins

Examples related to jenkins-pipeline

Examples related to workspace